SpringBoot2底層注解@ConfigurationProperties的配置綁定

我們通常會(huì)把一些經(jīng)常變動(dòng)的東西放到配置文件里。

比如之前寫在配置文件application.properties里的端口號(hào)server.port=8080，另外常見的還有數(shù)據(jù)庫的連接信息等等。

那么，我的數(shù)據(jù)庫連接信息放在配置文件里，我要使用的話肯定得去解析配置文件，解析出的內(nèi)容在 bean 里面去使用。

整個(gè)場(chǎng)景其實(shí)就是把配置文件里的所有配置，綁定到 java bean 里面。

要完成這個(gè)場(chǎng)景，基于 java 原生代碼編寫還是有點(diǎn)麻煩的。通常會(huì)做一個(gè)封裝，讀取到properties文件中的內(nèi)容，并且把它封裝到JavaBean中：

public class getProperties {
     public static void main(String[] args) throws FileNotFoundException, IOException {
         Properties pps = new Properties();
         pps.load(new FileInputStream("a.properties"));
         Enumeration enum1 = pps.propertyNames();//得到配置文件的名字
         while(enum1.hasMoreElements()) {
             String strKey = (String) enum1.nextElement();
             String strValue = pps.getProperty(strKey);
             System.out.println(strKey + "=" + strValue);
             //封裝到JavaBean
             ... ...
         }
     }

這里就是使用Properties類來加載配置文件a.properties，然后遍歷配置文件中的每一個(gè)k-v，獲取之后就可以用到對(duì)應(yīng)的地方。

在 springboot 中簡(jiǎn)化了這個(gè)過程，這就是配置綁定。

配置綁定

通過使用注解@ConfigurationProperties來完成配置綁定，注意需要結(jié)合@Component使用。

新建一個(gè)組件Car，有2個(gè)屬性分別是品牌和價(jià)格：

@Component
public class Car {
    private String brand;
    private Integer price;
// get set tostring 就不貼了

在配置文件application.properties，設(shè)置一些屬性值，比如：

mycar.brand=QQmycar.price=9999

使用@ConfigurationProperties注解，加到組件上：

mycar.brand=QQ
mycar.price=9999

傳進(jìn)去的 prefix 是配置文件里的前綴，這里就是 mycar。

驗(yàn)證

現(xiàn)在來測(cè)試一下是否綁定成功，在之前的HelloController繼續(xù)增加一個(gè)控制器方法:

@RestController
public class HelloController {
    @Autowired
    Car car;
    @RequestMapping("/car")
    public Car car() {
        return car;
    }
    @RequestMapping("/hello")
    public String Hello() {
        return "Hello SpringBoot2 你好";
    }
}

部署一下應(yīng)用，瀏覽器訪問http://localhost:8080/car:

綁定成功。

另一種方式

除上述方法之外，還可以使用@EnableConfigurationProperties + @ConfigurationProperties的方式來完成綁定。

注意，@EnableConfigurationProperties注解要使用在配置類上，表示開啟屬性配置的功能：

//@ConditionalOnBean(name = "pet1")
@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = true)
@ImportResource("classpath:beans.xml")  //配置文件的類路徑
@EnableConfigurationProperties(Car.class) //開啟屬性配置的功能
public class MyConfig {
 
    @Bean("user1")
    public User user01(){
        User pingguo = new User("pingguo",20);
        pingguo.setPet(tomcatPet());
        return pingguo;
    }
 
    @Bean("pet22")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

@EnableConfigurationProperties(Car.class)傳入要開啟配置的類，這可以自動(dòng)的把 Car 注冊(cè)到容器中，也就是說之前 Car 上的@Component就不需要了。

//@Component
@ConfigurationProperties(prefix = "mycar")
public class Car {
    private String brand;
    private Integer price;

重新部署訪問下地址，依然可以。

關(guān)于第二種的使用場(chǎng)景，比如這里的 Car 是一個(gè)第三方包里的類，但是人家源碼沒有加@Component注解，這時(shí)候就可以用這種方式進(jìn)行綁定。

最后，要記住當(dāng)使用@ConfigurationProperties(prefix = "mycar")這個(gè)配置綁定時(shí)，是跟 springboot 核心配置文件 application.properties文件的內(nèi)容建立的綁定關(guān)系。

以上就是SpringBoot2底層注解@ConfigurationProperties配置綁定的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot2注解配置綁定的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論