Spring Boot相关知识（一）配置优先级顺序

最新推荐文章于 2024-03-24 20:49:18 发布

weixin_34248118

最新推荐文章于 2024-03-24 20:49:18 发布

阅读量247

点赞数

原文链接：https://my.oschina.net/ChinaHaoYuFei/blog/1605879

版权

2019独角兽企业重金招聘Python工程师标准>>>

Spring Boot 项目存在一种优先级配置读取的机制，后面详细介绍一下：

外部化的配置

Spring 框架本身提供了多种的方式来管理配置属性文件。Spring 3.1 之前可以使用 PropertyPlaceholderConfigurer。Spring 3.1 引入了新的环境（Environment）和概要信息（Profile）API，是一种更加灵活的处理不同环境和配置文件的方式。但是 Spring 这些配置管理方式的问题在于选择太多，有些杂乱。Spring Boot 提供了一种统一的方式来管理应用的配置，允许使用属性文件、YAML 文件、环境变量和命令行参数来定义优先级不同的配置值。按照优先级从高到低的顺序依次为：

1. 命令行参数[命令行参数的优先级被设置为最高。这样的好处是可以在测试或生产环境中快速地修改配置参数值，而不需要重新打包和部署应用]。
2. 通过 System.getProperties() 获取的 Java 系统参数。
3. 操作系统环境变量。
4. 从 java:comp/env 得到的 JNDI 属性。
5. 通过 RandomValuePropertySource 生成的“random.*”属性。
6. 应用 Jar 文件之外的属性文件。(通过spring.config.location参数)
7. 应用 Jar 文件内部的属性文件。
8. 在应用配置 Java 类（包含“@Configuration”注解的 Java 类）中通过“@PropertySource”注解声明的属性文件。
9. 通过“SpringApplication.setDefaultProperties”声明的默认属性。

按照优先级划分了配置文件的优先级之后，如果Spring Boot在优先级更高的位置找到了配置，那么它就会无视优先级低的配置。比如：

我在application.properties的目录中，写入本地的MySQL的配置：
  db.jdbc.driver=com.mysql.jdbc.Driver
  db.jdbc.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8
  db.jdbc.username=username
  db.jdbc.password=password

在自己项目调试的阶段，项目总是会使用本地的MySQL数据库。而一旦打包之后，在外部声明一个test_evn.properties.
启动Jar包的时候, 指定一个外部配置文件：

java -jar demo.jar --spring.config.location=/path/test_evn.properties

这样一来，我们在开发者的机器上总是使用自己的配置，而一到对应的环境，就会使用高级的位置所做的配置。SpringApplication 类默认会把以“--”开头的命令行参数转化成应用中可以使用的配置参数，如 “--name=Alex” 会设置配置参数 “name” 的值为 “Alex”。如果不需要这个功能，可以通过 “SpringApplication.setAddCommandLineProperties(false)” 禁用解析命令行参数。
在代码中读取这些配置也是非常方便的，在代码的逻辑中，其实是无需去关心这个配置是从什么地方来的，只用关注能获取什么配置就够了。

程序代码如下：
public class ApplicationConfigure {
    @Value("${db.jdbc.driver}")
    private String jdbcDriver;
    @Value("${db.jdbc.url}")
    private String jdbcUrl;
    @Value("${db.jdbc.username}")
    private String jdbcUsername;
    @Value("${db.jdbc.password}")
    private String jdbcPassword;
    
    // mysql config class
    // ..... 
    
}

RandomValuePropertySource 可以用来生成测试所需要的各种不同类型的随机值，从而免去了在代码中生成的麻烦。RandomValuePropertySource 可以生成数字和字符串。数字的类型包含 int 和 long，可以限定数字的大小范围。以“random.”作为前缀的配置属性名称由 RandomValuePropertySource 来生成.

属性文件

属性文件是最常见的管理配置属性的方式。Spring Boot 提供的 SpringApplication 类会搜索并加载 application.properties 文件来获取配置属性值。SpringApplication 类会在下面位置搜索该文件。

1. 当前目录的“/config”子目录。
2. 当前目录。
3. classpath 中的“/config”包。
4. classpath

这个顺序也表示了该位置上包含的属性文件的优先级。优先级按照从高到低的顺序排列。可以通过“spring.config.name”配置属性来指定不同的属性文件名称。也可以通过“spring.config.location”来添加额外的属性文件的搜索路径。如果应用中包含多个 profile，可以为每个 profile 定义各自的属性文件，按照“application-{profile}”来命名。对于配置属性，可以在代码中通过“@Value”来使用。

@Value("${name}")中的值按照层级通过点来区分，比如要取到active的值。就需要写成@Value("${spring.profiles.active}").

YAML
相对于属性文件来说，YAML 是一个更好的配置文件格式。YAML 在 Ruby on Rails 中得到了很好的应用。SpringApplication 类也提供了对 YAML 配置文件的支持，只需要添加对 SnakeYAML 的依赖即可。比如：

spring:
 profiles: development
db:
 url: jdbc:hsqldb:file:testdb
 username: sa
 password:
---
spring:
 profiles: test
db:
 url: jdbc:mysql://localhost/test
 username: test
 password: test

这个实例的 YAML 文件中同时给出了 development 和 test 两个不同的 profile 的配置信息，这也是 YAML 文件相对于属性文件的优势之一。除了使用“@Value”注解绑定配置属性值之外，还可以使用更加灵活的方式。

@Component
@ConfigurationProperties(prefix="db")
public class DBSettings {
 private String url;
 private String username;
 private String password;
}
给出的是使用代码清单 5 中的 YAML 文件的 Java 类。通过“@ConfigurationProperties(prefix="db")”注解，配置属性中以“db”为前缀的属性值会被自动绑定到 Java 类中同名的域上，如 url 域的值会对应属性“db.url”的值。只需要在应用的配置类中添加“@EnableConfigurationProperties”注解就可以启用该自动绑定功能。

我这里还有一个疑问，这个是怎么注入进来的呢？
我们在项目启动的时候，总是需要先启动一些初始化的类，比较常见的做法是写再static块中，Spring Boot提供了一个CommandLineRunner接口，实现这个接口的类总是会被优先启动，并优先执行CommandLineRunner接口中提供的run()方法。比如：

public class ApplicationConfigure implements CommandLineRunner  {

    @Value("${db.jdbc.driver}")
    private String jdbcDriver;
    @Value("${db.jdbc.url}")
    private String jdbcUrl;
    @Value("${db.jdbc.username}")
    private String jdbcUsername;
    @Value("${db.jdbc.password}")
    private String jdbcPassword;
    
    // mysql config class
    // ..... 
    @Override
    public void run(String... strings) throws Exception {
        // 预先加载的一些方法，类，属性。
    }
}
如果有多个CommandLineRunner接口实现类，那么可以通过注解@Order来规定所有实现类的运行顺序。

这里有的是我借鉴网上的一些描述，现在还不能完全深刻明白这些内容。有些内容是我真实运行项目截图

借鉴网址：https://www.ibm.com/developerworks/cn/java/j-lo-spring-boot/index.html

转载于:https://my.oschina.net/ChinaHaoYuFei/blog/1605879