SpringBoot（三）：SpringBoot 属性配置文件详解

秒速五厘米 2022-05-18 07:42 252阅读 0赞

来源：[https://blog.csdn.net/saytime/article/details/74781708][https_blog.csdn.net_saytime_article_details_74781708]

SpringBoot 配置文件默认为application.properties，但是本章节主要讲解yaml文件配置，因为现在的趋势是使用yaml，它是类似于标准通用标记语言的子集XML的数据描述语言，语法比XML简单很多。

### 一、自定义属性与加载 ###

思路：先弄一个属性文件，再弄一个与之对应的属性类，写一个测试，看能不能把属性都显示出来。

我们把之前项目中的配置文件application.properties改成application.yml，这样就相当于是application.yml是自定义属性了。

\-------------------------application.yml文件--------------------------

test:
        user:
            username: jintingbo
            age: 48
            toString: ${test.user.username} and ${test.user.age}
    
    hubei:
        jingmen:
            name: hejinjin
            sex: 女
            toString1: ${hubei.jingmen.name} and ${hubei.jingmen.sex}

\------------------------------------------------------------------------------------

注意上面的文本的输入方法哦！ user前面是4个空格， username: 的后面一定要打一个空格， 不能打tab键。  
与上面的属性文件相对应，得有一个属性类 MyHello

\--------------------------------------

package com.example.demo1.controller;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    
    @Component
    public class MyHello {
        @Value("${test.user.username}")
        private String username;
        @Value("${test.user.age}")
        private String age;
        @Value("${test.user.toString}")
        private String toString;
        @Value("${hubei.jingmen.name}")
        private String name;
        @Value("${hubei.jingmen.sex}")
        private String sex;
        @Value("${hubei.jingmen.toString1}")
        private String toString1;
    
        public void setName(String name) {
            this.name = name;
        }
    
        public void setSex(String sex) {
            this.sex = sex;
        }
    
        public void setToString1(String toString1) {
            this.toString1 = toString1;
        }
    
        public String getName() {
            return name;
        }
    
        public String getSex() {
            return sex;
        }
    
        public String getToString1() {
            return toString1;
        }
    
        public String getUsername() {
            return username;
        }
    
        public String getAge() {
            return age;
        }
    
        public void setUsername(String username) {
            this.username = username;
        }
    
        public void setAge(String age) {
            this.age = age;
        }
    
        public String getToString() {
            return toString;
        }
    
        public void setToString(String toString) {
            this.toString = toString;
        }
    }

\------------------------------------  
测试Controller

\------------------------------------

package cn.saytime.web;  
import cn.saytime.bean.PropertiesConfig;  
import org.springframework.beans.factory.annotation.Autowired;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RequestMethod;  
import org.springframework.web.bind.annotation.RestController;  
  
@RestController  
public class TestController \{  
@Autowired  
private PropertiesConfig propertiesConfig;  
@RequestMapping(value = "test", method = RequestMethod.GET)  
public String test()\{  
// return propertiesConfig.getUsername() + ":" + propertiesConfig.getAge();  
return propertiesConfig.getToString();  
\}  
\}

\------------------------------------

访问 [http://127.0.0.1/test][http_127.0.0.1_test]

![这里写图片描述][SouthEast]

### 二、自定义属性注入bean ###

将上面application.yml文件中的test.user注入到User对象里，注意这里的prefix指定的是test.user，对应配置文件中的结构

@Component  
@ConfigurationProperties(prefix = "test.user")  
public class User \{  
private String username;  
private int age;  
public String getUsername() \{  
return username;  
\}  
// Getter Setter  
\}  
\----------------------------------

@RestController  
public class TestController \{  
@Autowired  
private User user;  
@RequestMapping(value = "test2", method = RequestMethod.GET)  
public String test2()\{  
return user.getUsername() + ":" + user.getAge();  
\}  
\}

\------------------------------------  
访问 [http://localhost:8080/test2][http_localhost_8080_test2] ==> zhangsan : 18

### 三、自定义额外的配置文件 ###

比如我们不想把有些配置配置在application.yml/properties中。新建其他配置文件。这里比如新建**test.yml**文件。配置内容如上面的application.yml一样。那么我们注入到User对象时，应该这么写：

@Configuration  
@PropertySource(value = "classpath:test.yml")  
@ConfigurationProperties(prefix = "test.user")  
public class User \{  
private String username;  
private int age;

//一些get和set  
\}

测试方法和上面的一样。

### 四、多个环境配置文件 ###

在现实的开发环境中，我们需要不同的配置环境；格式为application-\{profile\}.properties，其中\{profile\}对应你的环境标识，比如：

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

当你要使用开发环境时，只需要我们在application.yml中加：

spring:  
profiles:  
active: dev

这样启动时就会只加载公共和开发环境的配置文件，要换成其它的环境也是这个模式。  
因为主入口都是application.yml，这里指定配置文件为dev，即启用application-dev.yml文件

其中application-dev.yml:

server:  
port: 8888  
启动工程，发现程序的端口不再是8080,而是8888，表示开发环境配置成功。

### 六、官方支持默认配置文件属性 ###

[http://docs.spring.io/spring-boot/docs/1.5.4.RELEASE/reference/htmlsingle/\#common-application-properties][http_docs.spring.io_spring-boot_docs_1.5.4.RELEASE_reference_htmlsingle_common-application-properties]

### 七、属性加载优先级 ###

1. @TestPropertySource 注解  
2. 命令行参数  
3. Java系统属性（System.getProperties()）  
4. 操作系统环境变量  
5. 只有在random.\*里包含的属性会产生一个RandomValuePropertySource  
6. 在打包的jar外的应用程序配置文件（application-\{profile\}.properties，包含YAML和profile变量）  
7. 在打包的jar内的应用程序配置文件（application-\{profile\}.properties，包含YAML和profile变量）  
8. 在@Configuration类上的@PropertySource注解  
9. 默认属性（使用SpringApplication.setDefaultProperties指定）

也就是说比如我配置文件配置了一个name=zhangsan，然后将项目打成jar，运行的时候，如果我们使用 `java -jar app.jar --name="Spring"`，那么注入的进去的就是Spring，优先级高

### 八、配置文件优先级 ###

查看SpringBoot官方文档，可以发现

![这里写图片描述][SouthEast 1]

翻译：

1.  当前目录下的一个/config子目录
2.  当前目录
3.  一个classpath下的/config包
4.  classpath根路径（root）

也就是说：如果我们有多个配置文件，比如  
\------------------------------------

src/main/resource/application.yml  
\------------------------------------

test:  
user:  
username : zhangsan  
age : 18  
toString: the age of $\{test.user.username\} is $\{test.user.age\}  
name: SpringBoot-root  
test2: $\{test1\}-root  
test3: SpringCloud-root  
server:  
port: 8080

\------------------------------------  
src/main/resource/config/application.yml  
\------------------------------------

test:  
user:  
username: lisi-config  
name: SpringBoot-config  
test1: $\{name\}-config  
test4: $\{test3\}-config  
server:  
port: 9090

根据优先级，因为第2个配置文件有/config子目录，所以它的优先级别高，相同的属性，让他选完后，才可以让第一个配置文件选。最后的结果是，能够加载到SpringBoot应用的属性为：

test:  
user:  
username : lisi  
age : 18  
toString: the age of lisi is 18  
name: SpringBoot-config  
test1: SpringBoot-config-config  
test2: SpringBoot-config-config-root  
test3: SpringCloud-root  
test4: SpringCloud-root-config  
server:  
port: 9090

\------------------------------------

如果你能够得到上面的结果，表示你已经懂了。

注意优先级高的配置文件中存在和优先级低的配置文件相同属性时，取优先级高配置文件的，不冲突的时候，优先级低的配置文件属性同样会被加载，而不是只加载优先级高的配置文件属性。

### 九、简单总结 ###

1、普通自定义属性，使用`@Value("${xxx}")`注入

2、注入对象，使用`@ConfigurationProperties(prefix="test.user")`

[https_blog.csdn.net_saytime_article_details_74781708]: https://blog.csdn.net/saytime/article/details/74781708
[http_127.0.0.1_test]: http://127.0.0.1/test
[SouthEast]: /images/20220518/e20fc171d86c4aaa8368e54fdba344a5.png
[http_localhost_8080_test2]: http://localhost:8080/test2
[http_docs.spring.io_spring-boot_docs_1.5.4.RELEASE_reference_htmlsingle_common-application-properties]: http://docs.spring.io/spring-boot/docs/1.5.4.RELEASE/reference/htmlsingle/#common-application-properties
[SouthEast 1]: /images/20220518/8d3772eaaab14dbe8c888c430949d731.png