SpringBoot自动配置-@ConfigurationProperties注解

已于 2023-01-11 20:39:01 修改
阅读量2.4k 收藏 9
点赞数 1
分类专栏： SpringBoot 文章标签： spring boot
于 2023-01-11 18:28:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_40017062/article/details/128648609
版权
文章详细介绍了SpringBoot中使用@ConfigurationProperties注解进行配置属性批量注入的方法，包括单个属性注入、批量注入、对象属性注入和外部对象属性注入。通过示例代码展示了如何从application.yml文件中读取数据并自动注入到对应的bean对象中，简化了属性设置的过程。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

@ConfigurationProperties是 SpringBoot 提供的重要注解，可以将一些配置属性批量注入到 bean 对象。

方式一：@Value一个个注入

1、application.yml配置文件：

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql:///springboot_01
      username: root
      password: root

2、自动配置类DataSourceProperties：

package org.example.properties;

@Component
public class DataSourceProperties {
    @Value("${spring.jdbc.datasource.driverClassName}")
    private String driverClassName;
    @Value("${spring.jdbc.datasource.url}")
    private String url;
    @Value("${spring.jdbc.datasource.username}")
    private String username;
    @Value("${spring.jdbc.datasource.password}")
    private String password;

    @Override
    public String toString() {
        return "DataSourceProperties{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

3、Controller 调用：

package org.example.controller;
...

@RestController
public class HelloController {
    @Autowired
    private DataSourceProperties dataSourceProperties;

    @RequestMapping("/hello")
    public String hello(){
        System.out.println(dataSourceProperties);
        return "hello spring boot!!" ;
    }
}

4、访问 http://localhost:8080/hello，输出：

DataSourceProperties{driverClassName='com.mysql.jdbc.Driver', url='jdbc:mysql:///springboot_01', username='root', password='root'}

@Value注入方式，如果属性特别多，一个一个注入太麻烦啦！

方式二：@ConfigurationProperties批量注入

1、自动配置类DataSourceProperties2：

package org.example.properties;
...

@Component
@ConfigurationProperties("spring.jdbc.datasource")
public class DataSourceProperties2 {
    private String driverClassName;
    private String url;
    private String username;
    private String password;

    public String getDriverClassName() { return driverClassName; }

    public void setDriverClassName(String driverClassName) { this.driverClassName = driverClassName; }

    public String getUrl() { return url; }

    public void setUrl(String url) { this.url = url; }

    public String getUsername() { return username; }

    public void setUsername(String username) { this.username = username; }

    public String getPassword() { return password; }

    public void setPassword(String password) { this.password = password; }

    @Override
    public String toString() {
        return "DataSourceProperties{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}
  • @ConfigurationProperties注解声明该类要读取属性配置
  • prefix="spring.jdbc.datasource" 读取属性文件中前缀为 spring.jdbc.datasource的值。前缀和属性名称和配置文件中的 key 必须要保持一致才可以注入成功
  • SpringBoot 默认读取 application.properties 属性文件

2、Controller 调用：

@RestController
//@EnableConfigurationProperties(DataSourceProperties2.class)
public class HelloController {
    @Autowired
    private DataSourceProperties dataSourceProperties;

    @Autowired
    private DataSourceProperties2 dataSourceProperties2;

    @RequestMapping("/hello")
    public String hello(){
        System.out.println(dataSourceProperties);
        return "hello spring boot!!" ;
    }

    @RequestMapping("/hello2")
    public String hello2(){
        System.out.println(dataSourceProperties2);
        return "hello spring boot!!" ;
    }
}

@EnableConfigurationProperties(DataSourceProperties2.class)注解说明注入 DataSourceProperties2 类包含的属性，方便追溯代码。 注：该注解不加，也可以…囧

3、pom文件添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

4、访问 http://localhost:8080/hello2，输出：

DataSourceProperties{driverClassName='com.mysql.jdbc.Driver', url='jdbc:mysql:///springboot_01', username='root', password='root'}

@ConfigurationProperties注入方式，属性再多，只要按照规则就可以一次性自动注入。方便很多！

方式三：对象属性注入

@ConfigurationProperties不仅可以自动注入简单类型数据，也支持对象属性注入。

1、application.yml 配置文件新增 type：

spring:
  jdbc:
    datasource:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql:///springboot_01
      username: root
      password: root
    type: mysql

2、自动配置类DataSourceProperties3：

package org.example.properties;
...

@Component
@ConfigurationProperties(prefix = "spring.jdbc")
public class DataSourceProperties3 {
    private DataSourceProperties2 dataSource; //注意，属性名称要和application.yml保持一致。
    private String type ;

    public DataSourceProperties2 getDataSource() {
        return dataSource;
    }

    public void setDataSource(DataSourceProperties2 dataSource) {
        this.dataSource = dataSource;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    @Override
    public String toString() {
        return "DataSourceProperties3{" +
                "dataSource=" + dataSource +
                ", type='" + type + '\'' +
                '}';
    }
}

private DataSourceProperties2 dataSource;属性名称 dataSource 要和 application.yml 保持一致，才可以注入成功。当然，也可以添加@Autowired注解，这样保证 DataSourceProperties2 对象的注入，也可以保证配置注入成功。

@Component
@ConfigurationProperties(prefix = "spring.jdbc")
public class DataSourceProperties3 {
    @Autowired
    private DataSourceProperties2 source; 
    private String type ;

    ...
}

3、Controller 调用：

@RestController
public class HelloController {

    @Autowired
    private DataSourceProperties3 dataSourceProperties3;

    @RequestMapping("/hello3")
    public String hello3(){
        System.out.println(dataSourceProperties3);
        return "hello spring boot!!" ;
    }
}

4、访问 http://localhost:8080/hello3，输出：

DataSourceProperties3{dataSource=DataSourceProperties{driverClassName='com.mysql.jdbc.Driver', url='jdbc:mysql:///springboot_01', username='root', password='root'}, type='mysql'}

方式四：外部对象属性注入

场景：现有一个类DataSource，需要将配置文件中的内容注入其中。

package org.example.properties;

public class DataSource {
    private String driverClassName;
    private String url;
    private String username;
    private String password;

    public String getDriverClassName() {return driverClassName;}

    public void setDriverClassName(String driverClassName) {this.driverClassName = driverClassName;}

    public String getUrl() {return url;}

    public void setUrl(String url) {this.url = url;}

    public String getUsername() {return username;}

    public void setUsername(String username) {this.username = username;}

    public String getPassword() {return password;}

    public void setPassword(String password) {this.password = password;}

    @Override
    public String toString() {
        return "DataSource{" +
                "driverClassName='" + driverClassName + '\'' +
                ", url='" + url + '\'' +
                ", username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

这种情况，需要将该配置类添加到Spring Context中，该怎么做呢？？？

@Bean和@Component都是将 Spring Bean 添加到 Spring Context 中。
因为该配置类没有 @Component 修饰，我们使用 @Bean 将该类添加到 Spring Context 中。

1、新建 JdbcConfig 配置类：

package org.example.config;

import org.example.properties.DataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class JdbcConfig {
    @Bean
    @ConfigurationProperties(prefix = "spring.jdbc.datasource")
    public DataSource getDataSource(){
        return new DataSource();
    }
}

@ConfigurationProperties(prefix = "spring.jdbc.datasource")修饰返回的类，将会对返回的对象自动注入属性。

2、自动配置类JdbcProperties：

package org.example.properties;
...

@Component
@ConfigurationProperties(prefix = "spring.jdbc")
public class JdbcProperties {
    @Autowired
    private DataSource source; //注意，属性名称要和application.yml保持一致。
    private String type ;

    public DataSource getSource() {
        return source;
    }

    public void setSource(DataSource source) {
        this.source = source;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    @Override
    public String toString() {
        return "JdbcProperties{" +
                "dataSource=" + source +
                ", type='" + type + '\'' +
                '}';
    }
}

3、Controller 调用：

@RestController
public class HelloController {
    
    @Autowired
    private JdbcProperties jdbcProperties;

    @RequestMapping("/hello4")
    public String hello4(){
        System.out.println(jdbcProperties);
        return "hello spring boot!!" ;
    }
}

4、访问 http://localhost:8080/hello4，输出：

JdbcProperties{dataSource=DataSource{driverClassName='com.mysql.jdbc.Driver', url='jdbc:mysql:///springboot_01', username='root', password='root'}, type='mysql'}
深入解析Spring Boot中的@ConfigurationProperties注解
xycxycooo的博客
08-15 9479
是Spring Boot提供的一个注解，用于将外部配置属性绑定到Java对象上。通过使用这个注解，开发者可以将配置文件（如或）中的属性值自动映射到Java类的字段上，从而实现配置的集中管理和类型安全。首先，定义一个Java类，用于绑定配置属性。使用注解标记该类，并指定前缀（prefix）。@Component：指定配置属性的前缀为app。@Component。
Springboot2.6.2运用注解@ConfigurationProperties从配置文件application.yaml中获取配置信息注入对象的属性
askvinson的博客
01-09 686
Springboot2.6.2运用注解@ConfigurationProperties从配置文件application.yaml中获取配置信息注入对象的属性
springboot--@ConfigurationProperties
w450093854的专栏
12-15 301
转载:https://www.cnblogs.com/liaojie970/p/8043150.html 有时候有这样子的情景，我们想把配置文件的信息，读取并自动封装成实体类，这样子，我们在代码里面使用就轻松方便多了，这时候，我们就可以使用@ConfigurationProperties，它可以把同类的配置信息自动封装成实体类 首先在配置文件里面，这些信息是这样子滴 connection....
深入理解@ConfigurationProperties注解
最新发布
younuoqianjin的博客
04-09 1198
1. 所属包与版本•包名•引入版本: Spring Boot 1.0+（核心功能之一）2. 核心作用是 Spring Boot 中用于将配置文件中的属性批量绑定到 Java 对象的核心注解。它通过类型安全的方式，将分散在配置文件（如）中的属性值，按规则映射到 Java 类的字段上，实现配置的集中管理和强类型访问。类型安全：通过 Java 对象访问配置，减少硬编码错误。结构化管理：支持复杂配置的层级化、模块化设计。灵活扩展：适用于自定义 Starter 开发和多环境配置切换。
SpringBoot注解讲解（@ConfigurationProperties）
LiZhen314的博客
02-22 3541
无论是@EnableConfigurationProperties + @ConfigurationProperties还是@Component+@ConfigurationProperties都能实现配置绑定。但是这两种方式在使用场景上有点区别。（1）如果使用的第三方包中的组件，这时我们无法在该组件上添加@Component，此时使用@EnableConfigurationProperties + @ConfigurationProperties实现配置绑定（2）在我们自定义的组件中，我个人觉得。
Spring中配置和读取多个Properties文件--转
08-05 248
public class PropertiesFactoryBeanextends PropertiesLoaderSupportimplements FactoryBean, InitializingBean Allows for making a properties file from a classpath location available as Properties in...
springboot之@ConfigurationProperties注解
凡间的博客
09-06 316
@ConfigurationProperties注解不仅可以用于自定义bean的属性绑定，还可以用于第三方bean的自动绑定。
Spring Boot技术知识点：如何理解@ConfigurationProperties注解
06-20
在Spring Boot框架中，`@ConfigurationProperties`注解是一个核心特性，它允许我们将配置属性从外部化配置文件（如application.properties或application.yml）绑定到Java对象的字段上，从而简化了属性管理。这个注解...
springboot的@ConfigurationProperties注解
Andy_奋斗的博客
02-28 999
尽管我们的代码健壮性做不到跟大佬一样，但是在特定业务场景下，比如对某个特别重要的单例Bean进行操作，或者为某一类特定的接口实现，做一些特定的处理，可以考虑这种技术。下面的两个方法，很简单，大致意思就是，在Spring的Bean初始化之前与之后执行。实现BeanPostProcessor接口的方法，检查每一个初始化成功的Bean，如果使用了我们的自定义注解，那么就把从配置文件中解析出来的数据，使用反射技术注入进去。好了，作为程序员，看了半天源码，扯了半天淡，不如自己实现一个类似的效果来的实在。
SpringBoot - @ConfigurationProperties 注解使用姿势，这一篇就够了
陆克和他的那些代码
09-15 3306
SpringBoot - @ConfigurationProperties 注解使用姿势，这一篇就够了
在spring-boot中使用@ConfigurationProperties
三劫散仙
10-28 240
@ConfigurationProperties注解的作用是可以根据一个前缀将配置文件的属性映射成一个POJO实体类，只要属性名一致就能自动注入进去，使用起来非常方便，这一点容易与@Configuration注解混淆，@Configuration也可以注解一个配置类，不一样的是它需要为每个属性再次声明绑定的字段，稍微复杂，所以推荐使用@ConfigurationProperties注解...
springboot的@configurationProperties注解
weixin_46564011的博客
04-11 781
springboot的@configurationProperties注解他可以将你application.propertie中自定义的属性对pojo类进行属性填充 通常他有两种使用方法 1 在pojo类中配合@Component注解 先将这个组件放到spring容器中才能进行使用@configurationProperties注解将application.properties与application.yaml文件内自定义的属性导入 @configurationProperties他的主要目的就是将自
SpringBoot @ConfigurationProperties 注解解析
干饭两斤半
12-11 358
@ConfigurationProperties 用于将类中属性与配置文件(application.yml)中的相关配置进行绑定;需要导入依赖 @ConfigurationProperties(prefix = “person”) 需要配置prefix属性,就是让其与yml中的属性进行匹配 而且,这个组件需要加入spring容器中,spring才能提供@ConfigurationPrope...
Spring Boot中使用@ConfigurationProperties 注解
满世界溜达
08-28 958
Spring Boot 最大的优点之一就是可扩展的配置和简单的访问配置文件。为了演示demo，这里添加hibernate validation的依赖： &amp;lt;dependency&amp;gt; &amp;lt;groupId&amp;gt;org.hibernate&amp;lt;/groupId&amp;gt; &amp;lt;artifactId&amp;gt;hibernate-validator&amp
Spring boot中的@ConfigurationProperties注解
m0_70484213的博客
02-25 533
假设你有一个配置文件 application.properties，内容如下：这些内容都是以app开头的，你可以通过定义一个带有注解的类来绑定这些配置：设置@ConfigurationProperties的prefix 属性为 “app”，@Component@Data。
@ConfigurationProperties注解
sxp知识共享
11-16 9810
@ConfigurationProperties注解 @ConfigurationProperties是springboot提供读取配置文件的一个注解 注意： 前缀定义了哪些外部属性将绑定到类的字段上 根据 Spring Boot 宽松的绑定规则，类的属性名称必须与外部属性的名称匹配 我们可以简单地用一个值初始化一个字段来定义一个默认值 类本身可以是包私有的 类的字段必须有公共 setter 方法 这个prefix 必须小写，不然会报错 示例1：作用于Class类及其用法 配置文件： person:
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

不会叫的狼

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值