springboot5：注入配置文件

yaml是一个非常强大的配置文件格式，这期我们来看一下如何使用yaml文件来注入配置文件

Yaml注入配置文件

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

2、编写一个实体类 Dog

@Component
public class Dog {
    private String name;
    private Integer age;
//有参无参构造、get、set方法、toString()方法
}

3、 @Value，给狗狗类测试一下

@Component 
public class Dog {
    @Value("旺财")
    private String name;
    @Value("3")
    private Integer age;
}

4、在SpringBoot的测试类下注入狗狗输出一下

@SpringBootTest
class DemoApplicationTests {
    @Autowired //将狗狗自动注入进来
    private Dog dog;
    @Test
    public void contextLoads() {
        System.out.println(dog); //打印看下狗狗对象
    }
}

结果成功输出，@Value注入成功

Dog(name=旺财，age=3)

5、我们在编写一个复杂一点的实体类：Person 类

@Component
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()方法
}

6、这时我们来使用yaml配置的方式进行注入，看看和原始的value有什么区别

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

7、我们刚才已经把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;
}

8、这个时候IDEA会报错提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到一个依赖

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

9、确认以上配置都OK之后，我们去测试类中测试一下

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    private Person person;
    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

结果：所有值全部注入成功！

Person{name='hsy', age=3, happy=false, birth=Tue Sep 26 00:00:00 CST 2000, maps={k1=v1, k2=v2}, lists=[code, music, girl], dog=Dog{name='旺财', age=3}}

这个时候我们就实现了利用yaml注入配置文件，这种方式要比传统的使用value对每一个属性依次赋值要方便许多~

加载指定配置文件

我们都知道，springboot的指定配置文件名为application.xxx，否则springboot无法识别

但有的时候，我们需要根据项目的需求加载指定的配置文件

这个时候我们就可以使用两个注解

@PropertySource ：加载指定的配置文件

@ConfigurationProperties：默认从全局配置文件中获取值

1、我们去在resources目录下新建一个person.properties文件

name=hsy

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

@PropertySource(value = "classpath:person.properties")
@Component //注册bean
public class Person {
    @Value("${name}")
    private String name;
}

3、再次输出测试即可

配置文件占位符

person:
  name: hsy${random.uuid} # 随机uuid
  age: ${random.int} # 随机int
  happy: false
  birth: 2000/09/26
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - girl
    - music
  dog:
  # 引用person.hello 的值，如果不存在就用 ：后面的值，即 other，然后拼接上_旺财
    name: ${person.hello:other}_旺财
    age: 1

properties配置

我们上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！配置文件除了yaml还有我们之前常用的properties

【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；

settings–>FileEncodings 中配置；

1、新建一个实体类User

@Component 
public class User {
    private String name;
    private int age;
    private String sex;
}

2、编辑配置文件 user.properties

user.name=hsy
user.age=20
user.sex=男

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

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

4、Springboot测试

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

结果正常输出即可！

yaml与properties对比

@Value这个使用起来并不友好！我们需要为每个属性单独注解赋值，比较麻烦

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

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

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

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

结论：

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

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

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

@configurationProperties，不要犹豫！

JSR303数据校验

使用数据校验，可以保证数据的正确性； 下面列出一些常见的使用

@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120")
private int age;
@Email(message="邮箱格式错误")
private String email;

空检查
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
    
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
    
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) string is between min and max included.
    
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
    
.......等等
除此以外，我们还可以自定义一些数据校验规则