@ConfigurationProperties：将外部配置文件中的属性值绑定到对应的属性字段上

梦里梦外; 2023-10-14 14:06 44阅读 0赞

#### 文章目录 ####

*  前言
 *  一、配置文件application.properties
 *  二、添加依赖
 *  三、创建配置类
 *  四、测试
 *  总结

--------------------

## 前言 ##

> **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文件中添加以下内容：**

<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());
        }

**运行结果：将外部配置文件中的属性值绑定到对应的属性字段上输出成功**  
![在这里插入图片描述][baa4e76434c84d8eb733f67eaf4ad2c8.png]

## 总结 ##

> @作者：加辣椒了吗？  
> 简介：憨批大学生一枚，喜欢在博客上记录自己的学习心得，也希望能够帮助到你们！  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc5NzUzOQ_size_16_color_FFFFFF_t_70]

[baa4e76434c84d8eb733f67eaf4ad2c8.png]: https://img-blog.csdnimg.cn/baa4e76434c84d8eb733f67eaf4ad2c8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc5NzUzOQ_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/2021060109523638.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDc5NzUzOQ==,size_16,color_FFFFFF,t_70