SpringBoot的配置文件
配置文件加载优先级
SpringBoot对于所加载的多个配置文件，会进行合并共存。如果配置文件之间有冲突，规则是冲突部分高优先级的配置覆盖低优先级的配置。而加载的地方有多个，常见的地方，优先级从高到低有（spring官网文档）：
1.
命令行参数java -jar app.jar --server.port=8087 --配置=值
2. jar包外部的application-{profile}.properties/yml配置文件
3. jar包内部的application-{profile}.properties/yml配置文件
4. jar包外部的application.properties/yml配置文件
5. jar包内部的application.properties/yml配置文件
6. @Configuration注解类上的@PropertySource
7. 通过SpringApplication.setDefaultProperties指定的默认属性
因此，最常见的四个路径：file:./config/>file:./>classpath:/config/>classpath:/，有profile高于没profile，properties高于yaml。配置文件路径的优先级高于配置文件类型。也就是说，如果有两个配置文件：classpath:/config/application.yml和classpath:/application.properties。此时yaml优先级高于properties。
配置的使用与装配
要使用配置文件的配置，可以使用@ConfigurationProperties和@Value这两个注解加载配置
配置文件
1
2user.username=admin
user.password=123456
使用@ConfigurationProperties
1
2
3
4
5
6
7@Configuration
@ConfigurationProperties(prefix = "user")
public class User {
private String username;
private String password;
...getter,setter
}
使用@Value
1
2
3
4
5
6
7
8@Configuration
public class User {
@Value("user.username")
private String username;
@Value("user.password")
private String password;
...getter,setter
}
加载指定的配置文件
要加载指定的配置文件，需要使用@PropertySource注解，使用：
1
2
3
4
5
6
7
8@PropertySource(value = {"classpath:user.properties","classpath:admin.properties"})
@Configuration
@ConfigurationProperties(prefix = "user")
public class User {
private String username;
private String password;
...getter,setter
}
@PropertySource注解：
1
2
3
4
5
6
7
8
9
10
11
12public @interface PropertySource {
//指定一个配置文件
String name() default "";
//指定多个配置文件，如果多个配置文件直接配置冲突，从左往右，右边优先级高
String[] value();
//如果配置文件没找着，是否忽略
boolean ignoreResourceNotFound() default false;
//配置文件编码
String encoding() default "";
//配置文件的解析工厂
Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;
}
其中比较有趣的是配置文件的解析工厂，默认是PropertySourceFactory，是个接口，其唯一的实现是DefaultPropertySourceFactory：
1
2
3
4
5
6public class DefaultPropertySourceFactory implements PropertySourceFactory {
@Override
public PropertySource<?> createPropertySource(@Nullable String name, EncodedResource resource) throws IOException {
return (name != null ? new ResourcePropertySource(name, resource) : new ResourcePropertySource(resource));
}
}
可以看到使用的是ResourcePropertySource进行解析，可以解析properties和xml，所以@PropertySource不支持yaml。所以如果要支持yaml，需要自己实现PropertySourceFactory，在@PropertySource里指定。
1 | |
除此以外，还可以通过PropertyPlaceholderConfigurer支持加载yaml文件。PropertyPlaceholderConfigurer的作用是给代码中${}占位符赋值，可以给PropertyPlaceholderConfigurer设置yaml解析。
1
2
3
4
5
6
7
8@Bean
public static PropertySourcesPlaceholderConfigurer properties() {
PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer = new PropertySourcesPlaceholderConfigurer();
YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
yaml.setResources(new ClassPathResource("simple.yml"));
propertySourcesPlaceholderConfigurer.setProperties(yaml.getObject());
return propertySourcesPlaceholderConfigurer;
}
通过ContextRefresher重新加载或者魔改配置
Spring Cloud
Config支持热更配置，其核心在于调用ContextRefresher对象的refresh方法。这部分原理还不是很了解，据参考文章里说，Spring
Cloud Config通过创建一个临时的Spring Boot
Application加载配置文件。重新加载或者魔改配置的核心在于下面：
1
2
3
4
5
6ConfigurableApplicationContext application = ...;
ContextRefresher contextRefresher = ...;
PropertySource<?> propertySource = ...;
application.getEnvironment().getPropertySources().addFirst(propertySource);
contextRefresher.refresh();
ConfigurableApplicationContext就不多说了，ContextRefresher我现在是通过application.getBean()获取的。一开始我好像试过通过@Autowired注入ContextRefresher，但不记得是因为不行还是什么其他原因，现在变成了application.getBean()获取。PropertySource就是PropertySourceFactory接口返回的对象。
其中有一点奇怪的，这个PropertySource需要放在队列最前面。通过debug发现，spring不知道为啥会将这个队列倒过来用，即实际上他是最后一个生效的，会覆盖前面的配置。后面的配置覆盖前面的配置，有点像@PropertySource。
动态刷新bean
Spring Cloud Config使用ContextRefresher实现热更，除了能热更@Configuration的配置以外，还能热更任何bean，包括数据库或者redis的。要实现数据库或者redis的热更，需要手动些方法，通过@Bean注解注册bean，然后加上@RefreshScope注解，表明这个bean是需要热更的。
1 | |
参考文章