快捷導航

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

更新時間：2026年02月13日 09:08:43 作者：java進階之路2023

本文主要介紹了深入解析Spring Boot中的@ConfigurationProperties注解,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

在Spring Boot框架中，配置管理是一個核心功能。Spring Boot提供了多種方式來處理外部配置，其中@ConfigurationProperties注解是一個非常強大且靈活的工具。本文將深入探討@ConfigurationProperties注解的概念、用法、工作原理、配置綁定、類型安全以及如何在實際開發(fā)中應(yīng)用它。

什么是@ConfigurationProperties？

@ConfigurationProperties是Spring Boot提供的一個注解，用于將外部配置屬性綁定到Java對象上。通過使用這個注解，開發(fā)者可以將配置文件（如application.properties或application.yml）中的屬性值自動映射到Java類的字段上，從而實現(xiàn)配置的集中管理和類型安全。

@ConfigurationProperties的作用

配置綁定：將配置文件中的屬性值綁定到Java類的字段上，實現(xiàn)配置的自動映射。
類型安全：提供類型安全的配置綁定，避免類型轉(zhuǎn)換錯誤。
復雜配置：支持復雜配置結(jié)構(gòu)的綁定，如嵌套對象、集合、Map等。
配置校驗：結(jié)合@Valid注解，實現(xiàn)配置屬性的校驗。

@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.properties或application.yml文件中定義配置屬性。

示例代碼（application.properties）：

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

3. 啟用配置屬性支持

在Spring Boot應(yīng)用的主類或配置類上，使用@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");
        // 關(guān)閉 PageHelper banner
        System.setProperty("pagehelper.banner", "false");
//        // 設(shè)置無頭模式，避免在無圖形界面的服務(wù)器環(huán)境中出現(xiàn) X11FontManager 初始化錯誤
//        System.setProperty("java.awt.headless", "true");
        SpringApplication.run(YiCrmApplication.class, args);
        System.out.println("(????)??  YI-CRM啟動成功   ?(′?`?)?");
    }
}

到此這篇關(guān)于深入解析Spring Boot中的@ConfigurationProperties注解的文章就介紹到這了,更多相關(guān)SpringBoot @ConfigurationProperties內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: