Spring Boot,注解,@ConfigurationProperties

news2025/6/5 20:28:48

好的,这是上面关于 @ConfigurationProperties 注解和 setter 方法的判断题及其解析的中文版本:


该判断题表述为:“使用@ConfigurationProperties 注解注入属性值时,必须为对应的属性提供setter方法。”

这个说法是 正确的。


@ConfigurationProperties 与 Setter 方法 ⚙️

在 Spring Boot 中使用 @ConfigurationProperties 注解将外部配置属性绑定到一个 Java bean 时,通常情况下,必须为希望绑定的字段提供 setter 方法。Spring Boot 的数据绑定工具主要使用这些 setter 方法(或者在使用构造函数绑定时使用构造函数参数)来填充字段。


关键知识点 🔑

  • @ConfigurationProperties 的目的:此注解提供了一种便捷的方式,可以将层级的配置属性(来自 application.propertiesapplication.yml)映射到一个强类型的 Java 对象。
  • 绑定机制:Spring Boot 使用其数据绑定机制。当一个对象被 @ConfigurationProperties 注解并被启用(例如,通过 @EnableConfigurationProperties 或其本身是一个 @Component)时,Spring 将尝试将与指定 prefix 匹配的属性绑定到该对象的字段上。
  • Setter 方法的要求:对于标准的 Java Bean 属性绑定,公共的 setter 方法是主要的实现机制。Setter 方法的名称必须遵循标准的 Java Bean 约定(例如,对于字段 myProperty,setter 方法应该是 setMyProperty(String myProperty))。
  • Lombok:如果你正在使用 Lombok,在你的配置属性类上添加 @Data@Setter 注解会自动生成所需的 setter 方法,从而减少样板代码。
  • 构造函数绑定 (Constructor Binding):作为 setter 方法的替代方案,尤其适用于不可变的配置对象,Spring Boot 支持构造函数绑定。你可以通过以下方式启用:
    • 在类上添加 @ConstructorBinding(在旧版 Spring Boot 中,如果存在多个构造函数或想明确指定时是必需的;在新版本中,如果只有一个参数化的构造函数,它通常会自动用于绑定配置属性)。
    • 提供一个构造函数,其参数名称与属性名称匹配(经过宽松绑定规范化后)。
    • 如果希望实现不可变性,可以将字段声明为 final
    • 在这种情况下,通过构造函数注入的字段不需要 setter 方法。
  • 宽松绑定 (Relaxed Binding):Spring Boot 使用“宽松绑定”规则,这意味着配置文件中的属性名称不必与 Java 类中的字段名或 setter 方法名完全一致。例如,YAML 中的 my-property-name 可以映射到 Java 中的 myPropertyName
  • 启用 @ConfigurationProperties
    • 在一个 @Configuration 类上使用 @EnableConfigurationProperties(YourPropertiesClass.class)
    • 或者,如果属性类本身就是一个 Spring bean(例如,用 @Component 注解),它将被自动处理。

实际案例 (使用 Setter 方法)

假设你在 application.yml 中有以下配置:

app:
  info:
    name: 我的超赞应用
    version: 1.0.2
    server-url: https://api.example.com

你的 Java 配置属性类将如下所示:

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component; // 或者使用 @EnableConfigurationProperties

@Component // 使其成为 Spring bean 并有资格进行 @ConfigurationProperties 处理
@ConfigurationProperties(prefix = "app.info")
public class AppInfoProperties {

    private String name;
    private String version;
    private String serverUrl; // 字段名经过宽松绑定后与 server-url 匹配

    // 'name' 的 Setter 方法
    public void setName(String name) {
        this.name = name;
    }

    // 'version' 的 Setter 方法
    public void setVersion(String version) {
        this.version = version;
    }

    // 'serverUrl' 的 Setter 方法
    public void setServerUrl(String serverUrl) {
        this.serverUrl = serverUrl;
    }

    // 可选: Getter 方法以访问属性
    public String getName() {
        return name;
    }

    public String getVersion() {
        return version;
    }

    public String getServerUrl() {
        return serverUrl;
    }

    @Override
    public String toString() {
        return "AppInfoProperties{" +
               "name='" + name + '\'' +
               ", version='" + version + '\'' +
               ", serverUrl='" + serverUrl + '\'' +
               '}';
    }
}

在其他组件中的使用:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import jakarta.annotation.PostConstruct;

@Service
public class AppService {

    private final AppInfoProperties appInfoProperties;

    @Autowired
    public AppService(AppInfoProperties appInfoProperties) {
        this.appInfoProperties = appInfoProperties;
    }

    @PostConstruct
    public void init() {
        System.out.println("应用名称: " + appInfoProperties.getName());
        System.out.println("应用版本: " + appInfoProperties.getVersion());
        System.out.println("服务器 URL: " + appInfoProperties.getServerUrl());
        System.out.println(appInfoProperties.toString());
    }
}

如果你从 AppInfoProperties 类中移除 setServerUrl 方法,那么 serverUrl 字段将不会从配置文件中填充(它会保持为 null),除非你切换到构造函数绑定。这证明了对于基于字段的、使用 @ConfigurationProperties 的属性注入,setter 方法的必要性。

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

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

相关文章

AIGC学习笔记(9)——AI大模型开发工程师

文章目录 AI大模型开发工程师008 LangChain之Chains模块1 Chain模块核心知识2 Chain模块代码实战LLMSequentialTransformationRouter AI大模型开发工程师 008 LangChain之Chains模块 1 Chain模块核心知识 组合常用的模块 LLM:最常见的链式操作类型SequentialChain…

Keil MDK5.37或更高版本不再预装ARM Compiler Version5导致编译错误的解决方法

Keil MDK5.37预装的是最新的ARM Compiler Version6 我们可以先右击查看工程属性 在Target标签下,我们可以看到Compiler Version5就是丢失的 在Target标签下,我们可以看到Compiler Version5就是丢失的 图1 以固件库方式编程,编译之后全是错…

Unity-UI组件详解

今天我们来学习Unity的UI的详解,这部分的内容相对较少,对于程序员来说主要的工作是负责将各种格式的图片呈现在显示器上并允许操作这些图片。 本篇帖子的理论依据依然是官方开源的UGUI代码,网址为:GitHub - Unity-Technologies/u…

黑马点评完整代码(RabbitMQ优化)+简历编写+面试重点 ⭐

简历上展示黑马点评 完整代码地址 项目描述 黑马点评项目是一个springboot开发的前后端分离项目,使用了redis集群、tomcat集群、MySQL集群提高服务性能。类似于大众点评,实现了短信登录、商户查询缓存、优惠卷秒杀、附近的商户、UV统计、用户签到、好…

Java 大视界 -- Java 大数据在智能安防视频监控中的异常事件快速响应与处理机制(273)

💖亲爱的朋友们,热烈欢迎来到 青云交的博客!能与诸位在此相逢,我倍感荣幸。在这飞速更迭的时代,我们都渴望一方心灵净土,而 我的博客 正是这样温暖的所在。这里为你呈上趣味与实用兼具的知识,也…

【数据库】安全性

数据库安全性控制的常用方法:用户标识和鉴定、存取控制、视图、审计、数据加密。 1.用户标识与鉴别 用户标识与鉴别(Identification & Authentication)是系统提供的最外层安全保护措施。 2.存取控制 2.1自主存取控制(简称DAC) (1)同一用户对于不同的数据对…

【图像处理入门】4. 图像增强技术——对比度与亮度的魔法调节

摘要 图像增强是改善图像视觉效果的核心技术。本文将详解两种基础增强方法:通过直方图均衡化拉伸对比度,以及利用伽马校正调整非线性亮度。结合OpenCV代码实战,学会处理灰度图与彩色图的不同增强策略,理解为何彩色图像需在YUV空间…

HALCON 深度学习训练 3D 图像的几种方式优缺点

HALCON 深度学习训练 3D 图像的几种方式优缺点 ** 在计算机视觉和工业检测等领域,3D 图像数据的处理和分析变得越来越重要,HALCON 作为一款强大的机器视觉软件,提供了多种深度学习训练 3D 图像的方式。每种方式都有其独特的设计思路和应用场…

FreeRTOS的简单介绍

