SpringBoot yaml配置注入

布满荆棘的人生 2022-12-08 15:51 159阅读 0赞

# 配置文件 #

SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的

*  application.properties
 *   *  语法结构 ：key=value
 *  application.yml
 *   *  语法结构 ：key：空格 value

**配置文件的作用**：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；

比如我们可以在配置文件中修改Tomcat 默认启动的端口号为7777。

server.port=7777

--------------------

# yaml概述 #

YAML是 “YAML Ain’t a Markup Language” （YAML不是一种标记语言）的递归缩写。

在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言）

**这种语言以数据作为中心，而不是以标记语言为重点。**

以前的配置文件，大多数都是使用xml来配置；比如一个简单的端口配置，我们来对比下yaml和xml

*  传统xml配置：

*  yaml配置：

server：  
    	prot: 7777

# yaml基础语法 #

说明：语法要求严格！

1、空格不能省略

2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的。

3、属性和值的大小写都是十分敏感的。

**字面量：普通的值 \[ 数字，布尔值，字符串 \]**

字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号；

k: v

注意：

*  “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；
    
    比如 ：name: “lyh \\n test” 输出 ：lyh 换行 test
 *  ‘’ 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出
    
    比如 ：name: ‘lyh \\n test’ 输出 ：lyh \\n test

**对象、Map（键值对）**

#对象、Map格式
    k:     
    	v1:    
    	v2:

对象的属性和值得关系，注意缩进；

比如：

student:    
    	name: lyh    
    	age: 3

行内写法

student: {name: lyh,age: 3}

**数组（ List、set ）**

用 - 值表示数组中的一个元素,比如：

pets: 
    	- cat 
    	- dog 
    	- pig

行内写法

pets: [cat,dog,pig]

**修改SpringBoot的默认端口号**

配置文件中添加，端口号的参数，就可以切换端口；

server:  
    	port: 8082

# 注入配置文件 #

在springboot项目中的resources目录下新建一个文件 application.yml

person:
      name: lyh
      age: 3
      happy: false
      birth: 2000/01/01
      maps: { k1: v1,k2: v2}
      lists:
       - code
       - girl
       - music
      dog:
        name: 旺财
        age: 1

/* @ConfigurationProperties作用： 将配置文件中配置的每一个属性的值，映射到这个组件中； 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定 参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应 */
    
    @Component //注册bean
    @ConfigurationProperties(prefix = "person")
    public class Person { 
        private String name;
        private Integer age;
        private Boolean happy;
        private Date birth;
        private Map<String,Object> maps;
        private List<Object> lists;
        private Dog dog;
    }

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <optional>true</optional>
    </dependency>

# 配置文件占位符 #

配置文件还可以编写占位符生成随机数

person:
        name: lyh ${ random.uuid} # 随机uuid
        age: ${ random.int}  # 随机int
        happy: false
        birth: 2000/01/01
        maps: { k1: v1,k2: v2}
        lists:
          - code
          - girl
          - music
        dog:
          name: ${ person.hello:other}_旺财
          age: 1

# 回顾properties配置 #

我们上面采用的yaml方法都是最简单的方式，开发中最常用的也是springboot所推荐的。

配置文件除了yml还有我们之前常用的properties 。

1、新建一个实体类User

@Component //注册bean
    public class User {     
        private String name;    
        private int age;    
        private String sex;
    }

2、编辑配置文件 user.properties

user1.name=lyh
    user1.age=1
    user1.sex=男

3、我们在User类上使用@Value来进行注入

@Component //注册bean
    @PropertySource(value = "classpath:user.properties")
    public class User { 
        //直接使用@value
        @Value("${user.name}") //从配置文件中取值
        private String name;
        @Value("#{9*2}")  // #{SPEL} Spring表达式
        private int age;
        @Value("男")  // 字面量
        private String sex;
    }

4、Springboot测试

@SpringBootTest
    class DemoApplicationTests { 
    
        @Autowired
        User user;
    
        @Test
        public void contextLoads() { 
            System.out.println(user);
        }
    
    }

# 结论： #

配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；

如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；

如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties