快捷導(dǎo)航

SpringBoot如何將applicaton.properties中的數(shù)據(jù)綁定到bean中

更新時(shí)間：2025年05月16日 11:17:05 作者：cg5017

SpringBoot中我們?cè)撊绾螌pplicaton.properties中的數(shù)據(jù)綁定到bean中呢？在之間我們是可以通過@value注解,在SpringBoot自動(dòng)啟動(dòng)后,會(huì)自動(dòng)的去相應(yīng)的路徑中去尋找applicaton.properties配置文件,然后將相應(yīng)的值賦值上,感興趣的朋友一起看看吧

一、回顧@value注解

SpringBoot中我們?cè)撊绾螌pplicaton.properties中的數(shù)據(jù)綁定到bean中呢？在之間我們是可以通過@value注解，在SpringBoot自動(dòng)啟動(dòng)后，會(huì)自動(dòng)的去相應(yīng)的路徑中去尋找applicaton.properties配置文件，然后將相應(yīng)的值賦值上?；仡櫲缦拢?/p>

spring.application.name=properties-location
myapp.name=classpath:/config

//納入IoC容器管理
@Component
public class appConfig {
    @Value("${myapp.name}")
    private String appPath;
    public void printInfo(){
        System.out.println("App Path: " + appPath);
    }
}

如上的方式就可以很好的將配置文件中的信息注入到bean對(duì)象中，但是一但配置文件中的要注入bean對(duì)象的信息過多的話，那我們就需要寫非常多個(gè)@value的注解，這樣就會(huì)非常的麻煩。

二、將配置綁定到簡單bean

使用注解@ConfigurationProperties(prefix="myapp")就可以把后面都依次注入，示例如下。

applicaton.properties中的配置內(nèi)容如下：

spring.application.name=demo4
myapp.configName=test
myapp.configId=1234
myapp.configValue=value
myapp.configKey=1234

想將applicaton.properties中的配置內(nèi)容賦值到Cogfig這個(gè)bean對(duì)象中。通過@ConfigurationProperties(prefix="myapp")來實(shí)現(xiàn)，且需要注意的是，要寫上每個(gè)要被賦值屬性的setter方法，因?yàn)槠湓诒毁x值的時(shí)候是通過setter方法進(jìn)行賦值的。同時(shí)需要注意屬性名要和applicaton.properties中的配置一致。

package com.example.demo4;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "myapp")
public class Config {
    private String configName;
    private String configId;
    private String configValue;
    private String configKey;
    public void setConfigName(String configName) {
        this.configName = configName;
    }
    public void setConfigId(String configId) {
        this.configId = configId;
    }
    public void setConfigValue(String configValue) {
        this.configValue = configValue;
    }
    public void setConfigKey(String configKey) {
        this.configKey = configKey;
    }
    @Override
    public String toString() {
        return "Config{" +
                "configName='" + configName + '\'' +
                ", configId='" + configId + '\'' +
                ", configValue='" + configValue + '\'' +
                ", configKey='" + configKey + '\'' +
                '}';
    }
}

測(cè)試結(jié)果如下：

package com.example.demo4;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class Demo4ApplicationTests {
    @Autowired
    Config config;
    @Test
    void test0() {
        System.out.println(config.toString());
    }
}
輸出：Config{configName='test', configId='1234', configValue='value', configKey='1234'}

三、將配置綁定到嵌套bean

就是其實(shí)有時(shí)候綁定的bean并不是單一的，是復(fù)雜的。

private String configName;
private String configId;
private String configValue;
private String configKey;
private ConfigLocation configLocation;

例如在其中有些bean對(duì)象中，其屬性可能就不是單一的屬性，也可能如private ConfigLocation configLocation;一樣，本身也是一個(gè)對(duì)象，那么像這種嵌套的bean對(duì)象又如何注入呢？其實(shí)方式是一樣的，也是通過注解@ConfigurationProperties來實(shí)現(xiàn)配置到bean的注入。

其ConfigLocation如下。

package com.example.demo4;
public class ConfigLocation {
    private String configCountry;
    private String configState;
    public void setConfigCountry(String configCountry) {
        this.configCountry = configCountry;
    }
    public void setConfigState(String configState) {
        this.configState = configState;
    }
    @Override
    public String toString() {
        return "ConfigLocation{" +
                "configCountry='" + configCountry + '\'' +
                ", configState='" + configState + '\'' +
                '}';
    }
}

只需要其applicaton.properties的格式改一下就可以實(shí)現(xiàn)。

spring.application.name=demo4
myapp.configName=test
myapp.configId=1234
myapp.configValue=value
myapp.configKey=1234
myapp.configLocation.configCountry=china
myapp.configLocation.configState=LiaoNing

測(cè)試結(jié)果如下：

也是綁定成功了。

四、@EnableConfigurationProperties

@EnableConfigurationProperties的使用方法是在其主入口類上添加該注解，并將啟動(dòng)的配置信息綁定到Config的bean對(duì)象上去。

package com.example.demo4;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
@SpringBootApplication
@EnableConfigurationProperties(Config.class)
public class Demo4Application {
    public static void main(String[] args) {
        SpringApplication.run(Demo4Application.class, args);
    }
}

同時(shí)Config這個(gè)bean對(duì)象上不用在使用@Component注解了。