深入解析Spring Boot中的@ConfigurationProperties注解

深入解析Spring Boot中的@ConfigurationProperties注解

在Spring Boot框架中,配置管理是一个核心功能。Spring Boot提供了多种方式来处理外部配置,其中@ConfigurationProperties注解是一个非常强大且灵活的工具。本文将深入探讨@ConfigurationProperties注解的概念、用法、工作原理、配置绑定、类型安全以及如何在实际开发中应用它。

什么是@ConfigurationProperties?

@ConfigurationProperties是Spring Boot提供的一个注解,用于将外部配置属性绑定到Java对象上。通过使用这个注解,开发者可以将配置文件(如application.propertiesapplication.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.propertiesapplication.yml文件中定义配置属性。

示例代码(application.properties):

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

示例代码(application.yml):

app:name: MyAppversion: 1.0.0enabled: 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 setterspublic 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: MyAppversion: 1.0.0enabled: trueserver:host: localhostport: 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: MyAppversion: 1.0.0enabled: truefeatures:- feature1- feature2settings:key1: value1key2: value2

解释:

  • 集合features和Mapsettings的属性可以通过app.featuresapp.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 {@NotEmptyprivate String name;@NotNullprivate String version;private boolean enabled;// getters and setters
}

解释:

  • @Validated:启用校验支持。
  • @NotEmpty@NotNull:对nameversion字段进行非空校验。
@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注解有了更深入的理解,并能在实际开发中灵活应用。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/65412.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

文档解析丨高效准确的PDF解析工具,赋能企业非结构化数据治理

在数据为王的时代浪潮中&#xff0c;企业数据治理已成为组织优化运营、提高竞争力的关键。随着数字化进程的加速&#xff0c;企业所积累的数据量呈爆炸式增长&#xff0c;数据类型也愈发多样化&#xff0c;这些数据构成了现代企业数据资产的重要组成部分。 然而&#xff0c;传…

支持最新 mysql9的workbench8.0.39 中文汉化教程来了

之前在 B 站上发布了 mysql8 workbench 汉化教程&#xff0c;一年多来帮助很多初学者解决了不熟悉英文的烦恼。 汉化视频可以访问&#xff1a; 2024最新版mysql8.0.39中文版mysql workbench汉化 中文升级 旧版汉化报错解决_哔哩哔哩_bilibili MySql Workbench汉化_哔哩哔哩_…

02-18.python入门基础一基础算法

&#xff08;一&#xff09;排序算法 简述&#xff1a; 在 Python 中&#xff0c;有多种常用的排序算法&#xff0c;下面为你详细介绍几种常见的排序算法及其原理、实现代码、时间复杂度以及稳定性等特点&#xff0c;并对比它们适用的场景。 冒泡排序&#xff08;Bubble Sor…

STM32高级 WiFi案例2:TCP通讯

ESP32支持的WIFI工作模式 在实现TCP的通讯案例之前我们需要先了解下ESP32支持的工作模式。 1》基站模式/STA模式 在 ESP32&#xff08;一款集成 Wi - Fi 和蓝牙技术的低成本、低功耗微控制器芯片&#xff09;中&#xff0c;基站模式&#xff08;Station 模式&#xff09;是指…

华为 IPD,究竟有什么特点?(一)

关注作者 &#xff08;一&#xff09;华为版 IPD 特点一&#xff1a;一定要让研发转身为作战 部队 冲到前台的研发&#xff0c;应主动拉通公司上下游&#xff0c;向前抓需求&#xff0c;向后支撑可制造性、可 服务性&#xff0c;并推动制造、服务的改进。 1&#xff09;研发从…

机器学习详解(11):分类任务的模型评估标准

模型评估是利用不同的评估指标来了解机器学习模型的性能&#xff0c;以及其优势和劣势的过程。评估对于确保机器学习模型的可靠性、泛化能力以及在新数据上的准确预测能力至关重要。 文章目录 1 介绍2 评估准则3 分类指标3.1 准确率 (Accuracy)3.2 精确率 (Precision)3.3 召回率…

已有docker镜像构建过程分析

1.使用docker history进行分析   docker history 命令用于查看指定镜像的历史层信息,它显示了镜像创建过程中的每一层,包括创建时间、创建者、大小和注释等信息。 查看镜像历史 docker history myimage:latest 使用示例: root@controller1:~# docker images | grep zj_j…

【Mac】终端改色-让用户名和主机名有颜色

效果图 配置zsh 1.打开终端&#xff0c;进入.zshrc配置 cd ~ vim .zshrc2.添加如下配置并保存 # 启用命令行颜色显示 export CLICOLOR1 ## 加载颜色支持 autoload -U colors && colors # 配置 zsh 提示符 PROMPT"%{$fg_bold[red]%}%n%{$reset_color%}%{$fg_bol…

【Artificial Intelligence篇】智行未来:AI 在日常出行领域的崛起征程

目录 ​编辑 一、引言&#xff1a; 二、AI 在日常出行中的关键技术应用&#xff1a; 2.1自动驾驶技术&#xff1a; 2.2智能交通管理&#xff1a; 2.3出行辅助系统&#xff1a; 三、AI 在日常出行领域的发展现状&#xff1a; 四、AI 在日常出行领域的未来前景&#xff…

指针之矢:C 语言内存幽境的精准飞梭

一、内存和编码 指针理解的2个要点&#xff1a; 指针是内存中一个最小单元的编号&#xff0c;也就是地址平时口语中说的指针&#xff0c;通常指的是指针变量&#xff0c;是用来存放内存地址的变量 总结&#xff1a;指针就是地址&#xff0c;口语中说的指针通常指的是指针变量。…

springboot478基于vue全家桶的pc端仿淘宝系统(论文+源码)_kaic

摘 要 随着我国经济的高速发展与人们生活水平的日益提高&#xff0c;人们对生活质量的追求也多种多样。尤其在人们生活节奏不断加快的当下&#xff0c;人们更趋向于足不出户解决生活上的问题&#xff0c;网上购物系统展现了其蓬勃生命力和广阔的前景。与此同时&#xff0c;为解…

Atcoder Beginner Contest 385

比赛链接: Atcoder Beginner Contest 385 Github 链接&#xff1a;ABC385 A - Equally 只有三个数相等或者两个小的数加起来等于最大的数时输出 Y e s Yes Yes&#xff0c;其他时候输出 N o No No。 时间复杂度&#xff1a; O ( 1 ) O(1) O(1)。 #include <bits/stdc…

Html——12. 定义样式和引入样式

<!DOCTYPE html> <html><head><meta charset"UTF-8"><title>定义样式和引入样式文件&#xff08;CSS文件&#xff09;</title><style type"text/css">body{font-size: 40px;}</style><link rel"s…

Kafka优势

目录 1. 分布式架构 2. 持久化日志与顺序写入 3. 批量处理 4. 异步提交与压缩 5. 消费者组与并行消费 6. 高效的数据复制 7. 无锁设计与多线程模型 8. 幂等性和事务支持 9. 流处理集成 10. 灵活的配置与调优 总结 1. 分布式架构 多 broker 集群&#xff1a;Kafka 是…

Gitlab17.7+Jenkins2.4.91实现Fastapi/Django项目持续发布版本详细操作(亲测可用)

一、gitlab设置&#xff1a; 1、进入gitlab选择主页在左侧菜单的下面点击管理员按钮。 2、选择左侧菜单的设置&#xff0c;选择网络&#xff0c;在右侧选择出站请求后选择允许来自webhooks和集成对本地网络的请求 3、webhook设置 进入你自己的项目选择左侧菜单的设置&#xff…

pathlib:面向对象的文件系统路径

pathlib:面向对象的文件系统路径 pathlib官方介绍: Python3.4内置的标准库&#xff0c;Object-oriented filesystem paths&#xff08;面向对象的文件系统路径&#xff09; 文章目录 pathlib:面向对象的文件系统路径1. 使用示例1.1 最常用&#xff1a;获取项目目录1.2 遍历一…

Hive练习题16-20

题目16&#xff1a; 同时在线问题 如下为某直播平台主播开播及关播时间&#xff0c;根据该数据计算出平台最高峰同时在线的主播人数。 id stt edt 1001,2021-06-14 12:12:12,2021-06-14 18:12:12 1003,2021-06-14 13:12:12,2021-06-14 16:12:12 1004…

条款19 对共享资源使用std::shared_ptr

目录 一、std::shared_ptr 二、std::shared_ptr性能问题 三、control block的生成时机 四、std::shared_ptr可能存在的问题 五、使用this指针作为std::shared_ptr构造函数实参 六、std::shared_ptr不支持数组 一、std::shared_ptr<T> shared_ptr的内存模型如下图&…

巩义网站建设:如何打造一个成功的企业网站

巩义网站建设是企业发展中至关重要的一环。一个成功的企业网站不仅仅是一个展示产品和服务的平台&#xff0c;更是企业形象和品牌的代表。在建设企业网站时&#xff0c;首先要考虑用户体验。网站的设计应简洁明了&#xff0c;易于导航&#xff0c;让用户能够快速找到他们需要的…

【Maven】聚合与继承

目录 1. 聚合工程 2. 聚合工程开发 3. 继承关系 4. 继承关系开发 5. 聚合与继承的区别 1. 聚合工程 什么叫聚合&#xff1f; 聚合&#xff1a;将多个模块组织成一个整体&#xff0c;同时进行项目构建的过程称为聚合 聚合工程&#xff1a;通常是一个不具有业务功能的”空…