@ConfigurationProperties綁定配置信息至Array、List、Map、Bean


原文:https://blog.csdn.net/justry_deng/article/details/90758250

 

 

相關說明:
在SpringBoot中,我們可以通過以下幾種方式獲取並綁定配置文件中的信息:

@Value注解。

使用Environment。

@ConfigurationProperties注解。

通過實現ApplicationListener接口,注冊監聽器,進行硬編碼獲取,可參考https://blog.csdn.net/thc1987/article/details/78789426。

硬編碼加載文件獲取。

……

注:一般情況下,第一種、第二種就夠用了;但是如果想直接從配置文件中獲取到數組、list、map、對象的話,
       第一種和第二種的支持性不太好,目前只能獲取到數組、list,對map、bean的話,就有點束手無策了。
       這時我們可以使用第三種方式進行獲取。

環境說明:Windows10、IntelliJ IDEA、SpringBoot 2.1.5.RELEASE

@ConfigurationProperties注解獲取配置信息並綁定到對象上示例:
准備工作:引入spring-boot-configuration-processor依賴


給出本人完整的pom.xml文件:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.5.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.aspire.yaml-properties</groupId>
<artifactId>yaml-properties</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>yaml文件與properties文件語法示例</name>
<description>yaml文件與properties文件語法示例</description>

<properties>
<java.version>1.8</java.version>
</properties>

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
</dependency>
</dependencies>


<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>

</project>
加載demo.properties文件中的信息綁定到bean,並注入容器示例:
項目結構說明:

 

注:application.yml其實在本次演示中,沒有用到。不過本人給出了如何在yml文件中進行類似配置的
       示例(見本文末尾)。
       追注:如果要讀取的是yml或yaml中的文件,那么最好是直接寫在application.yml或
                  application.yaml文件中,寫在其他yml文件中的話,可能導致讀取失敗。
                  (P.S.如果是寫在其他yml或yaml文件中的話,只能通過最后一級key進行
                  定位,通過多級key可能定位不到。)

先給出一個等下會用到的Uer類:

 

注:上圖中的注解是快速開發lombok注解,也可以不使用這些注解,自己寫getter、setter等方法。

DemoConfig中是這樣的:

 

注:上圖中的@Data注解屬於快速開發lombok注解,該注解不是必須的,也可以不要該注解,自己手寫
        getter、setter、toString等。

deme.properties中是這樣的:

 

測試一下:

 

運行測試方法,控制台輸出(為了方便觀察,本人手動換行整理了一下輸出的內容):

 

由此可見,成功將demo.peoperties文件中的信息綁定到bean上,並注入Spring容器成功!

拓展:
如果是application.yml(或application.yaml)文件,類似的,我們可以這么配置:

 

  

^_^ 測試代碼托管鏈接
              https://github.com/JustryDeng/CommonRepository/tree/master
 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM