解读@ConfigurationProperties和@value的区别

2025-05-23 15:50

本文主要是介绍解读@ConfigurationProperties和@value的区别,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《解读@ConfigurationProperties和@value的区别》:本文主要介绍@ConfigurationProperties和@value的区别及说明,具有很好的参考价值,希望对大家...

在 Spring Boot 中,@ConfigurationProperties@Value 都是用于注入配置值的注解,但它们的设计目标、使用场景和功能有显著差异。

以下是它们的核心区别和适用场景:

1. 功能对比

特性@ConfigurationProperties@Value
作用范围批量绑定配置文件中的 一组相关属性 到 Bean 的字段。注入 单个属性值 到字段或参数。
松散绑定支持松散绑定(如 myProp、my-prop、MY_PROP)。不支持,属性名必须严格匹配。
类型安全基于 类型安全的配置绑定(字段类型自动转换)。需要手动处理类型转换,如 @Value("${port}") int port。
SpEL 表达式不支持 SpEL 表达式。支持 SpEL 表达式(如 @Value("#{systemProperties['user']}"))。
默认值通过字段初始化设置默认值(如 private String name = "default";)。可在占位符中指定默认值(如 @Value("${name:default}"))。
验证支持支持 jsR-30www.chinasem.cn3 验证(如 @NotNull、@Size)。不支持 验证注解。
复杂对象绑定支持嵌套对象、集合、Map 等复杂结构的绑定。仅支持简单类型(需手动拆分复杂结构)。

2. 使用场景对比

@ConfigurationProperties

适用场景

  • 需要将 一组相关的配置属性 绑定到一个对象(如数据库配置、第三方服务配置)。
  • 需要类型安全、自动转换和松散绑定。
  • 需要支持嵌套对象或集合类型(如 ListMap)。

示例一

  // 配置类定义
  @Component
  @ConfigurationProperties(prefix = "app.datasource")
  public class DataSourceConfig {
      private String url;
      private String username;
http://www.chinasem.cn      private int maxPoolSize;
      // GeChina编程tters and Setters
  }
  
// 业务类调用
@Service
public class DataSourceSeChina编程rvice {
    @Autowired
    private DataSourceConfig dataConfig; // 直接注入配置对象

    public void connect() {
        System.out.println("Connecting to: " + dataConfig.getUrl() + ":" + dataConfig.getUsername());
    }
}

对应 application.properties

 # application.properties
 app.datasource.url=jdbc:mysql://localhost:3306/db
 app.datasource.username=power
 app.datasource.max-pool-size=10

对应 application.yml:

app:
  datasource:
    url: jdbc:mysql://localhost:3306/db
    username: power
   maxPoolSize: 10

示例二

  • 通过 @EnableConfigurationProperties 显式启用‌

‌步骤‌:

  • 在配置类或主启动类上使用 @EnableConfigurationProperties 注解,手动注册配置类14。
  • 通过构造函数或 @Autowired 注入配置对象。

‌代码示例‌:

/ 配置类定义(无需 @Component)
@ConfigurationProperties(prefix = "app.mail")
public class MailConfig {
    private String host;
    private int port;
    // getter/setter
}

