SpringBoot简明教程之项目属性配置(二):@ConfigurationProperties与@Value简单比较

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/m0_37888031/article/details/82025749

前文回顾

在上一篇博文:SpringBoot简明教程之项目属性配置(一):YAML简介 中我们简单的介绍了SpringBoot的项目属性配置中有关YAML文件的简单语法以及简单展示了通过配置文件进行值注入。

@ConfigurationProperties与@Value简单比较

在上一篇博客中,我们主要是通过@ConfigurationProperties进行的配置文件值注入。这一节,我们将演示如何通过@Value来实现配置文件值注入以及其与@ConfigurationProperties注入的的异同点。

如何通过@Value来实现注入值

只需要将我们上一节的Person.java更改为如下即可:

package com.example.springboot03.bean;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

/**
 * @Author: REN
 * @Description:
 * @Date: Created in 0:25 2018/8/22
 */

@Component
//@ConfigurationProperties(prefix = "person")
public class Person {
    @Value("${person.name}")
    private String name;
    @Value("#{2*18}")
    private Integer age;
    @Value("2018/08/24")
    private Date birth;
    private List<Object> list;
    private Map<String,Object> maps;
    @Value("${person.dog}")
    private Dog dog;

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

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

    public Date getBirth() {
        return birth;
    }

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

    public List<Object> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

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

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

    public Dog getDog() {
        return dog;
    }

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

然后,我们运行主函数,在浏览器输入:http://localhost:8081/person 即可看到:

这里写图片描述

错误提示:如果运行过程中报错:java.lang.IllegalStateException: Failed to load property source from location ‘classpath:/application.yml 就需要重新检查下配置文件是否书写正确。

是否支持松散绑定(Relaxed Binding)

对于Spring Boot来说,下面的四种写法在配置文件中其实是等价的:

spring:
  jpa:
    databaseplatform: mysql
    database-platform: mysql
    databasePlatform: mysql
    database_platform: mysql

例如:我们将上面Person.java中的

@Value("${person.name}") 

更改为

@Value("${person.Name}") 

启动发现报错:

org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'person': Injection of autowired dependencies failed; nested exception is java.lang.IllegalArgumentException: Could not resolve placeholder 'person.Name' in value "${person.Name}"

我们在application.yml的文件中,更改属性为:

server:
  port: 8081

---

person:
  Name: ren  ## 将之前的name更改为Name
  age: 18
  birth: 2018/08/22
  maps: {k1: v1,k2: v2}
  list:
    - hi
    - hello
  dog:
    name: rack
    age: 2

并使用@ConfigurationProperties的方式来注入值,我们发现绑定成功;

这里写图片描述

总结:@ConfigurationProperties支持松散绑定,@Value不支持松散绑定

是否支持SpEL语法

对于SpEL表达式有不懂的小伙伴,可以先查看:这篇博客

我们在使用@Value进行值注入时,使用了如下的代码:

@Value("#{2*18}")
private Integer age;

我们发现在运行过程中,Spring Boot成功的给我们算出了结果:

这里写图片描述

但是,在通过@ConfigurationProperties进行注入时,就无法进行计算。(可自行检验,这里就不再展示)

总结:@Value支持SpEL,但是@ConfigurationProperties不支持.需要注意的是:@Value(“#{}”)才用于SpEL表达式,通过@Value(“${}”) 用来获取对应属性文件中定义的属性值。

是否支持JSR303数据校验

JSR-303 是 JAVA EE 6 中的一项子规范,叫做 Bean Validation,用于对 Java Bean 中的字段的值进行验证。其的基本校验规则如下:

空检查
@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=)

我们在Person.java中更改如下代码:

@Component
@Validated  //增加@Validated 进行验证
@ConfigurationProperties(prefix = "person")  //使用@ConfigurationProperties来支持松散绑定
public class Person {

//     @Value("${person.name}")
//    @Value("${person.Name}")     将 @Value("${person.name}") 更改为@Value("${person.Name}")   发现@Value不支持松散绑定
    @Email //对name字段进行邮箱验证
    private String name;

//其余代码不变

启动程序,发现报错:

***************************
APPLICATION FAILED TO START
***************************

Description:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'person' to com.example.springboot03.bean.Person failed:

    Property: person.name
    Value: ren
    Origin: class path resource [application.yml]:7:9
    Reason: 不是一个合法的电子邮件 

如果我们使用@Value进行值注入,就会发现程序正常启动,则证明@Eamil注解未起作用。

总结: @ConfigurationProperties支持JSR303数据校验,@Value不支持。

是否支持复杂类型的封装

在上一篇博文中,我们使用@ConfigurationProperties进行值注入时,发现;Map、list、javaBean等类型均能顺利注入:

这里写图片描述

但是在@Value中却是无法进行注入的

总结:总结: @ConfigurationProperties支持复杂类型的封装注入,@Value不支持。

总结

我们将上面的讨论的情况,总结为下面的一张表:

@ConfigurationProperties @Value
适用场景 批量注入配置文件中的属性
松散绑定(松散语法) 支持
SpEL表达式 不支持
JSR303数据校验 支持
复杂类型封装 支持

@Value:我们只是在某个业务逻辑中需要获取一下配置文件中的某项值;
@ConfigurationProperties:如果说,我们专门编写了一个javaBean来和配置文件进行映射;

源码下载

点击下载

特别说明:

参考文献:

尚硅谷,SpringBoot核心技术篇

徐刘根,JSR 303 - Bean Validation 简介及使用方法

转载说明: 支持转载,但请保留原作者,原文链接,微信公众号二维码

这里写图片描述 扫码关注作者个人技术公众号,不定期将有学习资源分享

猜你喜欢

转载自blog.csdn.net/m0_37888031/article/details/82025749