SpringBoot2底層注解@ConfigurationProperties如何配置綁定

本篇內容介紹了“SpringBoot2底層注解@ConfigurationProperties如何配置綁定”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

我們通常會把一些經常變動的東西放到配置文件里。

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

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

整個場景其實就是把配置文件里的所有配置，綁定到 java bean 里面。

要完成這個場景，基于 java 原生代碼編寫還是有點麻煩的。通常會做一個封裝，讀取到properties文件中的內容，并且把它封裝到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，然后遍歷配置文件中的每一個k-v，獲取之后就可以用到對應的地方。

在 springboot 中簡化了這個過程，這就是配置綁定。

配置綁定

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

新建一個組件Car，有2個屬性分別是品牌和價格：

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

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

mycar.brand=QQmycar.price=9999

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

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

傳進去的 prefix 是配置文件里的前綴，這里就是 mycar。

驗證

現在來測試一下是否綁定成功，在之前的HelloController繼續增加一個控制器方法:

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

部署一下應用，瀏覽器訪問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)傳入要開啟配置的類，這可以自動的把 Car 注冊到容器中，也就是說之前 Car 上的@Component就不需要了。

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

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

關于第二種的使用場景，比如這里的 Car 是一個第三方包里的類，但是人家源碼沒有加@Component注解，這時候就可以用這種方式進行綁定。

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

“SpringBoot2底層注解@ConfigurationProperties如何配置綁定”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！