java

关注公众号 jb51net

关闭
首页 > 软件编程 > java > @ConfigurationProperties和@value的区别

解读@ConfigurationProperties和@value的区别

作者：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

适用场景：

示例一：

  // 配置类定义
  @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

示例二：

‌步骤‌：

‌代码示例‌：

/ 配置类定义（无需 @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

适用场景：

示例：

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

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

3. 核心区别详解

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

@ConfigurationProperties：

@Value：

(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 以提高代码的可维护性和健壮性。

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

您可能感兴趣的文章:
阅读全文