SpringBoot配置@ConfigurationProperties与@Value的区别

柔情只为你懂 2022-03-09 20:31 304阅读 0赞

## 引言 ##

之前创建完成项目之后使用了yml配置文件。并且使用了一个@ConfigurationProperties注解，这次博客主要说说关于@ConfigurationProperties和Spring的@Value注解的区别。

### @ConfigurationProperties与@Value的区别 ###

@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;

这里使用第二种方式，实现配置文件的值注入。要想使用第二种方式首先就需要把之前的注解注释了。然后在配置第二种方式。  
在之前的时候使用xml文件配置的时候会使用到这样的一个配置文件

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    
    </beans>

这个作为Spring的最初始的一个xml配置文件，在之前使用Spring配置文件的时候都是通过解析xml文件来进行控制反转和依赖注入。  
Spring的往容器中注入组件的方式一共有三种

*  通过构造函数注入

!-- 注册userService -->
    <bean id="userService" class="com.example.spring.service.impl.UserService">
    	<constructor-arg ref="userDaoJdbc"></constructor-arg>
    </bean>
    
    <bean id="userDaoJdbc" class="com.example.spring.dao.impl.UserDaoJdbc"></bean>

*  通过setter方法注入
 *  通过注解注入

在之前往Spring容器中注入组件的时候，是通过如下的方式进行创建的。

通过setter方法进行值注入,当然这里的值注入的时候还可以使用SPEL表达式。所以这里可以使用如下的方式进行注入

@Value("${pserson.last-name}")
        private String lastName;
        @Value("#{12*2}")
        private Integer age;
        @Value("ture")
        private Boolean boss;
        private Date birth;

启动类

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SpringBoot01HelloworldApplicationTests { 
        @Autowired
        Person person;
        @Test
        public void contextLoads() { 
            System.out.println(person.toString());
        }
    }

启动测试类之后会发现同样的方式也会获取到配置文件中的值

![在这里插入图片描述][20190309213137324.png]  
但是这个配置方式和使用@ConfigurationProperties的方式还是有一定的区别的

<table> 
 <thead> 
  <tr> 
   <th></th> 
   <th>@ConfigurationProperties</th> 
   <th>@Value</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>功能</td> 
   <td>批量注入配置文件中的属性值，只需要指定一个注解就可以了</td> 
   <td>@Value就需要一个个的指定才可以</td> 
  </tr> 
  <tr> 
   <td>支持松散绑定</td> 
   <td>只有@ConfigurationProperties支持松散绑定，也就是说支持驼峰命名法</td> 
   <td>不支持松散绑定</td> 
  </tr> 
  <tr> 
   <td>支持SPEL表达式</td> 
   <td>它是不支持SPEL表达式的</td> 
   <td>@Value就像上面说的那样可以支持SPEL表达式</td> 
  </tr> 
  <tr> 
   <td>JSR303数据校验</td> 
   <td>在配置文件中注入值的时候可以进行数据校验支持，可以使用@Validated注解进行数据校验</td> 
   <td>使用@Value是不支持数据校验</td> 
  </tr> 
  <tr> 
   <td>对于复杂类型封装</td> 
   <td>对于复杂类型是的封装是支持的</td> 
   <td>不支持对于复杂数据的封装</td> 
  </tr> 
 </tbody> 
</table>

对于这个JSR303有以下的一些检验操作。

空检查 
    @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=) Validates that the annotated string is between min and max included.
    
    日期检查 
    @Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期 
    @Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期 
    @Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
    
    数值检查 
    建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null 
    @Min 验证 Number 和 String 对象是否大等于指定的值 
    @Max 验证 Number 和 String 对象是否小等于指定的值 
    @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度 
    @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度 
    @Digits 验证 Number 和 String 的构成是否合法 
    @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。 
    @Range(min=, max=) 被指定的元素必须在合适的范围内 
    @Range(min=10000,max=50000,message=”range.bean.wage”) 
    @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 
    @CreditCardNumber信用卡验证 
    @Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 
    @ScriptAssert(lang= ,script=, alias=) 
    @URL(protocol=,host=, port=,regexp=, flags=)

配置文件yml还是properties都可以使用这种方式进行值的获取。如果在某个业务中只是简单的获取一下某个配置的值就可以使用@Value的形式，但是如果要获取整个配置文件的值的时候就可以使用整个配置文件的形式

#### 简单的测试 ####

定义一个简单的JavaBean 对象并加入上@ConfigurationProperties注解和@Component注解

@Component
    @ConfigurationProperties
    public class Person { 
        private String name;
    
        public String getName() { 
            return name;
        }
        public void setName(String name) { 
            this.name = name;
        }
    
    }

编写了一个Java的控制类。用于测试RESTFul的请求。

@RestController
    public class HelloController { 
    
        @Value("${person.name}")
        private String name;
    
        @RequestMapping("/sayHello")
        public String sayHello(){ 
            return "Hello"+ name;
        }
    }

配置类的内容

person.name=zhangsan

![在这里插入图片描述][2019030922080420.png]  
编辑完成之后就会看到整个项目运行成功，并且获取到相应的配置值。

[20190309213137324.png]: /images/20220310/b9fda1172726431099d1fc0bec36a7bf.png
[2019030922080420.png]: /images/20220310/214755092fe2449bac00f170307337ff.png