SpringBoot中的@ConfigurationProperties注解的使用

更新时间：2025年03月22日 09:25:36 作者：需要重新演唱

本文将深入探讨@ConfigurationProperties注解的概念、用法、工作原理、配置绑定、类型安全以及如何在实际开发中应用它,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

SpringBoot中的@ConfigurationProperties注解

在Spring Boot框架中，配置管理是一个核心功能。Spring Boot提供了多种方式来处理外部配置，其中@ConfigurationProperties注解是一个非常强大且灵活的工具。

什么是@ConfigurationProperties？

@ConfigurationProperties是Spring Boot提供的一个注解，用于将外部配置属性绑定到Java对象上。

通过使用这个注解，开发者可以将配置文件（如application.properties或application.yml）中的属性值自动映射到Java类的字段上，从而实现配置的集中管理和类型安全。

@ConfigurationProperties的作用

配置绑定：将配置文件中的属性值绑定到Java类的字段上，实现配置的自动映射。
类型安全：提供类型安全的配置绑定，避免类型转换错误。
复杂配置：支持复杂配置结构的绑定，如嵌套对象、集合、Map等。
配置校验：结合@Valid注解，实现配置属性的校验。

@ConfigurationProperties的基本用法

1. 定义配置类

首先，定义一个Java类，用于绑定配置属性。使用@ConfigurationProperties注解标记该类，并指定前缀（prefix）。

示例代码：

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

@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {

    private String name;
    private String version;
    private boolean enabled;

    // getters and setters
}

解释：

@ConfigurationProperties(prefix = "app")：指定配置属性的前缀为app。
@Component：将该类注册为Spring Bean，使其可以被Spring容器管理。

2. 配置文件

在application.properties或application.yml文件中定义配置属性。

示例代码（application.properties）：

app.name=MyApp
app.version=1.0.0
app.enabled=true

示例代码（application.yml）：

app:
  name: MyApp
  version: 1.0.0
  enabled: true

解释：

配置属性以app为前缀，与@ConfigurationProperties注解中的前缀一致。

3. 启用配置属性支持

在Spring Boot应用的主类或配置类上，使用@EnableConfigurationProperties注解启用配置属性支持。

示例代码：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
@EnableConfigurationProperties(AppProperties.class)
public class MyAppApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyAppApplication.class, args);
    }
}

解释：

@EnableConfigurationProperties(AppProperties.class)：启用AppProperties类的配置属性绑定支持。

@ConfigurationProperties的高级用法

1. 嵌套对象绑定

@ConfigurationProperties支持嵌套对象的绑定，可以实现复杂配置结构的映射。

示例代码：

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

@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {

    private String name;
    private String version;
    private boolean enabled;
    private Server server;

    // getters and setters

    public static class Server {
        private String host;
        private int port;

        // getters and setters
    }
}

配置文件（application.properties）：

app.name=MyApp
app.version=1.0.0
app.enabled=true
app.server.host=localhost
app.server.port=8080

配置文件（application.yml）：

app:
  name: MyApp
  version: 1.0.0
  enabled: true
  server:
    host: localhost
    port: 8080

解释：

嵌套对象Server的属性可以通过app.server前缀进行绑定。

2. 集合和Map绑定

@ConfigurationProperties支持集合和Map类型的绑定，可以实现更灵活的配置结构。

示例代码：

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

import java.util.List;
import java.util.Map;

@Component
@ConfigurationProperties(prefix = "app")
public class AppProperties {

    private String name;
    private String version;
    private boolean enabled;
    private List<String> features;
    private Map<String, String> settings;

    // getters and setters
}

配置文件（application.properties）：

app.name=MyApp
app.version=1.0.0
app.enabled=true
app.features[0]=feature1
app.features[1]=feature2
app.settings.key1=value1
app.settings.key2=value2

配置文件（application.yml）：

app:
  name: MyApp
  version: 1.0.0
  enabled: true
  features:
    - feature1
    - feature2
  settings:
    key1: value1
    key2: value2

解释：

集合features和Mapsettings的属性可以通过app.features和app.settings前缀进行绑定。

