springboot-03-yaml配置注入

springboot配置文件种类

1.application.properties

  • 语法结构:key=value

2.application.yml

  • key:空格 value

配置文件的作用:springboot在启动时会根据导入的启动器自动装配一些属性,通过配置文件可以对其进行修改。

yaml概述

YAML
是一个可读性高,用来表达数据序列化的格式。这种语言以数据作为中心,而不是以标记语言为重点!

yaml配置和xml配置对比

xml配置:

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

yaml配置:

server:
  prot: 8081

yaml语法要求严格

1、空格不能省略
2、以缩进来控制层级关系,只要是左边对齐的一列数据都是同一个层级的
3、属性和值的大小写都是十分敏感的

字面量:普通的值 [ 数字,布尔值,字符串 ]
字面量直接写在后面就可以 , 字符串默认不用加上双引号或者单引号;

k: v

注意:

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

比如 :name: “kuang \n shen” 输出 :kuang 换行 shen

‘’ 单引号,会转义特殊字符 , 特殊字符最终会变成和普通字符一样输出

比如 :name: ‘kuang \n shen’ 输出 :kuang \n shen

注入配置文件

1.@Value注解注入

新建一个实体类Dog

@Component  //注册bean到容器中
public class Dog {
    @Value("阿黄")
    private String name;
    @Value("11")
    private Integer age;

	//有参无参构造、get、set方法、toString()方法  
  }

springboot默认测试类

@SpringBootTest
class Springboot01HelloworldApplicationTests {

    @Autowired
    private Dog dog;

    @Test
    void contextLoads() {
        System.out.println(dog);
    }

}

结果成功注入!这种方法有个缺点,如果属性太多,需要挨个注入,繁琐。

2.yaml注入
新建一个实体类Person

/*
@ConfigurationProperties作用:
将配置文件中的每一个属性,映射到这个组件中
告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
*/
@Component
@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;
    
    //有参无参构造、get、set方法、toString()方法  
}

然后在resources目录下删除默认的application.properties,新建一个application.yml

person:
  name: cong
  age: 18
  happy: true
  birth: 2020/2/20
  maps:
    k1: v1
    k2: v2
  lists:
    - code
    - girl
    - music
  dog:
    name: 旺财
    age: 1

map也可写成行内的

maps: {k1: v1,k2: v2}

list也可写成行内的

lists: [code,girl,music]

Dog也可以写成行内的

dog: {name: 旺财,age: 1}

总结:基本都可以写成行内的,list属于数组用[],其他的属于对象用{}

添加@ConfigurationProperties(prefix = “person”)时,IDEA会爆红,提示springboot配置注解处理器没有找到,让我们看文档,我们可以查看文档,找到一个依赖!
解决:在pom.xml加入依赖

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

重启生效

测试类

@SpringBootTest
class Springboot01HelloworldApplicationTests {

    @Autowired
    private Person person;

    @Test
    void contextLoads() {
        System.out.println(person);
    }

}

注入成功

加载指定的配置文件
@PropertySource :加载指定的配置文件;

@configurationProperties:默认从全局配置文件中获取值;

在resources目录下新建一个person.properties文件

name=kuangshen

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

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

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

    ......  
}

配置文件占位符

person:
    name: qinjiang${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

测试
resources下新建一个配置文件 user.properties

user1.name=cong
user1.age=18
user1.sex=男

新建一个实体类User

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

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                '}';
    }
}

测试类

@SpringBootTest
class Springboot01HelloworldApplicationTests {

    @Autowired
    private User user;

    @Test
    void contextLoads() {
        System.out.println(user);
    }

}

结果也能注入成功!

对比
在这里插入图片描述
1、@ConfigurationProperties只需要写一次即可 , @Value则需要每个字段都添加

2、松散绑定:这个什么意思呢? 比如我的yml中写的last-name,这个和lastName是一样的, - 后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下

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

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

结论:

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

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

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值