@ConfigurationProperties
和 @Value
是 Spring Framework 中用于从配置文件中读取属性值的两个常用注解。其作用是将配置文件中的属性值绑定到 Java 类的属性上,以便在应用程序中使用。
1、@ConfigurationProperties:
@ConfigurationProperties
注解可以用于将配置文件中的属性值绑定到一个 Java 类中的属性上,通常是一个用于存储配置信息的 POJO类。这个注解在整个类中的属性上有效,而且适用于复杂的配置结构。
示例:
//添加get和set方法
@Data
//标记为bean
@Component
@ConfigurationProperties(prefix = "aliyun.oss")
public class AliOSSproperties {
private String endpoint;
private String accessKeyId;
private String accessKeySecret;
private String bucketName;
}
以上示例中,prefix
属性用于指定在YAML配置文件中的key的前缀,以从配置文件中读取属性值并绑定到Java对象的属性上。其中属性名需完全相同。
2、@Value:
@Value
注解用于将单个属性值绑定到一个 Java 类的属性上。这个注解通常用于简单的属性读取。
示例:
@Component
public class AliOSSUtils {
@Value("${aliyun.oss.endpoint}")
private String endpoint;
@Value("${aliyun.oss.accessKeyId}")
private String accessKeyId;
@Value("${aliyun.oss.accessKeySecret}")
private String accessKeySecret;
@Value("${aliyun.oss.bucketName}")
private String bucketName;
}
以上示例中,@Value
注解将 ${aliyun.oss.endpoint}、${aliyun.oss.accessKeyId}、${aliyun.oss.accessKeySecret}和${aliyun.oss.bucketName}这四个属性的值分别绑定到对应的属性上。
3、主要区别:
@ConfigurationProperties
适用于将多个属性值绑定到一个 Java 类中,适用于复杂的配置结构,常用于专门的配置类。@Value
适用于将单个属性值绑定到一个 Java 类的属性上,更适合简单的配置读取,可用于各种类。
在选择使用哪个注解时,可以根据需要来决定。如果需要绑定多个属性值,并且这些属性值有一定的结构,可以使用 @ConfigurationProperties
。如果只需要绑定单个属性值,或者需要在类中的不同地方使用,可以使用 @Value
。