脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Boot中的@ConfigurationProperties注解

Spring Boot中的@ConfigurationProperties注解解读

 更新时间：2024年10月23日 09:28:14   作者：需要重新演唱  
在SpringBoot框架中,@ConfigurationProperties注解是处理外部配置的强大工具,它允许开发者将配置文件中的属性自动映射到Java类的字段上,实现配置的集中管理和类型安全,通过定义配置类并指定前缀,可以将配置文件中的属性绑定到Java对象

解析Spring Boot中的@ConfigurationProperties注解

在Spring Boot框架中，配置管理是一个核心功能。

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

本文将深入探讨@ConfigurationProperties注解的概念、用法、工作原理、配置绑定、类型安全以及如何在实际开发中应用它。

什么是@ConfigurationProperties？

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

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

@ConfigurationProperties的作用

  1. 配置绑定：将配置文件中的属性值绑定到Java类的字段上，实现配置的自动映射。
  2. 类型安全：提供类型安全的配置绑定，避免类型转换错误。
  3. 复杂配置：支持复杂配置结构的绑定，如嵌套对象、集合、Map等。
  4. 配置校验：结合@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注解的工作原理主要涉及以下几个步骤：

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

@ConfigurationProperties的最佳实践

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

结论

@ConfigurationProperties是Spring Boot中一个非常强大且灵活的工具，用于将外部配置属性绑定到Java对象上。

通过使用这个注解，开发者可以实现配置的集中管理和类型安全，提高开发效率和代码质量。

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

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

您可能感兴趣的文章:

相关文章

  • MyBatis-Plus 批量保存的操作方法

    MyBatis-Plus 批量保存的操作方法

    在项目开发中,需要插入批量插入20多万条数据,通过日志观察,发现在调用MyBatis-Plus中的saveBatch()方法性能非常的差,本篇文章主要分享一下saveBatch()的原理以及使用的注意事项,感兴趣的朋友跟随小编一起看看吧
    2024-01-01
  • Springboot中Aspect切面的实现方式(以记录日志为例)

    Springboot中Aspect切面的实现方式(以记录日志为例)

    这篇文章主要介绍了Springboot中Aspect切面的实现方式(以记录日志为例)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-06-06
  • Java RAG集成实战指南(含代码)

    Java RAG集成实战指南(含代码)

    在这个背景下,大模型JavaAPI和RAG技术逐渐崭露头角,成为软件开发者们关注的焦点,下面这篇文章主要介绍了Java RAG集成的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2026-04-04
  • Mybatis中ResultMap解决属性名和数据库字段名不一致问题

    Mybatis中ResultMap解决属性名和数据库字段名不一致问题

    我们Pojo类的属性名和数据库中的字段名不一致的现象时有发生，本文就详细的介绍一下Mybatis中ResultMap解决属性名和数据库字段名不一致问题，感兴趣的可以了解一下
    2021-10-10
  • java springboot的概述、特点与构建介绍

    java springboot的概述、特点与构建介绍

    大家好，本篇文章主要讲的是springboot的概述、特点与构建介绍，感兴趣的同学赶快来看一看吧，对你有帮助的话记得收藏一下，方便下次浏览
    2021-12-12
  • SpringBoot disruptor高性能队列使用

    SpringBoot disruptor高性能队列使用

    这篇文章主要介绍了SpringBoot disruptor高性能队列使用，Disruptor是英国外汇交易公司LMAX开发的一个高性能队列，研发的初衷是解决内存队列的延迟问题
    2023-02-02
  • 深入学习java ThreadLocal的源码知识

    深入学习java ThreadLocal的源码知识

    ThreadLocal是一个本地线程副本变量工具类。主要用于将私有线程和该线程存放的副本对象做一个映射，各个线程之间的变量互不干扰，特别适用于各个线程依赖不通的变量值完成操作的场景。下面我们来详细了解一下它吧
    2019-06-06
  • springmvc+shiro+maven 实现登录认证与权限授权管理

    springmvc+shiro+maven 实现登录认证与权限授权管理

    Shiro 是一个 Apache 下的一开源项目项目，旨在简化身份验证和授权，下面通过实例代码给大家分享springmvc+shiro+maven 实现登录认证与权限授权管理，感兴趣的朋友一起看看吧
    2017-09-09
  • IDEA 自定义方法注解模板的实现方法

    IDEA 自定义方法注解模板的实现方法

    这篇文章主要介绍了IDEA 自定义方法注解模板的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-09-09
  • Java代码实现对properties文件有序的读写的示例

    Java代码实现对properties文件有序的读写的示例

    本篇文章主要介绍了Java代码实现对properties文件有序的读写的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-11-11

最新评论