Spring Boot 配置实战

本文主要参考Externalized Configuration

获取配置的方法

@ConfigurationProperties

功能:将一组配置映射为一个配置bean。首先,gradle要引入依赖:

dependencies {
  annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
}

例:application.yml。@ConfigurationProperties支持自适应绑定,配置文件中sub-version可以写成subVersionsub_versionSUB_VERSION:

app:
  meta:
    version: 1
    sub-version: 1

java bean。@ConfigurationProperties参数是配置前缀,还有两个参数控制是否忽略无效字段(ignoreInvalidFields,默认false),是否忽略配置中存在但java bean中不存在的字段(ignoreUnknownFields,默认true)。前缀必须是烤串式命名法,例如myapp.global-set,如果是myapp.globalSet会报错;并且前缀不支持SpEL,如果是myapp.${profile}.global-set会报错:

@ConfigurationProperties("app.meta")
@Data
public class AppMeta {
    private int version;
    private int subVersion;
}

这个bean需要注册到Spring中:

@SpringBootApplication
@Slf4j
@EnableConfigurationProperties({AppMeta.class})
public class App implements CommandLineRunner {

}

@Value

如果每个配置都要写一个配置java bean,最后会写出很多配置类而且使用也不方便,所以Spring支持另一种便捷的读取配置方式。类似@Autowired,可以将配置注入到属性,适合于不会复用、相关配置少的情形,如果一个Server里需要用数十个@Value注入相关属性或者这个属性会在多个地方需要注入,那还是用@ConfigurationProperties吧。
另外,@Value不支持自适应绑定,sub-versionsubVersionsub_versionSUB_VERSION都会是不同的配置key值,所以建议配置项统一用烤串式命名法sub-version

@SpringBootTest
@RunWith(SpringRunner.class)
public class AppTest {
    //读取配置machine.name,如果未定义则设置为hry-pc
    @Value("${machine.name:hry-pc}")
    private String machineName;

载入配置

Spring加载配置文件在Spring准备好Environment之后,初始化bean之前,同时加载顺序和覆盖优先级也有多种,详情见Spring Boot 配置的优先级,Spring Boot 配置初始化流程。
默认的,Spring汇总以下4个目录载入配置文件,相同配置从上到下覆盖。外部值的是启动java程序的目录,如果用application插件打包的话,就是启动脚本的目录,可以用System.getProperty("user.dir")获取该目录路径。

  1. file:./config,在外部的config目录下
  2. file:./,在外部的目录下
  3. classpath:/config/resources/config
  4. classpath:/resources

那么当配置目录的路径、文件名不同时该如何配置?
首先Spring提供配置参数来配置路径和文件名:

  • spring.config.location:默认配置文件路径,注意要以/结尾(windows环境也一样)
  • spring.config.additional-location:附加配置文件路径,注意要以/结尾(windows环境也一样),覆盖优先级低于spring.config.location
  • spring.config.name:配置文件名,注意是不带文件类型名的

这些参数会在加载配置文件时检查,所以这些参数写在需要加载的配置文件中是无效的,也就是需要在加载这些配置文件前就将参数写入到Spring中,从Spring加载配置的优先级,以下方式可以做到:

  1. Devtools全局配置
  2. @TestPropertySource注解
  3. @SpringBootTest的properties属性
  4. 命令行参数
  5. SPRING_APPLICATION_JSON
  6. ServletConfig、ServletContext
  7. JNDI
  8. Java System properties (System.getProperties())
  9. 系统环境变量

考虑到配置的方便和通用性,一般会在命令行参数、系统环境变量、程序提前设置三种方式进行处理。
命令行模式很简单,但是每次启动都需要加参数,然后可以加到启动脚本中:
java -jar .\springbootconfiguraiton.jar --spring.config.location=file:./app-config/
系统环境变量就不说了,说下程序提前设置,也就是在ConfigFileApplicationListener加载前将配置写入到Spring中。

  1. 启动时写入。这个应该是最简单的,但是测试用例无法读取到配置文件,如果每个测试用例都有特定的配置不需要读取系统配置,或者使用spring.config.additional-location定义附加的配置,让测试用例读取resouces下的默认配置可以使用这个方法,总之要注意测试用例是无法跑这段代码的。
public static void main(String[] args) {
    SpringApplication application = new SpringApplication(App.class);
    Properties properties = new Properties();
    properties.setProperty("spring.config.location", "file:./app-config/");
    application.setDefaultProperties(properties);
    application.run(args);
}
  1. 实现高优先级的EnvironmentPostProcessor
    ConfigFileApplicationListener是一个EnvironmentPostProcessor,在执行的时候会根据优先级排序,所以可以在高优先级的切面上将配置写入到Spring中,那么在后面执行读取配置文件的时候就能实现自定义的功能。记得要在META-INF/spring.factories注册这个类。
public class ConfigConfigurationProcessor implements EnvironmentPostProcessor, Ordered {
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
        Properties properties = new Properties();
        properties.setProperty("spring.config.location", "file:./app-config/");
        environment.getPropertySources().addFirst(
                new PropertiesPropertySource("configConfiguration", properties));
    }

    @Override
    public int getOrder() {
        return Ordered.HIGHEST_PRECEDENCE;
    }
}
#Project/resources/META-INF/spring.factories
org.springframework.boot.env.EnvironmentPostProcessor=demo.ConfigConfigurationProcessor

参考源码:https://github.com/huangry999/java/tree/master/springdemo/configuration

你可能感兴趣的:(Spring Boot 配置实战)