快捷導(dǎo)航

使用@ConfigurationProperties實(shí)現(xiàn)類型安全的配置過程

更新時(shí)間：2023年02月13日 10:34:49 作者：思影影思

這篇文章主要介紹了使用@ConfigurationProperties實(shí)現(xiàn)類型安全的配置過程，具有很好的參考價(jià)值，希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

@ConfigurationProperties實(shí)現(xiàn)類型安全的配置

問題描述

從之前@Value的使用，可以知道@Value可以靈活的把配置文件中的鍵值對的值注入到Bean中供我們使用，已經(jīng)很靈活了，但這還不夠，比如下述的application.properties

tomcat.ip=192.168.1.110
tomcat.port=8787
tomcat.projectName=screenshot
tomcat.userName=admin
tomcat.password=admin

如果也要按照之前的描述，使用@value就要填寫5次，這顯然令人惆悵，在程序員的世界里，所有重復(fù)性的工作都應(yīng)該被取代，因此Spring Boot為我們提供了@ConfigurationProperties注解。

實(shí)踐

application.properties

tomcat.ip=192.168.1.110
tomcat.port=8787
tomcat.projectName=screenshot

從上述的配置項(xiàng)中，可以看到明顯的相似性，即這一簇配置均以tomcat開始，類似String類中的startWith函數(shù)。

核心代碼

package com.wisely.ch6_2_3.config;

import lombok.Getter;
import lombok.Setter;
import lombok.extern.log4j.Log4j;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "tomcat") //1
@Log4j
public class TomcatSetting {
    @Getter
    @Setter
    private String ip;
    @Getter
    @Setter
    private int port;
    @Getter
    @Setter
    private String projectName;

    public String getUrl() {
        return "http://"+getIp()+"/"+getPort()+"/"+getProjectName();
    }

}

通過這種方法，即可實(shí)現(xiàn)一次性注入相似的配置，非常方便。

減少了重復(fù)性工作，即提高優(yōu)雅度，也能減少錯(cuò)誤，很酷。

關(guān)于ConfigurationProperties注解的說明

下文筆者講述Spring Boot中ConfigurationProperties注解的相關(guān)說明

如下所示：

我們都知道在Spring中，可以使用@Value對單個(gè)屬性進(jìn)行注入配置操作

但是很多配置都具有一定的層級(jí)，那么此時(shí)Spring提供了一個(gè)基于層級(jí)配置的注解

如下所示：

@ConfigurationProperties注解的功能：

將properties屬性和一個(gè)Bean及其屬性關(guān)聯(lián)
從而實(shí)現(xiàn)類型安全配置

例：

@ConfigurationProperties加載properties文件內(nèi)的配置使用prefix屬性指定配置文件中定義的properties配置的統(tǒng)一前綴

@ConfigurationProperties(prefix = "remote"}) ?

---Spring Boot1.5之前，使用以下配置指定properties文件的位置

@ConfigurationProperties(prefix = "remote",locations={"classpath:remote.properties"})?

示例代碼如下:

remote.address= www.java265.com
remote.port= 9090

?
@Component
@PropertySource({"classpath:remote.properties"})
@ConfigurationProperties(prefix = "remote")
public class RemoteConfig {
? ??
? ? private String address;
? ? private int port;
? ? // getter/stetter方法
}

對應(yīng)RemoteConfig的Bean的使用：

@RestController
public class ConfigurationController {
? ? @Resource
? ? private RemoteConfig remoteConfig;
? ? @GetMapping
? ? public void getInfo() {
? ? ? ? System.out.println("地址：" + remoteConfig.getAddress());
? ? ? ? System.out.println("端口：" + remoteConfig.getPort());
? ? }
}

//測試
@SpringBootTest
@AutoConfigureMockMvc
class ConfigurationControllerTest {
? ? @Autowired
? ? private MockMvc mockMvc;
? ? @Test
? ? void getInfo() throws Exception {
? ? ? ? mockMvc.perform(MockMvcRequestBuilders.get("/"));
? ? }
}

-----運(yùn)行以上代碼，將輸出以下信息------
地址：www.java265.com
端口：9090

例：

@ConfigurationProperties注解應(yīng)用于Bean方法上的示例分享

例：

@Configuration
public class MyConfig {
? ? @Bean
? ? @ConfigurationProperties(prefix = "user")
? ? public User user() {
? ? ? ? return new User();
? ? }
}