// 主启动类显式启用
@SpringBootApplication
@EnableConfigurationProperties(MailConfig.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

// 业务类调用(构造器注入)
@Service
public class MailService {
    private final MailConfig mailConfig;

    public MailService(MailConfig mailConfig) {
        this.mailConfig = mailConfig;
    }
}

@Value

适用场景

  • 注入 单个简单值(如开关标志、端口号)。
  • 需要动态计算值(使用 SpEL 表达式)。
  • 临时调试或快速原型开发。

示例

@Component
public class MyService {
    @Value("${app.feature.enabled:false}")
    private boolean featureEnabled;

    @Value("#{systemProperties['user.timezone']}")
    private String timezone;
}

3. 核心区别详解

(1) 类型安全与松散绑定

@ConfigurationProperties

  • 自动将配置文件中的属性转换为字段类型(如 StringintList)。
  • 支持松散绑定(属性名不严格匹配),例如 myPropmy-propMY_PROP 都会匹配到字段 myProp

@Value

  • 需要手动处理类型转换(如 @Value("${port}") int port)。
  • 属性名必须严格匹配,否则注入失败。

(2) 复杂对象支持

@ConfigurationProperties

支持嵌套对象和集合:

app:
  servers:
    - name: server1
      ip: 192.168.1.1
    - name: server2
      ip: 192.168.1.2
@ConfigurationProperties(prefix = "app编程China编程")
public class AppConfig {
    private List<Server> servers;
    // Getters and Setters
}

@Value

需要手动拆分复杂结构:

@Value("${app.servers[0].name}")
private String server1Name;

(3) 验证与默认值

@ConfigurationProperties

结合 @Validated 实现字段验证:

@ConfigurationProperties(prefix = "app")
@Validated
public class AppConfig {
    @NotNull
    private String name;
    @Min(1)
    private int maxConnections;
}

@Value

直接在占位符中设置默认值:

@Value("${app.name:DefaultApp}")
private String appName;

4. 如何选择?

场景推荐注解
需要绑定一组相关配置@ConfigurationProperties
需要注入单个简单值@Value
需要支持松散绑定或复杂结构@ConfigurationProperties
需要使用 SpEL 动态计算值@Value
需要类型安全与 JSR-303 验证@ConfigurationProperties

总结

@ConfigurationProperties

适合 集中管理复杂配置,提供类型安全、松散绑定和验证支持,是 Spring Boot 推荐的配置注入方式。

@Value

适合 快速注入简单值或动态计算值,灵活性高但缺乏类型安全和批量绑定能力。

根据实际需求选择合适的注解,优先使用 @ConfigurationProperties 以提高代码的可维护性和健壮性。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持China编程(www.chinasem.cn)。

这篇关于解读@ConfigurationProperties和@value的区别的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154752

相关文章

Jupyter notebook安装步骤解读

《Jupyternotebook安装步骤解读》:本文主要介绍Jupyternotebook安装步骤,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、开始安装二、更改打开文件位置和快捷启动方式总结在安装Jupyter notebook 之前,确认您已安装pytho

Spring Boot拦截器Interceptor与过滤器Filter深度解析(区别、实现与实战指南)

《SpringBoot拦截器Interceptor与过滤器Filter深度解析(区别、实现与实战指南)》:本文主要介绍SpringBoot拦截器Interceptor与过滤器Filter深度解析... 目录Spring Boot拦截器(Interceptor)与过滤器(Filter)深度解析:区别、实现与实

Java中的StringUtils.isBlank()方法解读

《Java中的StringUtils.isBlank()方法解读》:本文主要介绍Java中的StringUtils.isBlank()方法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录所在库及依赖引入方法签名方法功能示例代码代码解释与其他方法的对比总结StringUtils.isBl

对Django中时区的解读

《对Django中时区的解读》:本文主要介绍对Django中时区的解读方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录背景前端数据库中存储接口返回AI的解释问题:这样设置的作用答案获取当前时间(自动带时区)转换为北京时间显示总结背景设置时区为北京时间 TIM

关于Mybatis和JDBC的使用及区别

《关于Mybatis和JDBC的使用及区别》:本文主要介绍关于Mybatis和JDBC的使用及区别,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1、JDBC1.1、流程1.2、优缺点2、MyBATis2.1、执行流程2.2、使用2.3、实现方式1、XML配置文件

Java中的内部类和常用类用法解读

《Java中的内部类和常用类用法解读》:本文主要介绍Java中的内部类和常用类用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录内部类和常用类内部类成员内部类静态内部类局部内部类匿名内部类常用类Object类包装类String类StringBuffer和Stri

exfat和ntfs哪个好? U盘格式化选择NTFS与exFAT的详细区别对比

《exfat和ntfs哪个好?U盘格式化选择NTFS与exFAT的详细区别对比》exFAT和NTFS是两种常见的文件系统,它们各自具有独特的优势和适用场景,以下是关于exFAT和NTFS的详细对比... 无论你是刚入手了内置 SSD 还是便携式移动硬盘或 U 盘,都需要先将它格式化成电脑或设备能够识别的「文

什么是ReFS 文件系统? ntfs和refs的优缺点区别介绍

《什么是ReFS文件系统?ntfs和refs的优缺点区别介绍》最近有用户在Win11Insider的安装界面中发现,可以使用ReFS来格式化硬盘,这是不是意味着,ReFS有望在未来成为W... 数十年以来,Windows 系统一直将 NTFS 作为「内置硬盘」的默认文件系统。不过近些年来,微软还在研发一款名

JVM垃圾回收机制之GC解读

《JVM垃圾回收机制之GC解读》:本文主要介绍JVM垃圾回收机制之GC,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、死亡对象的判断算法1.1 引用计数算法1.2 可达性分析算法二、垃圾回收算法2.1 标记-清除算法2.2 复制算法2.3 标记-整理算法2.4

SpringBoot中配置文件的加载顺序解读

《SpringBoot中配置文件的加载顺序解读》:本文主要介绍SpringBoot中配置文件的加载顺序,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录SpringBoot配置文件的加载顺序1、命令⾏参数2、Java系统属性3、操作系统环境变量5、项目【外部】的ap