如何使用 Gradle 和 Spring Boot 捕获构建信息

Question

我正在尝试使用 Spring Boot 和 Gradle 在我的 Java 主应用程序中访问构建信息值，例如 version。

我找不到任何关于如何配置的文档/示例

• build.gradle
• application.yml（如果需要）
• Java main class

有人可以帮助提供上述文件的小代码示例。

在我的 build.gradle 文件中，我将有 version 条目，那么如何使用 Spring Boot 和 Gradle 将其放入 Java 主类中。

build.gradle

version=0.0.1-SNAPSHOT

我已经尝试添加

build.gradle

apply plugin: 'org.springframework.boot'

springBoot {    
    buildInfo() 
}

但 buildInfo() 在 Intellij 中未被识别为关键字

在我的 Java 主类中，我有以下内容：

public class MyExampleApplication implements CommandLineRunner {
    @Autowired
    private ApplicationContext context;

    public static void main(String[] args) {
        SpringApplication.run(MyExampleApplication.class, args);
    }

    @Override
    public void run(String[] args) throws Exception{
        Environment env = (Environment) context.getBean("environment");
        displayInfo(env);
    }

    private static void displayInfo(Environment env) {
       log.info("build version is <" + env.getProperty("version")     
    }

但是当我运行它时 - env.getProperty("version") 的输出显示为 null。

Answer 1

在 Spring Boot 中获取版本号的简单方法

@Controller
@RequestMapping("/api")
public class WebController {

private final BuildProperties buildProperties;

public WebController(BuildProperties properties) {
    buildProperties = properties;
}

@GetMapping("/test")
public String index() {

    System.out.println(buildProperties.getVersion());
    System.out.println(buildProperties.getArtifact());
    System.out.println(buildProperties.getGroup());
    System.out.println(buildProperties.getName());
    System.out.println(buildProperties.getTime());

    return "index";
}
}

别忘了生成 application-build.properties

springBoot {
    buildInfo()
}

Answer 2

我现在设法让它工作 - 使用 Vampire 在下面给出的帮助指针和其他一些来源。关键是将执行器类添加到项目依赖项中。 注意：Intellj 似乎无法识别 springBoot 标记中的 buildInfo() - 但它运行正常 - 所以不要推迟。

build.gradle

buildscript {
   ext {
      springBootVersion = '1.5.6.RELEASE'
      gradleVersion = '3.3'
   }

   repositories {
      mavenLocal()
      maven { url "http://cft-nexus.ldn.xxxxxxxxx.com:8081/nexus/content/groups/public/" }
                }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
                }
            }

        apply plugin: 'application'
        apply plugin: 'java'
        apply plugin: 'eclipse'
        apply plugin: 'idea'
        apply plugin: 'org.springframework.boot'

    version = '0.0.1-SNAPSHOT'
    sourceCompatibility = 1.8

    springBoot{
        buildInfo {
            additionalProperties = [
                    'foo': 'bar'
            ]
        }
    }

  compile "org.springframework.boot:spring-boot-starter-actuator"

MyExampleApplication

@Slf4j
@EnableIntegration
@EnableLoaderApplication
@SpringBootApplication
@EnableDiscoveryClient
public class MyExampleApplication implements CommandLineRunner {

    private static final String SYSTEM_NAME_INFO = "My Example Application";
    private static final String VERSION="0.0.1";

    @Autowired
    private ApplicationContext context;

    public static void main(String[] args) {
        SpringApplication.run(MyExampleApplication.class, args);
    }

    @Override
    public void run(String[] args) throws Exception{
        BuildProperties buildProperties = context.getBean(BuildProperties.class);
        displayInfo(buildProperties);
    }

    private static void displayInfo(BuildProperties buildProperties) {
        log.info("build version is <" + buildProperties.getVersion() + ">");
    log.info("value for custom key 'foo' is <" + buildProperties.get("foo") + ">");
    }

}

在 Intellj 中运行应用程序时控制台输出的屏幕截图

粘贴输出以防图像不显示

> 2017-11-14 14:35:47.330  INFO 22448 --- [           main]
> o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase
> 2147483647 2017-11-14 14:35:47.448  INFO 22448 --- [           main]
> s.b.c.e.t.TomcatEmbeddedServletContainer : Tomcat started on port(s):
> 8780 (http) 2017-11-14 14:35:47.451  INFO 22448 --- [           main]
> c.u.o.metrics.MyExampleApplication         : build version is
> <0.0.1-SNAPSHOT> 2017-11-14 14:35:47.451  INFO 22448 --- [          
> main] c.u.o.myexample.MyExampleApplication         : value for custom key
> 'foo' is <bar>

更新

在与我的同事审查后，我们决定移动一些构建属性，例如version（上图）从build.gradle 文件中取出并进入gradle.properties 文件。这为我们提供了构建细节和属性的更清晰的分离。当您运行 Gradle build 时，它会自动拉入这些值，并且它们在 Java 主类的 BuildProperties bean 中可用，如上例所示。

gradle.properties

group=com.xxx.examplesource
version=0.0.1-SNAPSHOT 
gradleVersion=3.3

Answer 3

Spring Boot 使用buildInfo() 生成的信息自动配置BuildProperties bean。

所以要获取信息，请使用context.getBean(BuildProperties.class).getVersion();。

Answer 4

在您的 Gradle 脚本中添加以下内容。它将版本正确地插入到 jar 清单中，如下所示：

version = '1.0'
jar {
    manifest {
        attributes 'Implementation-Title': 'Gradle Quickstart',
                   'Implementation-Version': version
    }
}

您的代码将能够从该 jar 清单文件中获取版本：

public class BuildVersion {
    public static String getBuildVersion(){
        return BuildVersion.class.getPackage().getImplementationVersion();
    }
}

更多详情请参考以下链接：https://github.com/akhikhl/wuff/wiki/Manifest-attributes-in-build.gradle