快捷導(dǎo)航

基于@ConfigurationProperties的三種用法及說(shuō)明

更新時(shí)間：2026年06月04日 08:35:04 作者：我叫晨曦啊

SpringBoot配置屬性綁定詳解,介紹@Component若您配置類(lèi)、@ConfigurationProperties綁定屬性及三種常見(jiàn)應(yīng)用場(chǎng)景,附帶代碼示例與測(cè)試步驟

@ConfigurationProperties

告訴SpringBoot將本類(lèi)中的所有屬性和配置文件中相關(guān)的配置進(jìn)行綁定，若進(jìn)行綁定，首先這個(gè)類(lèi)要受Spring管理，spring才能操作里面的數(shù)據(jù)，有三種使用場(chǎng)景，而通常情況下使用的最多的只是其中的一種場(chǎng)景。

本文介紹一下三種場(chǎng)景的使用情況，若有錯(cuò)誤還請(qǐng)各位大佬批評(píng)指正！

第一種

@Component和@ConfigurationProperties放在bean定義類(lèi)上。

1、新建application.yml配置文件

person:
  id: 1
  name: 張三

2、定義一個(gè)bean

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

import java.io.Serializable;

@Component
@ConfigurationProperties(prefix = "person")
@Data
public class Person implements Serializable {
    private Integer id;
    private String name;
}

3、測(cè)試

import com.gwm.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class SpringBootConfigTest {

    @Autowired
    private Person person;
    
    @Test
    public void  test01(){
        System.out.println(person.getId() +"==="+ person.getName());
    }
}

4、結(jié)果

第二種

@ConfigurationProperties和@Bean注解在配置類(lèi)的Bean定義方法上。

1、配置文件添加

dataSource:
  url: jdbc:mysql://localhost:3306/springboottest?allowMultiQueries=true&serverTimezone=Asia/Shanghai

2、新建配置類(lèi)

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class TestConfig {
	// 注意：配置文件中是大小寫(xiě)混合的，prefix中要全部小寫(xiě)，否則會(huì)報(bào)錯(cuò)
    @ConfigurationProperties(prefix = "datasource")
    @Bean
    public DruidDataSource duidDataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        return dataSource;
    }
}

3、測(cè)試

import com.alibaba.druid.pool.DruidDataSource;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class SpringBootConfigTest {
    @Autowired
    private DruidDataSource druidDataSource;

    @Test
    public void  test02(){
        System.out.println(druidDataSource.getUrl());
    }
}

4、結(jié)果

第三種

@ConfigurationProperties注解到普通類(lèi)，然后啟動(dòng)類(lèi)添加@EnableConfigurationProperties定義為Bean。此處以第一種的代碼為例，做修改即可。

1、注釋@Component注解

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

import java.io.Serializable;

//@Component
@ConfigurationProperties(prefix = "person")
@Data
public class Person implements Serializable {
    private Integer id;
    private String name;
}

2、啟動(dòng)類(lèi)新加注解

import com.gwm.pojo.Person;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

// 注解后面要加上開(kāi)啟配置的類(lèi)----->類(lèi)名.class
@EnableConfigurationProperties({Person.class})
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

3、測(cè)試

import com.gwm.pojo.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class SpringBootConfigTest {

    @Autowired
    private Person person;
    
    @Test
    public void  test01(){
        System.out.println(person.getId() +"==="+ person.getName());
    }
}

4、結(jié)果