Spring Boot配置文件

Posted on In ,

转载自:
https://blog.csdn.net/qq_21387171/article/details/53876721
https://blog.csdn.net/catoop/article/details/50548009
http://blog.didispace.com/springbootproperties/

自定义属性与加载

　　在application.properties可以自定义一些属性，然后通过@Value("${属性名}")注解来加载对应的配置属性。

参数间的引用

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

1
2
3
com.didispace.blog.name=程序猿DD
com.didispace.blog.title=Spring Boot教程
com.didispace.blog.desc=${com.didispace.blog.name}

使用随机数

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

1
2
3
4
5
6
7
8
9
10
# 随机字符串
com.didispace.blog.value=${random.value}
# 随机int
com.didispace.blog.number=${random.int}
# 随机long
com.didispace.blog.bignumber=${random.long}
# 10以内的随机数
com.didispace.blog.test1=${random.int(10)}
# 10-20的随机数
com.didispace.blog.test2=${random.int[10,20]}

通过命令行设置属性值

　　在命令行运行时，可以使用 java -jar xxx.jar --server.port=8888，等价于在application.properties中添加属性server.port=8888。
　　通过命令行来修改属性值固然提供了不错的便利性，但是通过命令行就能更改应用运行的参数，那岂不是很不安全？是的，所以Spring Boot也提供了屏蔽命令行访问属性的设置，只需要这句设置就能屏蔽：SpringApplication.setAddCommandLineProperties(false)。

多环境配置

　　在开发Spring Boot应用时，通常同一套程序会被应用和安装到几个不同的环境，比如：开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同，如果在为不同环境打包时都要频繁修改配置文件的话，那必将是个非常繁琐且容易发生错误的事。
　　对于多环境的配置，各种项目构建工具或是框架的基本思路是一致的，通过配置多份不同环境的配置文件，再通过打包命令指定需要打包的内容之后进行区分打包，Spring Boot也不例外，或者说更加简单。
　　在Spring Boot中多环境配置文件名需要满足 application-{profile}.properties 的格式，其中{profile}对应你的环境标识，比如：

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

　　至于哪个具体的配置文件会被加载，需要在application.properties文件中通过spring.profiles.active属性来设置，其值对应{profile}值。如spring.profiles.active=test就会加载application-test.properties配置文件内容
　　所以一般情况下，application.properties中配置通用内容，并设置spring.profiles.active=dev，以开发环境为默认配置，application-{profile}.properties中配置各个环境不同的内容，通过命令行方式去激活不同环境的配置。

　　 可以使用 --spring.config.location=xxx.properties来指定外部配置文件

　　凡是被Spring管理的类，实现接口 EnvironmentAware 重写方法 setEnvironment 可以在工程启动时，获取到系统环境变量和application配置文件中的变量。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
@Configuration
public class MyWebAppConfigurer implements EnvironmentAware {
    private RelaxedPropertyResolver propertyResolver;

    @Value("${spring.datasource.url}")
    private String myUrl;

    /**
     * 这个方法只是测试实现EnvironmentAware接口，读取环境变量的方法。
     */
    @Override
    public void setEnvironment(Environment env) {
        logger.info(env.getProperty("JAVA_HOME"));
        logger.info(myUrl);
        String str = env.getProperty("spring.datasource.url");
        logger.info(str);
        propertyResolver = new RelaxedPropertyResolver(env, "spring.datasource.");
        String url = propertyResolver.getProperty("url");
        logger.info(url);
    }
}

　　注意重写的方法 setEnvironment 是在系统启动的时候被执行。 Environment继承自PropertyResolver。
　　也可以用这样的方式：

1
2
3
4
@Inject
private Environment env;

env.getProperty("xxx.xxx");

除了spring.profiles.active属性配置外，还可以用如下方式：

1
2
// 在启动类上使用@PropertySource注解
@PropertySource("classpath:application-test.properties")

或则使用@Profile注解指定了具体环境：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
public interface SendMessage {  
    public void send();  
  
}  
 
// Dev 环境实现类  
@Component  
@Profile("dev")  
public class DevSendMessage implements SendMessage {  
    @Override  
    public void send() {  
        System.out.println(">>>>>>>>Dev Send()<<<<<<<<");  
    }  
}  
  
// Stg环境实现类  
@Component  
@Profile("stg")  
public class StgSendMessage implements SendMessage {  
  
    @Override  
    public void send() {  
        System.out.println(">>>>>>>>Stg Send()<<<<<<<<");  
    }  
  
}

我们有这样的一个springboot项目。项目分为开发、测试、生产三个不同阶段(环境)，每个阶段都会有db、ftp、redis等的不同配置信息。我们可以使用spring.profiles.include来实现三种不同环境的一键切换。

项目总(入口)配置文件：
bootstrap.yml ，内容如下

1
spring.profiles.active:  dev  #dev、test、prod 三种配置可以在这里进行一键切换，默认激活 dev(开发)环境配置

项目开发环境配置文件：
application-dev.yml (开发环境入口配置)、application-devDb.yml 、application-devFtp.yml、application-devRedis.yml

application-dev.yml 中含有如下内容

1
spring.profiles.include: devDb,devFtp,devRedis

项目测试环境配置文件：application-test.yml (测试环境入口配置)、application-testDb.yml 、application-testFtp.yml、application-testRedis.yml

application-test.yml 中含有如下内容

1
spring.profiles.include: testDb,testFtp,testRedis

项目生产环境配置文件：application-prod.yml (生产环境入口配置)、application-prodDb.yml 、application-prodFtp.yml、application-prodRedis.yml

application-prod.yml 中含有如下内容

1
spring.profiles.include: prodDb,prodFtp,prodRedis

spring.profiles.include 的作用是可以叠加激活新的profile ，这样可以在总的项目配置(bootstrap.yml)中实现一键切换dev、test、prod三者不同环境, 即

切换为dev时，同时激活了dev、devDb、devFtp、devRedis 的profile
切换为test时，同时激活了test、testDb、testFtp、testRedis 的profile
切换为prod时，同时激活了prod、prodDb、prodFtp、prodRedis 的profile

另外： 在yml配置文件中配置List<String> 的值，可以采用 -子项 的方式，如 ：

1
2
3
4
spring.profiles.include:
- 子项1
- 子项2
- 子项3

也可以采用 逗号分隔元素列表的方式，如：

1
spring.profiles.include: 子项1,子项2,子项3