Spring属性注解对配置项名称的自动转换

一、前言 

       在Spring中，我们经常需要将配置文件中的属性值注入到Java类中。Spring提供了两个主要的注解来实现这一功能：@Value 和 @ConfigurationProperties。其中 @ConfigurationProperties支持将配置项名称与Java类中的属性名进行自动转换，包括 '-' 和'驼峰命名'的转换；而@Value不支持。

二、@Value注解

@Value 注解用于将配置项的值注入到Java类的属性中。在使用 @Value 注解时，需要使用 ${} 表达式来引用配置项的名称，这个名称需要与配置项的完整名称完全匹配。@Value 注解不支持自动转换 - 和驼峰命名，因此必须保证配置项的名称与 @Value 注解中的表达式一致。例如：

# 配置项
my-config-property-name=Hello World

@Value("${my-config-property-name}")
private String myConfigPropertyName;

三、@ConfigurationProperties 注解

@ConfigurationProperties 注解用于将一组配置项的值注入到一个Java类中。与 @Value 注解不同，@ConfigurationProperties 注解支持将配置项名称的 - 转换为驼峰命名的属性名。通过在类上使用 @ConfigurationProperties(prefix = "prefixName") 注解，可以将具有相同前缀的配置项注入到Java类的对应属性中。例如：

my-config.property-name=Hello World

@ConfigurationProperties(prefix = "my-config")
public class MyConfigProperties {private String propertyName;// getter 和 setter 方法
}

在上述代码中，配置项 "my-config.property-name" 的值 "Hello World" 会被注入到 MyConfigProperties 类的 propertyName 属性中。

四、小结

• @Value 注解需要精确匹配配置项的名称，不支持自动转换 - 和驼峰命名。
• @ConfigurationProperties 注解支持将配置项名称的 - 转换为驼峰命名，提供了更灵活的配置项命名方式，可以通过 prefix 属性指定配置项的前缀。

正确使用 @Value 和 @ConfigurationProperties 注解可以提高配置项的灵活性和代码的可读性。根据实际的需求和习惯，选择适合的注解来处理配置项，让配置更加简洁明了。