springboot @Value 和 @ConfigurationProperties

最新推荐文章于 2023-03-12 10:39:04 发布
最新推荐文章于 2023-03-12 10:39:04 发布
阅读量591 收藏 1
点赞数
分类专栏： spring 文章标签： spring boot java
原文链接：https://segmentfault.com/a/1190000018536906
版权

此篇转载，下附原帖地址

https://segmentfault.com/a/1190000018536906

目录

如何使用

区别

松散语法

SpEL

JSR303 数据校验

复杂类型封装

怎么选用？

@Value()只能给普通变量注入值，不能直接给静态变量赋值

如何使用

定义两个对象，一个学生对象，对应着一个老师对象，代码如下：

  • @ConfigurationProperties
  1. 学生类
@Component
@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    private String firstName;

    private String lastName;

    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List<String> hobbys;

    private Map<String,Integer> scores;

    //注意，为了测试必须重写 toString 和 get，set 方法
}
  1. 老师类
public class Teacher {

    private String name;

    private Integer age;

    private String gender;

    //注意，为了测试必须重写 toString 和 get，set 方法
}
  1. 测试类
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootValConproDemoApplicationTests {

    @Autowired
    private Student student;

    @Test
    public void contextLoads() {
        // 这里为了方便，但工作中千万不能用 System.out
        System.out.println(student.toString());
    }
}
  1. 输出结果
Student{firstName='陈', lastName='一个优秀的废人', age=24, gender='男', city='广州', teacher=Teacher{name='eses', age=24, gender='女'}, hobbys=[篮球, 羽毛球, 兵兵球], scores={java=100, Python=99, C=99}}
  • @Value

@Value 支持三种取值方式，分别是 字面量、${key}从环境变量、配置文件中获取值以及 #{SpEL}

  1. 学生类