一、FreeRTOS介绍 FreeRTOS并不是实时操作系统,因为它是分时复用的 利用CubeMX快速移植 二、快速移植流程 1. 在 SYS 选项里,将 Debug 设为 Serial Wire ,并且将 Timebase Source 设为 TIM2 (其它定时器也行)。为何…

深入解析C++引用:从别名机制到函数特性实践

1.C引用 1.1引用的概念和定义 引用不是新定义⼀个变量,而是给已存在变量取了⼀个别名,编译器不会为引用变量开辟内存空间,它和它引用的变量共用同⼀块内存空间。比如四大名著中林冲,他有一个外号叫豹子头,类比到C里就…

项目交付后缺乏回顾和改进,如何持续优化

项目交付后缺乏回顾和改进可通过建立定期回顾机制、实施反馈闭环流程、开展持续学习和培训、运用数据驱动分析、培养持续改进文化来持续优化。 其中,实施反馈闭环流程尤其重要,它能够确保反馈信息得到有效传递、处理与追踪,形成良好的改进生态…

从0开始学习R语言--Day15--非参数检验

非参数检验 如果在进行T检验去比较两组数据差异时,假如数据里存在异常值,会把数据之间的差异拉的很大,影响正常的判断。那么这个时候,我们可以尝试用非参数检验的方式来比较数据。 假设我们有A,B两筐苹果&#xff0c…

EC2 实例详解:AWS 的云服务器怎么玩?☁️

弹性计算、灵活计费、全球可用,AWS EC2 全攻略 在 AWS 生态中,有两个核心服务是非常关键的,一个是 S3(对象存储),另一个就是我们今天的主角 —— Amazon EC2(Elastic Compute Cloud&#xff09…

第三发 DSP 点击控制系统

背景 ​ 在第三方 DSP 上投放广告,需要根据 DP Link 的点击次数进行控制。比如当 DP Link 达到 5000 后,后续的点击将不能带来收益,但是后续的广告却要付出成本。因此需要建立一个 DP Link 池,当 DP Link 到达限制后,…

【笔记】在 MSYS2 MINGW64 环境中降级 NumPy 2.2.6 到 2.2.4

📝 在 MSYS2 MINGW64 环境中降级 NumPy 到 2.2.4 ✅ 目标说明 在 MSYS2 的 MINGW64 工具链环境中,将 NumPy 从 2.2.6 成功降级到 2.2.4。 🧰 环境信息 项目内容操作系统Windows 11MSYS2 终端类型MINGW64(默认终端)Py…

vue入门环境搭建及demo运行

提示:写完文章后,目录可以自动生成,如何生成可参考右边的帮助文档 文章目录 vue简介:第一步:安装node.jsnode简介第二步:安装vue.js第三步:安装vue-cli工具第四步 :安装webpack第五步…

原始数据去哪找?分享15个免费官方网站

目录 一、找数据的免费官方网站 (一)国家级数据宝库:权威且全面 1.中国国家统计局 2.香港政府数据中心 3.OECD数据库 (二)企业情报中心:洞察商业本质 4.巨潮资讯 5.EDGAR数据库 6.天眼查/企查查&a…

宝塔部署 Vue + NestJS 全栈项目

宝塔部署 Vue NestJS 全栈项目 前言一、Node.js版本管理器1、安装2、配置 二、NestJS项目管理(等同Node项目)1、Git安装2、拉取项目代码3、无法自动认证4、添加Node项目5、配置防火墙(两道) 三、Vue项目管理1、项目上传2、Nginx安…

# [特殊字符] Unity UI 性能优化终极指南 — LayoutGroup篇

🎯 Unity UI 性能优化终极指南 — LayoutGroup篇 🧩 什么是 LayoutGroup? LayoutGroup 是一类用于 自动排列子节点 的UI组件。 代表组件: HorizontalLayoutGroupVerticalLayoutGroupGridLayoutGroup 可以搭配: Conte…

2024-2025-2-《移动机器人设计与实践》-复习资料-8……

2024-2025-2-《移动机器人设计与实践》-复习资料-1-7-CSDN博客 08 移动机器人基础编程 单选题(6题) 在ROS中,用于移动机器人速度控制的消息类型通常是? A. std_msgs/StringB. geometry_msgs/TwistC. sensor_msgs/ImageD. nav_ms…