SpringBoot配置文件application

2023-11-30 10:02:03

配置文件

SpringBoot使用一个全局的配置文件，配置文件名称是固定的，有两种文件格式：

application.properties

语法结构：key=value

application.yml

语法结构：key：空格 value

配置文件的作用：其实SpringBoot在底层都给我们自动配置好了，但实际开发中有些情况自定义配置，所以该配置文件的作用就是修改替换SpringBoot自动配置的默认值；

yaml概述

YAML是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言）

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

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

传统xml配置：

<server>
    <port>8081<port>
</server>

yaml配置：

server：
  prot: 8080

yaml基础语法

说明：语法要求严格！

1、空格不能省略

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

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

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

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

k: v

注意：

“ ” 双引号，不会转义字符串里面的特殊字符，特殊字符会作为本身想表示的意思；

比如：name: "zhou \n jielun" 输出：zhou 换行 jielun
'' 单引号，会转义特殊字符，特殊字符最终会变成和普通字符一样输出

比如：name: ‘zhou \n jielun’ 输出：zhou \n jielun

对象、Map（键值对）

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

#例如：
student:
    name: zhoujielun
    age: 30

#行内写法
student: {name: qinjiang,age: 3}

数组（ List、set ）

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

pets:
 - cat
 - dog
 - pig

#行内写法
pets: [cat,dog,pig]

yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！

yaml注入配置文件

1、在springboot项目中的resources目录下新建一个文件 application.yml，配置一个对象

person:
  name: jielun
  age: 30
  happy: false
  birth: 2000/01/01
  maps: {k1: v1,k2: v2}
  lists:
   - code
   - girl
   - music
  dog:
    name: 狗狗
    age: 1

2、编写一个实体类Person；

@Component //注册bean到容器中
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;
    
    //有参无参构造、get、set方法、toString()方法  
}

在实体类配置：@ConfigurationProperties(prefix = "person")

此时，IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖！

得知需要添加一个依赖：

        <!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

在测试类测试打印配置注入结果：

    @Autowired
    Person person; //将person自动注入进来

    @Test
    public void contextLoads() {
        System.out.println(person); //打印person信息
    }

打印：

加载指定的配置文件

@configurationProperties：是默认从全局配置文件中获取值的，很多场景是需要从指定配置文件加载的，这时候需要：

@PropertySource ：加载指定的配置文件 + @Value来具体注入

例如：

新建一个person.properties配置文件，文件内容 name=jielun

然后在我们的代码中指定加载person.properties文件

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {

    @Value("${name}")
    private String name;

    ......  
}

yaml非常强大，还可以有下面的操作：

配置文件占位符

例如编写占位符生成uuid、随机数

测试结果：

到这里，就有两种方式了，对比如下：

1、@ConfigurationProperties只需要写一次即可， @Value则需要每个字段都添加

2、松散绑定：比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

3、JSR303数据校验，这个就是我们可以在字段是增加一层过滤器验证，可以保证数据的合法性

4、复杂类型封装，yml中可以封装对象，使用value就不支持

结论：

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

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

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

码农公寓