SpringBoot配置中@ConfigurationProperties和@Value的区别

基本特征

@ConfigurationProperties

• 与@Bean结合为属性赋值
• 与@PropertySource（只能用于properties文件）结合读取指定文件
• 与@Validation结合，支持JSR303进行配置文件值的校验，如@NotNull@Email等

@Value

• 为单个属性赋值
• 支持属性上的SpEL表达式

两者比较

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

我们用简单的例子来说明一下。

假设在application.properties文件中这样写道：

student.name=zhangsan
student.age=25
student.class=mba
student.squad-leader=false
student.mail=zhangsan@gmail.com

student.maps.k1=aaa
student.maps.k2=bbb
student.maps.k3=ccc

student.lists=a,b,c

student.score.english=95
student.score.math=90

分别用上面两种绑定属性的方式写两个bean:

StudentCP类使用@ConfigurationProperties的方式来绑定属性，相关比较内容可以看代码上面的注释。

@Component
// @PropertySource表示加载指定文件
// @PropertySource(value = {"classpath:student.properties"})
@ConfigurationProperties(prefix = "student")
// prefiex表示指定统一前缀，下面就不用再写了
@Validated // ConfigurationProperties形式下支持JSR303校验
public class StudentCP {

    private String name;

    private Integer age;

    // 支持松散绑定，可以将连接符转成驼峰命名
    private Boolean squadLeader;

    // 当前形式下支持JSR303数据校验，表示此属性值必须是email的格式
    @Email
    private String mail;

    // 支持复杂类型封装对应
    private Map<String, Object> maps;

    private List<Object> lists;

    private Score score;

}

StudentV类使用@Value的方式来绑定属性，注释中给出了简单的说明。

public class StudentV {

    // 使用@Value的话只能给属性一一指定映射

    @Value("student.name")
    private String name;

    // @Value形式支持SpEL表达式
    @Value("#{13*2}")
    // @Value("student.age")
    private Integer age;

    // @Value("true") // 可直接赋值
    // 不能支持松散语法的绑定
    @Value("student.squad-leader")
    private Boolean squadLeader;

    @Value("student.mail")
    private String mail;

    // 之后的map、list和对象等复杂形式对象@Value无法支持

}

小结

配置文件格式是yml或者properties两者都能够获取值；

如果说只想在某个业务逻辑中获取一下配置文件中的某个值，使用@Value；

如果说专门编写一个JavaBean来和配置文件进行映射，那么就使用@ConfigurationProperties.

其他

@ConfigurationProperties默认从全局配置文件中获取值，如果要从指定配置文件中获取值，那么需要通过@PropertySource来声明指定。

@PropertySource(value = "classpath:student.properties")

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效。 

我们自定义的配置文件，默认是不能注入（加载）到Spring的IoC容器中的，如果想在项目中使用自定义的配置文件，则需要通过@ImportResource来指定注入才能够最终使用。

@ImportResource(location = {"classpath:my-beans.xml"})

以前的项目中，我们都在xml中配置bean，但是实际当中（目前），我们不会使用这种方式来给项目添加组件，SpringBoot有推荐的方式，即使用注解。

@Configuration标注一个类，指明当前类是一个配置类，就是用来替代之前Spring使用xml配置的方式。（<bean id="" class=""></bean>）

@Configuration
public class MyConfig {
    
    /**
    * 将方法的返回值注入到容器中，容器中这个组件默认的id就是方法名
    */
    @Bean
    public HelloService helloService() {
        return new HelloService();
    }
}

配置文件占位符

可以在***.properties中使用占位符使用一些函数，或者调用之前配置的一些内容：

${ramdom.value}
${random.int(10)}
${student.name}
// 获取student.hobit的值，没有的话取冒号后面的缺省值
${student.hobit:football}