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注解有了更深入的理解，并能在实际开发中灵活应用。

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

您可能感兴趣的文章:

Spring使用注解方式处理事务
这篇文章主要为大家详细介绍了Spring使用注解方式处理事务，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-08-08
Spring事务管理方法步骤解析
这篇文章主要介绍了Spring事务管理方法步骤解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09
MyBatis动态SQL标签的用法详解
这篇文章主要介绍了MyBatis动态SQL标签的用法详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-04-04
SpringBoot+Beetl实现动态数据库DDL的示例代码
最近公司里有一个新的需求,需要导出数据库元数据表中存储的表的 DDL 语句,而在元数据表中数据源的类型庞大,少则十几种多则达到几十种,各种数据库类型都有,本篇文章就从这个模版引擎来入手介绍如何实现功能,需要的朋友可以参考下
2025-06-06
Java中List集合去除重复数据的方法汇总
这篇文章主要给大家介绍了关于Java中List集合去除重复数据的方法，文中通过图文介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-02-02
死磕 java同步系列之synchronized解析
这篇文章主要介绍了Java中syncronized正确使用方法解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2021-06-06
Java二维码登录流程实现代码(包含短地址生成，含部分代码)
近年来，二维码的使用越来越风生水起，本篇文章主要介绍了Java二维码登录流程实现代码，其中包含短地址生成，有兴趣的可以了解一下。
2016-12-12
Java Maven Settings配置参考教程
这篇文章主要介绍了Java Maven Settings配置参考,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-09-09
IntelliJ IDEA中初始化Java类的常用快捷方法详解
这篇文章主要为大家详细介绍了IntelliJ IDEA中初始化Java类并设置所有属性的常用快捷方法,文中的示例代码讲解详细,需要的小伙伴可以参考下
2026-02-02
Spring Boot 3 整合 Spring Cloud
本文介绍了如何使用SpringCloudAlibaba2023.0.0.0版本构建一个微服务网关,包括统一路由、限流防刷和登录鉴权等功能,并通过一个项目实例进行详细说明,感兴趣的朋友一起看看吧
2025-02-02