解读@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

相关文章

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.

MySQL中VARCHAR和TEXT的区别小结

《MySQL中VARCHAR和TEXT的区别小结》MySQL中VARCHAR和TEXT用于存储字符串,VARCHAR可变长度存储在行内,适合短文本;TEXT存储在溢出页,适合大文本,下面就来具体的了解... 目录一、VARCHAR 和 TEXT 基本介绍1. VARCHAR2. TEXT二、VARCHAR

MySQL之搜索引擎使用解读

《MySQL之搜索引擎使用解读》MySQL存储引擎是数据存储和管理的核心组件,不同引擎(如InnoDB、MyISAM)采用不同机制,InnoDB支持事务与行锁,适合高并发场景;MyISAM不支持事务,... 目录mysql的存储引擎是什么MySQL存储引擎的功能MySQL的存储引擎的分类查看存储引擎1.命令

Spring的基础事务注解@Transactional作用解读

《Spring的基础事务注解@Transactional作用解读》文章介绍了Spring框架中的事务管理,核心注解@Transactional用于声明事务,支持传播机制、隔离级别等配置,结合@Tran... 目录一、事务管理基础1.1 Spring事务的核心注解1.2 注解属性详解1.3 实现原理二、事务事

Linux五种IO模型的使用解读

《Linux五种IO模型的使用解读》文章系统解析了Linux的五种IO模型(阻塞、非阻塞、IO复用、信号驱动、异步),重点区分同步与异步IO的本质差异,强调同步由用户发起,异步由内核触发,通过对比各模... 目录1.IO模型简介2.五种IO模型2.1 IO模型分析方法2.2 阻塞IO2.3 非阻塞IO2.4

Redis高性能Key-Value存储与缓存利器常见解决方案

《Redis高性能Key-Value存储与缓存利器常见解决方案》Redis是高性能内存Key-Value存储系统,支持丰富数据类型与持久化方案(RDB/AOF),本文给大家介绍Redis高性能Key-... 目录Redis:高性能Key-Value存储与缓存利器什么是Redis?为什么选择Redis?Red

MySQL8.0临时表空间的使用及解读

《MySQL8.0临时表空间的使用及解读》MySQL8.0+引入会话级(temp_N.ibt)和全局(ibtmp1)InnoDB临时表空间,用于存储临时数据及事务日志,自动创建与回收,重启释放,管理高... 目录一、核心概念:为什么需要“临时表空间”?二、InnoDB 临时表空间的两种类型1. 会话级临时表

python中getsizeof和asizeof的区别小结

《python中getsizeof和asizeof的区别小结》本文详细的介绍了getsizeof和asizeof的区别,这两个函数都用于获取对象的内存占用大小,它们来自不同的库,下面就来详细的介绍一下... 目录sys.getsizeof (python 内置)pympler.asizeof.asizeof

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php

Vue和React受控组件的区别小结

《Vue和React受控组件的区别小结》本文主要介绍了Vue和React受控组件的区别小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录背景React 的实现vue3 的实现写法一:直接修改事件参数写法二:通过ref引用 DOMVu