2018-03-11

Springboot获取内部属性值

为了实时检测线上服务的版本是否正确，需要通过一定的方式暴露当前运行服务的版本信息。
springboot可以很方便的通过spring-boot-actuator来暴露各种endpoint信息，很适合服务的监控。

但有时候为了兼容已有的监控或者部署工具，需要采取一些措施来支持相关信息的暴露。如Jar内部属性文件，如HTTP接口，然后监控部署服务通过检查属性文件或者调用相关服务接口来确认当前服务部署版本是否是目标版本。

内部属性文件方式
- 可以通过git-commit-id-plugin生成git.properties文件等方式。参见此文
- 或者通过maven-resources-plugin给动态给属性文件中的属性赋值。下面的配置实例可以在编译的时候，将git.commit.id.abbrev和git.build.time分别赋值给info节点的git-version属性和app-build-time属性。
- 这样就将项目的部分属性值写入到了文件中。

#application.properties
info.git-version=@git.commit.id.abbrev@
info.app-build-time=@git.build.time@ 

#pom.xml
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-resources-plugin</artifactId>
    <version>2.6</version>
    <configuration>
        <delimiters>
            <delimiter>@</delimiter>
        </delimiters>
        <useDefaultDelimiters>false</useDefaultDelimiters>
    </configuration>
</plugin>

最终打包好的application.properties文件属性会变成如下:
info.git-version=b0145c5
info.app-build-time=20180309205538

接口方式
- 通过接口等方式暴露出去，那么首先需要在服务运行时，能够拿到这些属性值。
  1. 通过Java Properties来load属性文件。
  2. 实现Spring的 EnvironmentAware接口，在setEnvironment方法中获取属性值。
  3. 通过Spring的@Value注解。

# 第一种
private static Properties PROJECT_PROPERTIES = new Properties();
PROJECT_PROPERTIES.load(BOOT.class.getClassLoader().getResourceAsStream("application.properties"));
# 然后就能拿到相关的属性值
String version = PROJECT_PROPERTIES.getProperty("info.git-version");
String buildTime = PROJECT_PROPERTIES.getProperty("info.app-build-time");

# 第二种
public class TestAbc implements EnvironmentAware {
    private String gitVersion;
    private String buildTime;
    private long startTime = 0;

    @Override
    public void setEnvironment(Environment environment) {
        gitVersion = environment.getProperty("info.git-version");
        buildTime = environment.getProperty("info.app-build-time");
        startTime = ManagementFactory.getRuntimeMXBean().getStartTime();
    }

# 第三种
@Value("${info.git-version}")
private String gitVersion;
@Value("${info.app-build-time}")    
private String buildTime;
# 注意: 这里的info.git-version就是指前述属性文件application.properties中的属性字段
# info.app-build-time以此类推。

内部属性文件方式

接口方式