SpringBoot学习笔记（7）——配置文件Yaml语法与Springboot-properties自动配置

最新推荐文章于 2025-05-08 08:00:00 发布

开拖拉机的大宝

最新推荐文章于 2025-05-08 08:00:00 发布

阅读量232

点赞数

CC 4.0 BY-SA版权

分类专栏： SpringBoot学习笔记 JAVA

本文链接：https://blog.csdn.net/yangwei256/article/details/99536981

JAVA 同时被 2 个专栏收录

21 篇文章

订阅专栏

SpringBoot学习笔记

13 篇文章

订阅专栏

Yaml语法：

YAML（YAML Ain't Markup Language）

YAML A Markup Language：是一个标记语言

YAML isn't Markup Language：不是一个标记语言；

标记语言：

以前的配置文件；大多都使用的是 xxxx.xml文件；

YAML：以数据为中心，比json、xml等更适合做配置文件；

YAML：配置例子

//Yaml举例：
server:
    port: 8081

//XML举例：
<server>
    <port>8081</port>
</server>

1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

属性和值也是大小写敏感；

server:
    port: 8081
    path: /hello

2、值的写法

字面量：普通的值（数字，字符串，布尔）

k: v：字面直接来写；

字符串默认不用加上单引号或者双引号；

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

name: "zhangsan \n lisi"：输出；zhangsan 换行 lisi

''：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

对象、Map（属性和值）（键值对）：

k: v：在下一行来写对象的属性和值的关系；注意缩进

对象还是k: v的方式

friends:
    lastName: zhangsan
    age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

数组（List、Set）：

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

pets:
‐ cat
‐ dog
‐ pig

行内写法

pets: [cat,dog,pig]

3、配置文件值注入

（1）目录结构如下

（2）配置文件（yml格式的，properities格式的配置文件为空，若两个都有参数，都生效，冲突的参数以properties优先）

server:
  port: 8081

person:
  lastName: zhangsan//也可以是last-name，同样可以提取到
  age: 18
  boss: false
  birth: 2017/12/12
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - zhaowu
  dog:
    name: 小狗
    age: 12

同样的配置在properties中的表示：

server.port=8081

person.last‐name=张三 
person.age=18
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=小狗
person.dog.age=15

javaBean-Person文件，这里的get、set方法是不能少的，否则测试返回为空。

package com.atguigu.quickstarter.Bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 * * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * *
 * * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }


    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getBoss() {
        return boss;
    }

    public void setBoss(Boolean boss) {
        this.boss = boss;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }
}

@ConfigurationProperties(prefix = "person")需要导入配置文件处理器，以后编写配置就有提示了

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

测试如下，可以看到打印的person信息：

1、properties配置文件在idea中默认utf-8可能会乱码

松散语法：如@ConfifigurationProperties支持last-name和lastName互通映射，而@value不支持。

Spel:表示式运算是否支持，如{2*12}@ConfifigurationProperties不支持，@value支持。

JSR303数据校验：校验如下图，增加类@Validated，属性增加@Email,则lastName必须是email的格式。

复杂类型封装：@value注解不支持，如map数据，@value取不出来。

具体使用时：

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfifigurationProperties，可以批量映射；

3、配置文件注入值数据校验实例：

4、@@PropertySource、@ImportResource&@Bean注解

（1）@PropertySource：加载指定的配置文件，配置属性多时，可进行分类配置，有效管理。

A:新建person.peroperties,配置person信息如下，原application.peoperties的person信息注释掉。

B：person中增加注解@PropertySource(value = {"classpath:person.properties"})，映射类路径下的person.peoperties,"classpath:person.properties"中不能有空格;

package com.atguigu.quickstarter.Bean;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 * * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * *
 * * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 * @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 */
@Component
//application.perpoties已经将person的信息注释掉
@ConfigurationProperties(prefix = "person")
//映射类路径下的person.peoperties,"classpath:person.properties"中不能有空格;
@PropertySource(value = {"classpath:person.properties"})

public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }


    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getBoss() {
        return boss;
    }

    public void setBoss(Boolean boss) {
        this.boss = boss;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }
}

测试运行可得到同样结果。

（2）@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效，因springboot就是简化spring配置的，该注解了解即可，不推荐；

Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；

想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效

（3）@Bean：给容器中添加组件

@Confifiguration：标注为Spring配置类

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

1、配置类@Confifiguration------>Spring配置文件

2、使用@Bean给容器中添加组件

以下为使用配置类给容器添加组件示例，容器中这个组件默认的id就是方法名，以下id是helloservice02：

/**
* @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
**Spring在配置文件中用<bean><bean/>标签添加组件
*
*/
@Configuration
public class MyAppConfig {
    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}