@Component
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    /**
     * <bean class="Student">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

    @Value("陈") // 字面量
    private String firstName;

    @Value("${student.lastName}") // 从环境变量、配置文件中获取值
    private String lastName;

    @Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List<String> hobbys;

    private Map<String,Integer> scores;

    //注意，为了测试必须重写 toString 和 get，set 方法
}
  1. 测试结果
Student{firstName='陈', lastName='一个优秀的废人', age=24, gender='null', city='null', teacher=null, hobbys=null, scores=null}

区别

二者区别@ConfigurationProperties@Value
功能批量注入配置文件中的属性一个个指定
松散绑定（松散语法）支持不支持
SpEL不支持支持
JSR303数据校验支持不支持
复杂类型封装支持不支持

从上表可以看见，@ConfigurationProperties 和 @Value 主要有 5 个不同，其中第一个功能上的不同，上面已经演示过。下面我来介绍下剩下的 4 个不同。

松散语法

松散语法的意思就是一个属性在配置文件中可以有多个属性名，举个栗子：学生类当中的 firstName 属性，在配置文件中可以叫 firstName、first-name、first_name 以及 FIRST_NAME。 而 @ConfigurationProperties 是支持这种命名的，@Value 不支持。下面以 firstName 为例，测试一下。如下代码：

  • @ConfigurationProperties

学生类的 firstName 属性在 yml 文件中被定义为 first_name：

student:
  first_name: 陈  # 学生类的 firstName 属性在 yml 文件中被定义为 first_name
  lastName: 一个优秀的废人
  age: 24
  gender: 男
  city: 广州
  teacher: {name: eses,age: 24,gender: 女}
  hobbys: [篮球,羽毛球,兵兵球]
  scores: {java: 100,Python: 99,C++: 99}

学生类：

@Component
@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    /**
     * <bean class="Student">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

    //@Value("陈") // 字面量
    private String firstName;

    //@Value("${student.lastName}") // 从环境变量、配置文件中获取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List<String> hobbys;

    private Map<String,Integer> scores;

    //注意，为了测试必须重写 toString 和 get，set 方法
}

测试结果：

Student{firstName='陈', lastName='一个优秀的废人', age=24, gender='男', city='广州', teacher=Teacher{name='eses', age=24, gender='女'}, hobbys=[篮球, 羽毛球, 兵兵球], scores={java=100, Python=99, C=99}}
  • @Value

学生类：

@Component
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    /**
     * <bean class="Student">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

    //@Value("陈") // 字面量
    @Value("${student.firstName}")
    private String firstName;

    //@Value("${student.lastName}") // 从环境变量、配置文件中获取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List<String> hobbys;

    private Map<String,Integer> scores;
    
   //注意，为了测试必须重写 toString 和 get，set 方法
}

测试结果：启动报错，找不到 bean。

从上面两个测试结果可以看出，使用 @ConfigurationProperties 注解时，yml 中的属性名为 last_name 而学生类中的属性为 lastName 但依然能取到值，而使用 @value 时，使用 lastName 确报错了。证明 @ConfigurationProperties 支持松散语法，@value 不支持。

SpEL

SpEL 使用 #{...} 作为定界符 , 所有在大括号中的字符都将被认为是 SpEL , SpEL 为 bean 的属性进行动态赋值提供了便利。

  • @Value

如上述介绍 @Value 注解使用方法时，有这样一段代码：

@Value("#{12*2}") // #{SpEL}
private Integer age;

证明 @Value 是支持 SpEL 表达式的。

  • @ConfigurationProperties

由于 yml 中的 # 被当成注释看不到效果。所以我们新建一个 application.properties 文件。把 yml 文件内容注释，我们在 properties 文件中把 age 属性写成如下所示：

student.age=#{12*2}

把学生类中的 @ConfigurationProperties 注释打开，注释 @value 注解。运行报错， age 属性匹配异常。

说明 @ConfigurationProperties 不支持 SpEL

JSR303 数据校验

  • @Value

加入 @Length 校验：

@Component
@Validated
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    /**
     * <bean class="Student">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

    //@Value("陈") // 字面量
    @Value("${student.first-name}")
    @Length(min=5, max=20, message="用户名长度必须在5-20之间")
    private String firstName;

    //@Value("${student.lastName}") // 从环境变量、配置文件中获取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List<String> hobbys;

    private Map<String,Integer> scores;
}

yaml：

student:
  first_name: 陈

测试结果：

Student{firstName='陈', lastName='null', age=null, gender='null', city='null', teacher=null, hobbys=null, scores=null}

yaml 中的 firstname 长度为 1 。而检验规则规定 5-20 依然能取到属性，说明检验不生效，@Value 不支持 JSR303 数据校验

  • @ConfigurationProperties

学生类：

@Component
@Validated
@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    /**
     * <bean class="Student">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

    //@Value("陈") // 字面量
    //@Value("${student.first-name}")
    @Length(min=5, max=20, message="用户名长度必须在5-20之间")
    private String firstName;

    //@Value("${student.lastName}") // 从环境变量、配置文件中获取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    private Teacher teacher;

    private List<String> hobbys;

    private Map<String,Integer> scores;
}

测试结果：报错

[firstName],20,5]; default message [用户名长度必须在5-20之间]

校验生效，支持 JSR303 数据校验。

复杂类型封装

复杂类型封装指的是，在对象以及 map （如学生类中的老师类以及 scores map）等属性中，用 @Value 取是取不到值，比如：

@Component
//@Validated
//@ConfigurationProperties(prefix = "student") // 指定配置文件中的 student 属性与这个 bean绑定
public class Student {

    /**
     * <bean class="Student">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

    //@Value("陈") // 字面量
    //@Value("${student.first-name}")
    //@Length(min=5, max=20, message="用户名长度必须在5-20之间")
    private String firstName;

    //@Value("${student.lastName}") // 从环境变量、配置文件中获取值
    private String lastName;

    //@Value("#{12*2}") // #{SpEL}
    private Integer age;

    private String gender;

    private String city;

    @Value("${student.teacher}")
    private Teacher teacher;

    private List<String> hobbys;

    @Value("${student.scores}")
    private Map<String,Integer> scores;
}

这样取是报错的。而上文介绍 @ConfigurationProperties 和 @Value 的使用方法时已经证实 @ConfigurationProperties 是支持复杂类型封装的。也就是说 yaml 中直接定义 teacher 以及 scores 。 @ConfigurationProperties 依然能取到值。

怎么选用？

  • 如果说，只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用 @Value；比如，假设现在学生类加多一个属性叫 school 那这个属性对于该校所有学生来说都是一样的，但防止我这套系统到了别的学校就用不了了。那我们可以直接在 yml 中给定 school 属性，用 @Value 获取。当然上述只是举个粗暴的例子，实际开发时，school 属性应该是保存在数据库中的。
  • 如果说，专门编写了一个 javaBean 来和配置文件进行映射，我们就直接使用 @ConfigurationProperties。

@Value()只能给普通变量注入值，不能直接给静态变量赋值

SpringBoot中使用@Value()只能给普通变量注入值，不能直接给静态变量赋值
例如，application-dev.properties 配置文件有如下配置：

给普通变量赋值时，直接在变量声明之上添加@Value()注解即可，如下所示：


当要给静态变量注入值的时候，若是在静态变量声明之上直接添加@Value()注解是无效的，例如：


虽然没有编译和运行上的报错，经调试可知这种注解方式mailUsername、mailPassword、mailHost的值都是null，也就是说直接给静态变量读取配置文件是无效的，如下所示：

若要给静态变量赋值，可以使用set()方法，其中需要在类上加入@Component注解，方法名（例如setMailUsername）和参数名（例如username）可以任意命名，如下所示：


调试结果如下：


————————————————
版权声明：本文为CSDN博主「「已注销」」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/mononoke111/article/details/81088472

不卷毛
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
[SpringBoot] @Value 与 @ConfigurationProperties 对比
沫洺的博客
10-22 456
@Value 与 @ConfigurationProperties 的区别
SpringBoot获取yml和properties配置文件的内容
08-30
总的来说，Spring Boot通过`@ConfigurationProperties`和`@Component`注解使得从`properties`或`yml`配置文件中获取和使用配置变得非常简单。开发者只需创建一个Java类，声明属性，并让Spring Boot自动绑定配置，...
SpringBoot @Value与@ConfigurationProperties比较
书唐瑞的博客
10-22 216
SpringBoot - @Value & @ConfigurationProperties
牧码的博客
04-07 375
在application.properties（全局配置文件中）中，有一下属性。 person.lastName=张三 person.age=22 person.birth=2018/2/13 person.boss=false person.lists=a,b,b person.maps.k1=4 person.maps.k2=45 person.dog.name=dog person.d...
springBoot中的配置绑定(@Value和@ConfigurationProperties)
林莫扬
03-29 1143
1. 复杂类型封装 @ConfigurationProperties：支持所有类型数据的封装，例如 Map、List、Set、以及对象等； @Value：只支持基本数据类型的封装，例如字符串、布尔值、整数等类型。 2、应用场景不同 @Value 和 @ConfigurationProperties 两个注解之间，并没有明显的优劣之分，它们只是适合的应用场景不同而已。 若只是获取配置文件中的某项值，则推荐使用 @Value 注解； 若专门编写了一个 JavaBean 来和配置文件进行映射，则建议使用 @Con
SpringBoot (六) 整合配置文件 @Value、ConfigurationProperties
有勇气的牛排博客
03-04 696
在这些情况下，推荐使用@EnableConfigurationProperties注解指定要处理的类型列表（即：将@ConfigurationProperties注释的类加到Spring IOC容器中）。加载配置通过 BeanPostProcessor实现，其对应的Bean的后置处理器为 ConfigurationPropertiesBindingPostProcessor，也就是在bean被实例化后，会调用后置处理器，递归的查找属性，通过反射机制注入值，因此需要提供getter和setter方法。
SpringBoot @ConfigurationProperties使用详解
08-25
【SpringBoot @ConfigurationProperties 使用详解】 在Spring Boot中，`@ConfigurationProperties`是用于将配置文件中的属性绑定到Java Bean的注解，极大地简化了属性的管理，使得配置更加灵活和类型安全。以下是对...
Spring Boot技术知识点：如何理解@Value注解
06-20
2. 对于复杂对象的注入，推荐使用`@ConfigurationProperties`，它提供了更强的类型安全性和绑定能力。 以上就是关于Spring Boot中`@Value`注解的基本介绍及其应用。通过合理使用，`@Value`能帮助我们方便地管理配置...
Spring Boot2.0 @ConfigurationProperties使用详解
08-26
第二种方式是使用 {@Value} 注解单个属性。第三种方式是使用 {@ConfigurationProperties} 注解整个配置类。 {@ConfigurationProperties} 是 Spring Boot 2.0 中的一个非常有用的功能，能够简化外部化配置方式的使用...
Spring Boot 技术知识点：如何理解@PropertySource注解
06-20
如果文件类型是YAML（`.yml`），我们需要使用`@PropertySources`（注意是复数形式）和`@ConfigurationProperties`来处理YAML格式的属性。 接下来，我们可以通过`@Value`注解将这些属性值注入到字段或方法参数中： ...
@ConfigurationProperties()与@Value
天真吖的博客
03-12 223
3.@EnableConfigurationProperties(ConnectionProperties.class)：让使用了 @ConfigurationProperties 注解的类生效, 并且将该类注入到 IOC 容器中,交由 IOC 容器进行管理。2.@ConfigurationProperties("yc.conn"):将配置文件中的yc.conn属性与加了这个注解的Bean的属性绑定。5.@Value:写在属性上，读取配置文件到属性上，用于配置项少的情况。
Springboot @Value和@ConfigurationProperties区别
JPA_soul的博客
07-26 186
@Value和@ConfigurationProperties区别
Spring Boot @ConfigurationProperties 与 @Value
thlzjfefe的博客
07-04 433
@ConfigurationProperties 和 @Value 都是 Spring 提供的用于从配置文件注入配置信息的方式。很显然，@Value 比较适用于配置比较少的场景，而 @ConfigurationProperties 则更适用于有很多配置的情况。之前写项目的时候从来都没有使用过 @ConfigurationProperties 几乎每次都是使用 @Value。这次遇到了一个比较适合它的场景，在使用的时候还真遇到了一些令人讨厌的小问题，导致开发速度受到了一定的影响。这里记录下来他们之间的使用方式
Caffe + windows + python3.5安装
Emmahuu424的博客
10-10 508
https://www.codenong.com/cs105224658/ caffe目前只支持python2.7和python3.5，不支持更高版本
@ConfigurationProperties与@value笔记
qq_36608921的博客
05-07 1553
1、@ConfigurationProperties(prefix="") 通过prefix前置匹配，将配置文件中的配置项绑定到某一个类的所有属性中； 需要配合@EnableConfigurationProperties或者@import或者@Component等才会生效； 2、@value 是将配置文件中某一个配置绑定到一个属性上； 3、@ConfigurationProperties(prefix="") 与@value 一起使用时，会出现两种情况，如下： @Configur...
springboot使用 @ConfigurationProperties或 @Value配置绑定
qq_43560721的博客
08-30 473
@ConfigurationProperties 1.标注在 JavaBean 的类名上； 2.用于批量绑定配置文件中的配置； 3.支持所有类型数据的封装，例如 Map、List、Set、以及对象等； 4.支持松散绑定（松散语法）。 配置文件配置参数 person.name=xxs person.age=18 person.dog.name=TaiDi person.dog.age= 5 实体 （ @ConfigurationProperties：告诉 SpringBoot 将本类中
SpringBoot @ConfigurationProperties参数绑定 详解
热门推荐
chenshun123的博客
05-09 1万+
1&gt; 引入 spring-boot-configuration-processor 库&lt;dependency&gt;    &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;    &lt;artifactId&gt;spring-boot-configuration-processor&lt;/artifactId&gt; ...
spring boot 配置文件（application.yml）中的属性值配置
无名剑
08-08 927
<!-- 支持 @ConfigurationProperties 注解 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optiona
003---SpringBoot 自定义配置--注解@Value和@ConfigurationProperties的使用案例详解
Allure泽宇的博客
04-25 699
1.Spring Boot 自定义配置 在 SpringBoot 的核心配置文件中，除了使用内置的配置项之外，我们还可以在自定义配置，然后采用如下注解去读取配置的属性值 2. @Value注解 作用：用于逐个读取 application.properties 中的配置 2.1 创建module 006-springboot-custom-configuration 2.2 在核心配置文件中自定义内容 2.3 在Controller类中获取自定义配置信息 在 SpringBootControll
springboot @ConfigurationProperties(prefix = ) @Value
最新发布
07-27
Spring Boot中的@ConfigurationProperties注解和@Value注解都是用于读取配置文件中的属性值。 @ConfigurationProperties注解用于将配置文件中的属性值映射到一个Java对象中。通过指定prefix参数，可以指定要映射的属性的前缀。例如： ```java @ConfigurationProperties(prefix = "myapp") public class MyAppProperties { private String name; private int age; // getters and setters } ``` 在上面的例子中，配置文件中的属性名必须以"myapp"作为前缀，如"myapp.name"和"myapp.age"。然后，通过将@ConfigurationProperties注解应用在一个类上，将会自动将配置文件中的属性值映射到该类的对应字段上。 @Value注解则是一种更为简单的方式，用于直接将配置文件中的属性值注入到一个字段或方法参数中。例如： ```java @Value("${myapp.name}") private String name; @Value("${myapp.age}") private int age; ``` 在上面的例子中，通过使用@Value注解，可以直接将配置文件中的"myapp.name"和"myapp.age"属性值注入到对应的字段上。 总的来说，@ConfigurationProperties注解更适合用于将多个属性值映射到一个Java对象中，而@Value注解则更适合用于单个属性值的注入。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值