深入理解@ConfigurationProperties注解的作用和用法

---

前言

ConfigurationProperties是一个用于定义属性的注解，通常用于Spring应用程序的配置类中。
通过使用ConfigurationProperties注解，可以将外部配置文件中的属性值绑定到对应的属性字段上。
使用ConfigurationProperties时，需要定义一个包含属性的类，并在该类上添加@ConfigurationProperties注解。
可以通过prefix属性指定属性的前缀，这样在绑定属性时会自动匹配前缀相同的属性。

---

一、配置文件application.properties

sky.jwt.aa=1
sky.jwt.bb=2
sky.jwt.cc=3

如果是yml后缀配置文件：

sky:
    jwt:
        aa:1
        bb:2
        cc:3

二、添加依赖

添加必要的依赖：在pom.xml文件中添加以下内容：

<!-- 添加Configuration Properties依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

三、创建配置类

创建一个配置类ConfigClass，并使用@ConfigurationProperties注解将属性与字段进行绑定：

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "sky.jwt")
@Data
public class ConfigClass {
    private Long aa;
    private Long bb;
    private Long cc;
}

四、测试

    @Resource
    private ConfigClass configClass;

    @Test
    void contextLoads() {
        System.out.println(configClass.getAa());
        System.out.println(configClass.getBb());
        System.out.println(configClass.getCc());
    }

运行结果：将外部配置文件中的属性值绑定到对应的属性字段上输出成功

总结

@作者：加辣椒了吗？
简介：憨批大学生一枚，喜欢在博客上记录自己的学习心得，也希望能够帮助到你们！