构建微服务系列03: Spring Boot属性配置文件详解

title: 构建微服务：Spring Boot属性配置文件详解

在之前的各篇文章中都有提及关于application.properties的使用，主要用来配置数据库连接、日志相关配置等。除了这些配置内容之外，本文将具体介绍一些在application.properties配置中的其他特性和使用方法。

1. 自定义属性与加载

我们在使用Spring Boot的时候，通常也需要定义一些自己使用的属性，我们可以如下方式直接定义：

com.alanzh.portal.swagger2.title = WishPlatformd开发环境RESTful APIs
com.alanzh.portal.swagger2.description = WishPlatformd开发环境RESTful APIs
com.alanzh.portal.swagger2.termsOfServiceUrl = http://www.alanzh.com
com.alanzh.portal.swagger2.contact = alan.yang.zhang
com.alanzh.portal.swagger2.version = 1.0

2. 通过@Value("${属性名}")注解来加载对应的配置属性，具体如下：

@Component
public class Swagger2Properties {

    @Value("${com.alanzh.portal.swagger2.title}")
    private String title;
    
    @Value("${com.alanzh.portal.swagger2.description}")
    private String description;

    @Value("${com.alanzh.portal.swagger2.termsOfServiceUrl}")
    private String termsOfServiceUrl;

    @Value("${com.alanzh.portal.swagger2.contact}")
    private String contact;

    @Value("${com.alanzh.portal.swagger2.version}")
    private String version;

    // 省略getter和setter

}

我们将新配置的Swagger2Properties 用于Swagger2类中避免HardCode。

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.alanzh.portal.action"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(swagger2Properties.getTitle())
                .description(swagger2Properties.getDescription())
                .termsOfServiceUrl(swagger2Properties.getTermsOfServiceUrl())
                .contact(swagger2Properties.getContact())
                .version(swagger2Properties.getVersion())
                .build();
    }

    @Autowired
    private Swagger2Properties swagger2Properties;
}

3. 参数间的引用
在application.properties中的各个参数之间也可以通过${}直接引用来使用，就像下面的设置：

com.alanzh.portal.swagger2.title = WishPlatformd开发环境RESTful APIs
com.alanzh.portal.swagger2.description = ${com.alanzh.portal.swagger2.title}
com.alanzh.portal.swagger2.termsOfServiceUrl = http://www.alanzh.com
com.alanzh.portal.swagger2.contact = alan.yang.zhang
com.alanzh.portal.swagger2.version = 1.0

4. 使用随机数

在一些情况下，有些参数我们需要希望它不是一个固定的值，比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过${random}来产生int值、long值或者string字符串，来支持属性的随机值。

# 随机字符串
com.alanzh.portal.value=${random.value}
# 随机int
com.alanzh.portal.number=${random.int}
# 随机long
com.alanzh.portal.bignumber=${random.long}
# 10以内的随机数
com.alanzh.portal.test1=${random.int(10)}
# 10-20的随机数
com.alanzh.portal.test2=${random.int[10,20]}

5. 通过命令行设置属性值

相信使用过一段时间Spring Boot的用户，一定知道这条命令：java -jar xxx.jar --server.port=8888，通过使用–server.port属性来设置xxx.jar应用的端口为8888。

在命令行运行时，连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以，java -jar xxx.jar --server.port=8888命令，等价于我们在application.properties中添加属性server.port=8888，该设置在样例工程中可见，读者可通过删除该值或使用命令行来设置该值来验证。

通过命令行来修改属性值固然提供了不错的便利性，但是通过命令行就能更改应用运行的参数，那岂不是很不安全？是的，所以Spring Boot也贴心的提供了屏蔽命令行访问属性的设置，只需要这句设置就能屏蔽：SpringApplication.setAddCommandLineProperties(false)。

6. 多环境配置

我们在开发Spring Boot应用时，通常同一套程序会被应用和安装到几个不同的环境，比如：开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同，如果在为不同环境打包时都要频繁修改配置文件的话，那必将是个非常繁琐且容易发生错误的事。

对于多环境的配置，各种项目构建工具或是框架的基本思路是一致的，通过配置多份不同环境的配置文件，再通过打包命令指定需要打包的内容之后进行区分打包，Spring Boot也不例外，或者说更加简单。

在Spring Boot中多环境配置文件名需要满足application-{profile}.properties的格式，其中{profile}对应你的环境标识，比如：
我们在开发Spring Boot应用时，通常同一套程序会被应用和安装到几个不同的环境，比如：开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同，如果在为不同环境打包时都要频繁修改配置文件的话，那必将是个非常繁琐且容易发生错误的事。

在Spring Boot中多环境配置文件名需要满足==application-{profile}.properties==的格式，其中{profile}对应你的环境标识，比如：

application-dev.properties：开发环境
application-test.properties：测试环境
application-prod.properties：生产环境

至于哪个具体的配置文件会被加载，需要在application.properties文件中通过spring.profiles.active属性来设置，其值对应{profile}值。

如：spring.profiles.active=test就会加载application-test.properties配置文件内容

application-dev.properties

# Swagger2 Properties

com.alanzh.portal.swagger2.title = WishPlatformd开发环境RESTful APIs
com.alanzh.portal.swagger2.description = WishPlatformd开发环境RESTful APIs
com.alanzh.portal.swagger2.termsOfServiceUrl = http://www.alanzh.com
com.alanzh.portal.swagger2.contact = alan.yang.zhang
com.alanzh.portal.swagger2.version = 1.0

application-test.properties

# Swagger2 Properties

com.alanzh.portal.swagger2.title = WishPlatformd测试环境RESTful APIs
com.alanzh.portal.swagger2.description = WishPlatformd测试环境RESTful APIs
com.alanzh.portal.swagger2.termsOfServiceUrl = test.alanzh.com
com.alanzh.portal.swagger2.contact = alan.yang.zhang
com.alanzh.portal.swagger2.version = 1.0

application.properties

# Portal Info

info.app.name=@project.name@
info.app.description=@project.description@
info.app.version=@project.version@

# Spring config

spring.profiles.active=dev

多值.png

构建微服务系列03: Spring Boot属性配置文件详解

title: 构建微服务：Spring Boot属性配置文件详解

评论已关闭