Получение ArtifactId и версии в Spring Boot Starter

в настоящее время я разрабатываю Spring Boot Starter, в котором будет размещен веб-сервис Restful с некоторыми метаданными о запущенном приложении.

у меня возникли трудности с извлечением моего artifactId и versionId из моего файла mainfest. Я считаю, что моя проблема заключается в том, что классы автоконфигурации загружаются перед основным тестовым приложением, поэтому манифест еще не доступен для обнаружения. Я не уверен, что моя логика здесь верна, если я приближаюсь к проблеме из неправильный угол.

первоначально я следовал следующему учебник для установки.

это дало мне 3 отдельных проектов

Generic Spring Services with no context AutoConfiguration project for these services Spring Boot starter

я связал стартер с тестовым проектом в качестве конечного результата.

В настоящее время maven используется с Spring Boot для создания файла манифеста.

Implementation-Title: MyExampleProjectWithCustomStarter Implementation-Version: 0.0.1-SNAPSHOT Archiver-Version: Plexus Archiver Built-By: mcf Implementation-Vendor-Id: com.coolCompany Spring-Boot-Version: 1.5.4.RELEASE Implementation-Vendor: Pivotal Software, Inc. Main-Class: org.springframework.boot.loader.JarLauncher Start-Class: com.coolcompany.SpringBootExampleApplication Spring-Boot-Classes: BOOT-INF/classes/ Spring-Boot-Lib: BOOT-INF/lib/ Created-By: Apache Maven 3.5.0 Build-Jdk: 1.8.0_131 Implementation-URL: http://someurl

однако, когда я пытаюсь найти файл манифеста для примера проекта из моей общей службы пакет я не могу найти файл.

  private String getApplicationVersion(String applicationName, List<Attributes> manifests) {
    String unknownVersion = "0.0.0-UNKNOWN";

    for (Attributes attr : manifests) {
      String title = attr.getValue(IMPL_TITLE);
      String version = attr.getValue(IMPL_VERSION);
      if (version != null) {
        if (applicationName.equalsIgnoreCase(title)) {
          return title + ' ' + version;
        }
      }
    }
    log.warn(
        "Could not find MANIFEST file with '" + applicationName + "' as Implementation-Title."
        + " Meta-API will return buildVersion '" + unknownVersion + "'.");

    return applicationName + ' ' + unknownVersion;
  }

  private List<Attributes> loadManifestFiles() {
    List<Attributes> manifests = new ArrayList<>();
    try {
      Enumeration<URL> resources =
          Thread.currentThread().getContextClassLoader().getResources("/META-INF/MANIFEST.MF");
      while (resources.hasMoreElements()) {
        URL url = resources.nextElement();
        try (InputStream is = url.openStream()) {
          manifests.add(new Manifest(is).getMainAttributes());
          System.out.println("Manifest size:" + manifests.size());
        } catch (IOException e) {
          log.error("Failed to read manifest from " + url, e);
        }
      }
    } catch (IOException e) {
      log.error("Failed to get manifest resources", e);
    }
    return manifests;
  }

текущая реализация манифеста-Titles:

Spring Boot Web Starter Spring Boot Starter Spring Boot Spring Boot AutoConfigure Spring Boot Logging Starter null null jcl-over-slf4j null log4j-over-slf4j null Spring Boot Tomcat Starter Apache Tomcat Apache Tomcat Apache Tomcat hibernate-validator null JBoss Logging 3 ClassMate jackson-databind Jackson-annotations Jackson-core spring-web spring-aop spring-beans spring-context spring-webmvc spring-expression Spring Boot Actuator Starter Spring Boot Actuator null ** MyCustom-spring-boot-starter ** MyGenericSpringService null null null Metrics Core JVM Integration for Metrics null null Jackson datatype: JSR310 ** MyService-spring-boot-autoconfigure slf4j-api spring-core ** Отсутствует MyExampleProjectWithCustomStarter

граф манифест записей: 44

6
java manifest maven spring spring-boot

2 ответов

Эй, ребята, после многих усилий, вложенных в это, я нашел удивительно простой ответ. (Вот как spring-boot-actuator получает информацию)

плагин Spring Boot Maven оснащен целью build-info. Пока эта цель инициируется в основном проекте Весна класс BuildProperties вы можете проволоки за информацию.

            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>build-info</id>
                        <goals>
                            <goal>build-info</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

Вы можете получить доступ к свойствам стартер как:

@Autowired
BuildProperties buildProperties;

...
buildProperties.getArtifact();
buildProperties.getVersion();

вы даже можете указать дополнительные свойства из плагина. Дополнительные сведения см. В документации плагина: https://docs.spring.io/spring-boot/docs/current/maven-plugin/build-info-mojo.html

к сожалению, я никогда не мог полностью понять, почему я не мог получить доступ к правильному манифесту, но это должно помочь любому, кто пытается решить эту проблему.

9

другой ответ совершенно правильный. Просто для других, находящих этот вопрос, если вы используете Gradle вместо Maven:

создание информации о сборке так же просто, как добавить это в свой :

plugins {
    id 'org.springframework.boot' version '<your-boot-version>.RELEASE'
}

// ...    

springBoot {
    buildInfo()
}

а если вы хотите передать дополнительные свойства:

springBoot {
    buildInfo {
        properties {
            additional = [
                'property.name': 'property value',
                'other.property': 'different.value'
            ]
        }
    }
}

тогда использование в коде Java то же самое, используя BuildProperties. Вы можете найти более подробную информацию о плагине в данное руководство.

2