@ConfigurationProperties加載外部配置方式

更新時間：2023年03月13日 09:48:16 作者：oneslide

這篇文章主要介紹了@ConfigurationProperties加載外部配置方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

@ConfigurationProperties加載外部配置

@ConfigurationProperties可以將外部配置文件（比如applicaition.properties）加載進來，填充對象的對應(yīng)字段的數(shù)據(jù)，然后供其他Bean使用。

整個項目結(jié)構(gòu)是這樣的：

在這里插入圖片描述

這里我寫了一個外部配置文件(application.yml)：

environment:
  production:
    url: http://production.example.com
    name: production mode
  dev:
    url: http://dev.example.com
    name: developer mode

可以看見配置文件的數(shù)據(jù)有結(jié)構(gòu)化特點，即可以生成一個相應(yīng)的對象。

應(yīng)該是這個樣子：

class Environment{
     Production production;
     Dev dev;
     class Production{
           String url;
           String name;
     }
     class Dev{
           String url;
           String name;
     }
}

真實的代碼是這個樣子：

在這里插入圖片描述

@Configuration   //配置類注解，被自動掃描發(fā)現(xiàn)
@PropertySource("classpath:application.yml") //指明配置源文件位置
@ConfigurationProperties("environment") //指明前綴
public class EnvConfig {
    private final Dev dev=new Dev();
    private final Production production=new Production();


    public Dev getDev() {
        return dev;
    }
   //getXXX必須中xxx和字段名production嚴格一致，否則出異常，即使松弛綁定，也要這樣
    public Production getProduction() {
        return production;
    }

    public static class Dev{
        private String url;
        private String name;

        public String getUrl() {
            return url;
        }

        public void setUrl(String url) {
            this.url = url;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }
        //toString
    }
    public static class Production{
        private String url;
        private String name;
        //setter and getter省略
       //toString
    }
   //toString()
}

下面測試一下：

@Controller
public class TestStaticController {
    Logger log= LoggerFactory.getLogger(TestStaticController.class);
    @Autowired
    public EnvConfig env;

    @GetMapping("/envtest")
    public String getEnv(){
        log.info(this.env.toString());
        return "test";
    }
}

通過發(fā)送HTTP請求，將會在日志中看到：

可以看見，外部配置文件填充了對象EnvConfig，并可以被容器自動注入到其他對象中。

另外，外部配置文件映射成對象還有其他技術(shù)如：映射成數(shù)組，Map…

@ConfigurationProperties與@EnableConfigurationProperties

@EnableConfigurationProperties注解的作用是：使用 @ConfigurationProperties 注解的類生效。

如果一個配置類只配置@ConfigurationProperties注解，而沒有使用@Component，那么在IOC容器中是獲取不到properties 配置文件轉(zhuǎn)化的bean。說白了 @EnableConfigurationProperties 相當于把使用 @ConfigurationProperties 的類進行了一次注入

@EnableConfigurationProperties 文檔中解釋：

當@EnableConfigurationProperties注解應(yīng)用到你的@Configuration時，任何被@ConfigurationProperties注解的beans將自動被Environment屬性配置。這種風格的配置特別適合與SpringApplication的外部YAML配置進行配合使用。

@ConfigurationProperties(prefix = "service.properties")
public class HelloServiceProperties {
    private static final String SERVICE_NAME = "test-service";

    private String msg = SERVICE_NAME;
       set/get
}


@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix = "hello", value = "enable", matchIfMissing = true)
public class HelloServiceAutoConfiguration {

}

@RestController
public class ConfigurationPropertiesController {

    @Autowired
    private HelloServiceProperties helloServiceProperties;

    @RequestMapping("/getObjectProperties")
    public Object getObjectProperties () {
        System.out.println(helloServiceProperties.getMsg());
        return myConfigTest.getProperties();
    }
}

自動配置設(shè)置（只是在配置文件的）

service.properties.name=my-test-name
service.properties.ip=192.168.1.1
service.user=kayle
service.port=8080

一切正常，但是 HelloServiceAutoConfiguration 頭部不使用 @EnableConfigurationProperties，測訪問報錯。

不使用 @EnableConfigurationProperties 進行注冊，使用 @Component 注冊

@ConfigurationProperties(prefix = "service.properties")
@Component
public class HelloServiceProperties {
    private static final String SERVICE_NAME = "test-service";

    private String msg = SERVICE_NAME;

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

}

Controller 不變，一切正常，如果注釋掉 @Component 測啟動報錯。

由此證明，兩種方式都是將被 @ConfigurationProperties 修飾的類，加載到 Spring Env 中