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

 更新时间:2026年02月13日 09:08:43   作者:java进阶之路2023  
本文主要介绍了深入解析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)。

示例代码:

package com.yicrm.biz.config;


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

/**
 * <p>
 * uops-service配置
 * </p>
 *
 * @author zhaozhijun
 * @since 2026-01-07
 */

@Data
@Component
@ConfigurationProperties(prefix = "media-service")
public class MediaServiceConfig {

    //短视频路径
    private String path;

    //短视频路径-特殊租户
    private String path2;

    //直播路径
    private String broadcastPath;
    private String broadcastPath2;
    //token
    private String token;

    private String userId;

    private String companyId;
}

解释:

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

2. 配置文件

application.propertiesapplication.yml文件中定义配置属性。

示例代码(application.properties):

media-service:
  path: https://***.ai/media-service/internal/dataApi/video/getCompanyCoreMetrics
  token: a5a6ae52b97f08e6847bbaf9bc054c13af797525
  userId: 3569
  companyId: 311

3. 启用配置属性支持

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

package com.yicrm;

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

/**
 * 启动程序
 */
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class})
@EnableConfigurationProperties(AppProperties.class)
public class YiCrmApplication {
    public static void main(String[] args) {
        // System.setProperty("spring.devtools.restart.enabled", "false");
        // 关闭 PageHelper banner
        System.setProperty("pagehelper.banner", "false");
//        // 设置无头模式,避免在无图形界面的服务器环境中出现 X11FontManager 初始化错误
//        System.setProperty("java.awt.headless", "true");
        SpringApplication.run(YiCrmApplication.class, args);
        System.out.println("(♥◠‿◠)ノ゙  YI-CRM启动成功   ლ(´ڡ`ლ)゙");
    }
}

到此这篇关于深入解析Spring Boot中的@ConfigurationProperties注解的文章就介绍到这了,更多相关SpringBoot @ConfigurationProperties内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • itext生成PDF设置页眉页脚的实例详解

    itext生成PDF设置页眉页脚的实例详解

    这篇文章主要介绍了itext生成PDF设置页眉页脚的实例详解的相关资料,希望通过本文能帮助到大家,需要的朋友可以参考下
    2017-09-09
  • JAVA-4NIO之Channel之间的数据传输方法

    JAVA-4NIO之Channel之间的数据传输方法

    下面小编就为大家带来一篇JAVA-4NIO之Channel之间的数据传输方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • Java 并行流(parallelStream)的具体使用小结

    Java 并行流(parallelStream)的具体使用小结

    parallelStream是Java 8中的一种流处理方式,通过并行流利用多核CPU提高数据处理效率,本文主要介绍了Java 并行流(parallelStream)的具体使用小结,具有一定的参考价值,感兴趣的可以了解一下
    2025-11-11
  • Java在Linux上调用FFmpeg实现视频截图的完整指南

    Java在Linux上调用FFmpeg实现视频截图的完整指南

    在Linux环境下使用Java与FFmpeg命令交互进行视频截图是多媒体处理中的常见任务,本文介绍了如何在Java程序中执行FFmpeg命令,通过提供具体代码示例来展示在特定时间点获取视频静态图像的方法,需要的朋友可以参考下
    2025-08-08
  • 详解Spring配置事务的五种方式

    详解Spring配置事务的五种方式

    这篇文章主要为大家详细介绍了Spring配置事务的五种方式,感兴趣的小伙伴们可以参考一下
    2016-06-06
  • 浅析SpringBoot统一返回结果的实现

    浅析SpringBoot统一返回结果的实现

    前后端开发过程中数据交互规范化是一件非常重要的事情,不仅可以减少前后端交互过程中出现的问题,也让代码逻辑更加具有条理,下面小编就和大家讲讲SpringBoot如何统一返回结果的吧
    2023-07-07
  • JAVA实现长连接(含心跳检测Demo)

    JAVA实现长连接(含心跳检测Demo)

    这篇文章主要介绍了JAVA实现长连接(含心跳检测Demo),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • SpringBoot之QueryDsl嵌套子查询问题

    SpringBoot之QueryDsl嵌套子查询问题

    这篇文章主要介绍了SpringBoot之QueryDsl嵌套子查询问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-03-03
  • 详解SimpleDateFormat的线程安全问题与解决方案

    详解SimpleDateFormat的线程安全问题与解决方案

    这篇文章主要介绍了SimpleDateFormat的线程安全问题与解决方案,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2017-03-03
  • Java时间工具类Date的常用处理方法

    Java时间工具类Date的常用处理方法

    在Java中获取当前时间,可以使用 java.util.Date 类和 java.util.Calendar 类完成。其中,Date 类主要封装了系统的日期和时间的信息,下面将详细介绍Date类的常用处理方法,需要的可以参考一下
    2022-05-05

最新评论