SpringBoot之@ConfigurationProperties和@Value用法详解

---

介绍

在开发中会有一些固定的配置信息放到配置文件（例如application.yml中），而在代码中去提取使用除了有@Value还有@ConfigurationProperties，它们是springboot提供读取配置文件的一个注解。

拿取配置文件参数的方式

使用@ConfigurationProperties和@Value 2个注解

@ConfigurationProperties和@Value区别

• @ConfigurationProperties注解支持属性文件和javabean的映射
• @Value支持spel表达式

使用场景

• 如果是多个属性映射，而且常常被复用，推荐使用@ConfigurationProperties
• 如果只读取单个属性则使用@Value要方便许多

---

最常用的实例

这里是测试用的application.yml中的部分配置

# 项目相关配置
demo:
  # 名称
  name: demo平台
  # 版本
  version: 1.0.0
  # 版权年份
  copyrightYear: 2022
  # 实例演示开关
  demoEnabled: true
  # 获取ip地址开关
  addressEnabled: true
  # 验证码类型 math 数组计算 char 字符验证
  captchaType: math
1
2
3
4
5
6
7
8
9
10
11
12
13
14

一、@ConfigurationProperties

想要取到对应的参数只需要在类上配置@ConfigurationProperties(prefix = “要取的配置内容”)，@Component表示标注这个类，注入到Spring容器中，可以调用这个类，@Data是提供get set方法

/**
 * 读取项目相关配置
 * 
 * @author 杨永卓
 */
@Data 
@Component
@ConfigurationProperties(prefix = "demo")
public class DemoConfig {
    /** 项目名称 */
    private String name;

    /** 版本 */
    private String version;

    /** 版权年份 */
    private String copyrightYear;

    /** 实例演示开关 */
    private boolean demoEnabled;

    /** 上传路径 */
    private static String profile;

    /** 获取地址开关 */
    private static boolean addressEnabled;

    /** 验证码类型 */
    private static String captchaType;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

调用的时候只用类名.属性名调用即可

DemoConfig.getProfile();
1

二、@Value

在属性上方使用@value注入属性

@Value("${demo.name}")  
 private String name; 
1
2

@Value(“#{}”)与@Value(“${}”)的区别

• @Value(“#{}”) 表示SpEl表达式通常用来获取bean的属性，或者调用bean的某个方法。当然还有可以表示常量
• @Value(“${}”)从配置properties文件中读取属性的值

---

仰天大笑出门去，我辈岂是蓬蒿人