解读@ConfigurationProperties和@value的区别

 更新时间:2025年05月23日 11:12:17   作者:codingPower  
这篇文章主要介绍了@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-303 验证(如 @NotNull、@Size)。不支持 验证注解。
复杂对象绑定支持嵌套对象、集合、Map 等复杂结构的绑定。仅支持简单类型(需手动拆分复杂结构)。

2. 使用场景对比

@ConfigurationProperties

适用场景

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

示例一

  // 配置类定义
  @Component
  @ConfigurationProperties(prefix = "app.datasource")
  public class DataSourceConfig {
      private String url;
      private String username;
      private int maxPoolSize;
      // Getters and Setters
  }
  
// 业务类调用
@Service
public class DataSourceService {
    @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")
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 以提高代码的可维护性和健壮性。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 利用Java中Calendar计算两个日期之间的天数和周数

    利用Java中Calendar计算两个日期之间的天数和周数

    Java 语言的Calendar(日历),Date(日期),和DateFormat(日期格式)组成了Java标准的一个基本但是非常重要的部分。日期是商业逻辑计算一个关键的部分。下面这篇文章就给大家介绍了如何利用Java中Calendar计算两个日期之间的天数和周数,下面来一起看看吧。
    2016-12-12
  • Java Robot应用示例之机器人功能

    Java Robot应用示例之机器人功能

    这篇文章主要为大家详细介绍了Java Robot应用示例之机器人功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • k8s部署java项目的实现

    k8s部署java项目的实现

    本文主要介绍了k8s部署java项目的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • Java中实现多线程关键词整理(总结)

    Java中实现多线程关键词整理(总结)

    这篇文章主要介绍了Java中实现多线程关键词整理,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2017-05-05
  • Struts2返回json格式数据代码实例

    Struts2返回json格式数据代码实例

    这篇文章主要介绍了Struts2返回json格式数据代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Java在高并发场景下实现点赞计数器

    Java在高并发场景下实现点赞计数器

    点赞计数器的本质就是对某个变量在高并发情况下的修改,这篇文章主要为大家介绍了Java实现点赞计数器的示例代码,感兴趣的小伙伴可以了解一下
    2023-06-06
  • Java Stream流从入门到精通(最新整理)

    Java Stream流从入门到精通(最新整理)

    Java Stream 是一个来自 java.util.stream 包的抽象概念,它允许你以声明方式处理数据集合(例如 List、Set 等),本文给大家介绍Java Stream流从入门到精通,感兴趣的朋友跟随小编一起看看吧
    2025-09-09
  • Spring外部化配置的几种技巧分享

    Spring外部化配置的几种技巧分享

    在油管上看了龙之春的一个Spring tips 视频,讲述Spring外部化配置的几种技巧,收获颇多,想拿出来给大家分享下。对spring感兴趣的朋友可以了解下本文
    2021-06-06
  • javaWeb 四大域对象详细介绍

    javaWeb 四大域对象详细介绍

    这篇文章主要介绍了javaWeb 四大域对象详细介绍的相关资料,需要的朋友可以参考下
    2016-11-11
  • 使用SpringBoot自定义starter的完整步骤

    使用SpringBoot自定义starter的完整步骤

    这篇文章主要给大家介绍了关于使用SpringBoot自定义starter的完整步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10

最新评论