本文共 5171 字，大约阅读时间需要 17 分钟。

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

Yaml注入配置文件@ConfigurationProperties

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

2、编写一个实体类 Dog

@Component//注册bean到容器中 public class Dog {
       private String name;    private Integer age;     //有参无参构造、get、set方法、toString()方法 }

3、思考，我们原来是如何给bean注入属性值的！ @Value，给狗狗类测试一下：

@Component //注册bean public class Dog {
       	@Value("阿黄")    	private String name;    	@Value("18")    	private Integer age; }

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

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

结果成功输出，@Value注入成功，这是我们原来的办法

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

@Componentpublic class Person {
       private String name;    private Integer age;    private Boolean happy;    private Date birth;    private Map
   
     map;    private List
    
   

6、我们来使用yaml配置的方式进行注入，大家写的时候注意区别和优势，我们编写一个yaml配置

Person:  name: zyx${
   random.uuid} #随机uuid  age: ${
   random.int} #随机int  happy: true  birth: 1992/10/07  map: {
   k1: v1,k2: v2}  list:    - 唱歌    - 跳舞    - 表演  dog:    name: haha    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
   
     map;    private List
    
   

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

   
       
    
     org.springframework.boot
        
    
     spring-boot-configuration-processor
        
    
     true
    
   

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

@SpringBootTestclass Springboot01PropertyApplicationTests {
       @Autowired    private Person person;//将person自动注入进来    @Test    void contextLoads() {
           System.out.println(person); //打印person信息     }}

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

注意：配置文件的key 值 和 属性的值设置为不一样，则结果输出为null，注入失败

加载指定配置文件@PropertySource

@PropertySource ：加载指定的配置文件； @configurationProperties：默认从全局配置文件中获取值；

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

name=kuangshen

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

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

3、再次输出测试一下：指定配置文件绑定成功！

配置文件占位符

Person:  name: zyx${
   random.uuid} #随机uuid  age: ${
   random.int} #随机int  happy: true  birth: 1992/10/07  hello: 旺财  map: {
   k1: v1,k2: v2}  list:    - 唱歌    - 跳舞    - 表演  dog:    # 引用person.hello 的值，如果不存在就用 ：后面的值，即 other，然后拼接上_haha    name: ${
   Person.hello:other}_haha    age: 3

回顾properties配置

我们上面采用的yaml方法都是简单的方式，开发中常用的；也是springboot所推荐的！那我们来唠 唠其他的实现方式，道理都是相同得；写还是那样写；配置文件除了yml还有我们之前常用的properties ， 我们没有讲，我们来唠唠！

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

settings–>FileEncodings 中配置 测试步骤： 1、新建一个实体类User

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

2、编辑配置文件 user.properties

user1.name=kuangshen user1.age=18 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);    }}

结果正常输出：

@ConfigurationProperties、@Value对比小结

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

1、@ConfigurationProperties只需要写一次即可 ， @Value则需要每个字段都添加 2、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， - 后面跟 着的字母默认是大写的。这就是松散绑定。可以测试一下 3、JSR303数据校验 ， 这个就是我们可以在字段是增加一层过滤器验证 ， 可以保证数据的合法性 4、复杂类型封装，yml中可以封装对象 ， 使用value就不支持

结论：

• 配置yml和配置properties都可以获取到值 ， 强烈推荐 yml；
• 如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；
• 如果说，我们专门编写了一个JavaBean来和配置文件进行一一映射，就直接 @configurationProperties，不要犹豫

JSR303数据校验

Springboot中可以用==@validated==来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处 理。我们这里来写个注解让我们的name只能支持Email格式

@Component //注册bean @ConfigurationProperties(prefix = "person") @Validated  //数据校验 public class Person {
       @Email(message="邮箱格式错误")     //name必须是邮箱格式        private String name;  }

运行结果 ： default message [不是一个合法的电子邮件地址];

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

@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或者是EMPTYBooelan检查 @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 对象是否符合正则表达式的规则.......等等 除此以外，我们还可以自定义一些数据校验规则

转载地址：http://qluki.baihongyu.com/