3. 配置校验

结合@Valid注解，可以实现配置属性的校验，确保配置的有效性。

示例代码：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Component
@ConfigurationProperties(prefix = "app")
@Validated
public class AppProperties {

    @NotEmpty
    private String name;

    @NotNull
    private String version;

    private boolean enabled;

    // getters and setters
}

解释：

@Validated：启用校验支持。
@NotEmpty和@NotNull：对name和version字段进行非空校验。

@ConfigurationProperties的工作原理

@ConfigurationProperties注解的工作原理主要涉及以下几个步骤：

属性扫描：Spring Boot应用启动时，会扫描所有带有@ConfigurationProperties注解的类。
属性绑定：根据注解中指定的前缀，将配置文件中的属性值绑定到类的字段上。
类型转换：Spring Boot内置了多种类型转换器，可以将配置属性值转换为相应的Java类型。
校验：结合@Valid注解，对绑定的配置属性进行校验。

@ConfigurationProperties的最佳实践

合理划分配置类：根据功能模块合理划分配置类，避免单个配置类过于庞大。
使用嵌套对象：对于复杂配置结构，使用嵌套对象进行绑定，提高配置的可读性和可维护性。
配置校验：结合@Valid注解，对配置属性进行校验，确保配置的有效性。
文档和注释：在配置类中添加文档和注释，说明配置属性的作用和取值范围，方便团队成员理解和维护。

结论

@ConfigurationProperties是Spring Boot中一个非常强大且灵活的工具，用于将外部配置属性绑定到Java对象上。通过使用这个注解，开发者可以实现配置的集中管理和类型安全，提高开发效率和代码质量。

希望通过本文的讲解，你对Spring Boot中的@ConfigurationProperties注解有了更深入的理解，并能在实际开发中灵活应用。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

IDEA导入jar包的完整实现步骤
由于导入jar包项目存在很多不确定的问题,导致每次都需要调试、配置好多遍,对此特意记录下来,这篇文章主要给大家介绍了关于IDEA导入jar包的相关资料,需要的朋友可以参考下
2024-01-01
Java内存区域管理详解
这篇文章主要介绍了Java内存区域管理详解，文章通过围绕主题展开详细的内容介绍，具有一定的参考价值，需要的小伙伴可以参考一下
2022-09-09
Java中浅拷贝和深拷贝详解
大家好，本篇文章主要讲的是Java中浅拷贝和深拷贝详解，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下，方便下次浏览
2021-12-12
SpringBoot整合Nacos注册中心的实现示例
本文通过Nacos实现SpringBoot与SpringCloudGateway的配置热更新、共享配置及动态路由,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2025-07-07
Java Socket编程（五）简单的WEB服务器
Java Socket编程（五）简单的WEB服务器...
2006-12-12
Java基础语法之二维数组详解
这篇文章主要介绍了Java基础语法之二维数组详解,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助,需要的朋友可以参考下
2021-05-05
详解Java的MyBatis框架与Spring框架整合中的映射器注入
映射器注入方式可以将MyBatis与Spring映射好的XML文件实现配置共用,这里我们就来详解Java的MyBatis框架与Spring框架整合中的映射器注入:
2016-06-06
java语法糖之jdk迭代的新特性汇总
什么是语法糖？泛型、自动装箱拆箱、变长参数、增强for循环、switch字符类型、lambda表达式等，这些其实都是语法糖。这篇文章主要给大家介绍了关于java语法糖之jdk迭代的新特性的相关资料,需要的朋友可以参考下
2021-05-05
MybatisPlus使用idworker解决雪花算法重复
本文主要介绍了MybatisPlus使用idworker解决雪花算法重复，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-02-02
Spring中的BeanFactory对象实例化工厂详解
这篇文章主要介绍了Spring中的BeanFactory对象实例化工厂详解,BeanFactory及其子类是Spring IOC容器中最重要的一个类,BeanFactory由类名可以看出其是一个Bean工厂类,其实它确实是一个Bean工厂类,完成Bean的初始化操作,需要的朋友可以参考下
2023-12-12