【springboot】springboot 注解之@ConfigurationProperties

---

前言

我们可以在 springboot 的 yml 文件或者 properties 文件中配置一些项目需要的参数，那么在项目需要使用的时候该如何获取。在 spring 中有一个 @Value 注解可以获取配置文件中对应的值，这是一种方法。但是这种方法在需要配置的属性很多的时候就会显得不好看。这是后就用到了第二种方式，使用 @ConfigurationProperties 注解。

---

使用 @ConfigurationProperties

首先我们在 yml 中配置自己想要的配置

configuration-properties:
  test:
    name-test: 配置绑定名称
    valueTest: 配置绑定值

接着我们编写与配置匹配的类，并在类上加上 @ConfigurationProperties 注解。注解的属性 prefix 表示 yml 配置的前缀。
和配置绑定的类的字段与配置的名称需要保持一致，当然配置中的 - 可以自动转化为驼峰格式。

@Data
@ToString
@ConfigurationProperties(prefix = "configuration-properties.test")
public class PropertiesTest {
    private String nameTest;
    private String valueTest;
}

接下来会发现 idea 提示报错，下面就会有两种方式停止报错并生效。

1.@Component 方式

可以在 PropertiesTest 类上添加 @Component 注解，让其注册到 IOC 容器中。当然除了 @Compoment 注解其他注解也可以，如：@Repository。

@Data
@ToString
@Repository
@ConfigurationProperties(prefix = "configuration-properties.test")
public class PropertiesTest {
    private String nameTest;
    private String valueTest;
}

测试：

@SpringBootApplication
public class SpringbootFunctionApplication {

    public static void main(String[] args) {
        // 返回 IOC 容器
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootFunctionApplication.class, args);
        // 配置绑定后的对象
        System.out.println(MessageFormat.format("配置绑定的对象为：{0}", run.getBean(PropertiesTest.class)));
    }

}

运行结果如下：

配置绑定的对象为：PropertiesTest(nameTest=配置绑定名称, valueTest=配置绑定值)

通过结果可以看到 PropertiesTest 类被注册到 IOC 容器中，并且该对象的属性也与配置值绑定。

2.使用 @EnableConfigurationProperties

可以将 @EnableConfigurationProperties 注解放在任意容器的 bean 上，这里放在了配置类上。
@EnableConfigurationProperties 注解的 value 属性添加绑定类。

@Configuration
@EnableConfigurationProperties(PropertiesTest.class)
public class BeanConfig {
}

测试：

@SpringBootApplication
public class SpringbootFunctionApplication {

    public static void main(String[] args) {
        // 返回 IOC 容器
        ConfigurableApplicationContext run = SpringApplication.run(SpringbootFunctionApplication.class, args);
        // 配置绑定后的对象
        System.out.println(MessageFormat.format("配置绑定的对象为：{0}", run.getBean(PropertiesTest.class)));
    }

}

运行结果如下：

配置绑定的对象为：PropertiesTest(nameTest=配置绑定名称, valueTest=配置绑定值)

通过结果可以看到 PropertiesTest 类被注册到 IOC 容器中，并且该对象的属性也与配置值绑定。

---

总结

@ConfigurationProperties 注解可以将配置与一个对象绑定，并且将该对象注册到 IOC 容器中。我们什么时候需要直接从 IOC 中获取可以。
@ConfigurationProperties 有两种方式，一种是直接将绑定类配置为 bean 的形式；另一种是使用 enable 注解启动 @ConfigurationProperties 这个注解配置。日常开发中两种方式都可以使用，看具体的业务情况。