当前位置：首页 > news >正文

ConfigurationProperties和PropertySource两个注解的区别。

news 来源：原创 2025/5/25 4:32:31

在Spring框架中，@ConfigurationProperties和@PropertySource是两个功能不同但常结合使用的注解，主要区别如下：

1. 核心职责

注解	核心职责
`@PropertySource`	定义属性来源：指定外部配置文件（如`.properties`或`.yml`），将其内容加载到Spring的`Environment`中。
`@ConfigurationProperties`	属性绑定：将`Environment`中的属性批量绑定到Java对象的字段，支持类型安全和松散绑定。

2. 使用场景

`@PropertySource`

适用场景：需要引入非默认配置文件（如custom.properties）。

示例：

@Configuration
@PropertySource("classpath:custom.properties") // 加载自定义配置文件
public class AppConfig { ... }

特点：
- 默认支持.properties文件，若需加载YAML需额外配置。
- 多个@PropertySource可叠加使用，按声明顺序加载（后加载的属性可能覆盖前者）。

`@ConfigurationProperties`

适用场景：将一组相关属性（如数据库配置）映射到Java对象，避免逐个使用@Value。

示例：

@Component
@ConfigurationProperties(prefix = "database") // 绑定前缀为"database"的属性
public class DatabaseConfig {
    private String url;
    private String username;
    // getters/setters...
}

特点：
- 支持类型转换（如字符串"8080"转整型int）。
- 需配合@EnableConfigurationProperties或在配置类中声明为Bean。

3. 协同工作流程

加载属性：通过@PropertySource将custom.properties中的属性注入Environment。
绑定属性：@ConfigurationProperties从Environment中提取匹配前缀的属性，填充到Java对象。

# custom.properties
database.url=jdbc:mysql://localhost:3306/mydb
database.username=root

@Configuration
@PropertySource("classpath:custom.properties")
@EnableConfigurationProperties(DatabaseConfig.class)
public class AppConfig { ... }

4. 关键区别总结

特性	`@PropertySource`	`@ConfigurationProperties`
作用目标	类（配置类）	类（配置类或Bean）
主要功能	加载外部属性到`Environment`	将`Environment`中的属性绑定到Java对象
属性覆盖	支持多文件，后者覆盖前者	依赖`Environment`中最终生效的属性值
类型安全	无（需手动处理类型转换）	有（自动类型转换）
松散绑定支持	无	支持（如`kebab-case`转`camelCase`）

5. 常见误区

@ConfigurationProperties依赖@PropertySource？
不一定。只要属性存在于Environment（如默认application.properties或通过其他方式加载），即可直接绑定。
@PropertySource只能加载.properties文件？
默认是，但可通过自定义PropertySourceFactory实现加载YAML等格式。