這篇文章主要講解了“SpringBoot中@ConfigurationProperties怎么使用”，文中的講解內(nèi)容簡單清晰，易于學(xué)習(xí)與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學(xué)習(xí)“SpringBoot中@ConfigurationProperties怎么使用”吧！

成都創(chuàng)新互聯(lián)從2013年成立，是專業(yè)互聯(lián)網(wǎng)技術(shù)服務(wù)公司，擁有項(xiàng)目成都網(wǎng)站制作、成都網(wǎng)站建設(shè)網(wǎng)站策劃，項(xiàng)目實(shí)施與項(xiàng)目整合能力。我們以讓每一個(gè)夢想脫穎而出為使命，1280元山丹做網(wǎng)站,已為上家服務(wù),為山丹各地企業(yè)和個(gè)人服務(wù),聯(lián)系電話:028-86922220

添加依賴關(guān)系

首先我們需要添加Spring Boot依賴：

 org.springframework.boot  spring-boot-starter-parent  

一個(gè)簡單的例子

@ConfigurationProperties需要和@Configuration配合使用，我們通常在一個(gè)POJO里面進(jìn)行配置：

@Data@Configuration@ConfigurationProperties(prefix = "mail")public class ConfigProperties {  private String hostName;  private int port;  private String from;}

上面的例子將會讀取properties文件中所有以mail開頭的屬性，并和bean中的字段進(jìn)行匹配：

#Simple propertiesmail.hostname=host@mail.commail.port=9000mail.from=mailer@mail.com

Spring的屬性名字匹配支持很多格式，如下所示所有的格式都可以和hostName進(jìn)行匹配：

mail.hostNamemail.hostnamemail.host_namemail.host-namemail.HOST_NAME

如果你不想使用@Configuration， 那么需要在@EnableConfigurationProperties注解中手動導(dǎo)入配置文件如下：

@SpringBootApplication@EnableConfigurationProperties(ConfigProperties.class)public class ConfigPropApp {  public static void main(String[] args) {    SpringApplication.run(ConfigPropApp.class,args);  }}

我們也可以在@ConfigurationPropertiesScan中指定Config文件的路徑:

@SpringBootApplication@ConfigurationPropertiesScan("com.flydean.config")public class ConfigPropApp {  public static void main(String[] args) {    SpringApplication.run(ConfigPropApp.class,args);  }}

這樣的話程序只會在com.flydean.config包中查找config文件。

屬性嵌套

我們可以嵌套class，list，map， 下面我們舉個(gè)例子，先創(chuàng)建一個(gè)普通的POJO：

@Datapublic class Credentials {  private String authMethod;  private String username;  private String password;}

然后創(chuàng)建一個(gè)嵌套的配置文件：

@Data@Configuration@ConfigurationProperties(prefix = "nestmail")public class NestConfigProperties {  private String host;  private int port;  private String from;  private List defaultRecipients;  private Map additionalHeaders;  private Credentials credentials;}

對應(yīng)的屬性文件如下：

# nest Simple propertiesnestmail.hostname=mailer@mail.comnestmail.port=9000nestmail.from=mailer@mail.com#List propertiesnestmail.defaultRecipients[0]=admin@mail.comnestmail.defaultRecipients[1]=owner@mail.com#Map Propertiesnestmail.additionalHeaders.redelivery=truenestmail.additionalHeaders.secure=true#Object propertiesnestmail.credentials.username=johnnestmail.credentials.password=passwordnestmail.credentials.authMethod=SHA1

@ConfigurationProperties和@Bean

@ConfigurationProperties也可以和@Bean一起使用如下所示：

@Datapublic class Item {  private String name;  private int size;}

看下怎么使用：

@Data@Configurationpublic class BeanConfigProperties {  @Bean  @ConfigurationProperties(prefix = "item")  public Item item() {    return new Item();  }}

屬性驗(yàn)證

@ConfigurationProperties可以使用標(biāo)準(zhǔn)的JSR-303格式來做屬性驗(yàn)證。我們舉個(gè)例子：

@Data@Validated@Configuration@ConfigurationProperties(prefix = "mail")public class ConfigProperties {  @NotEmpty  private String hostName;  @Min(1025)  @Max(65536)  private int port;  @Pattern(regexp = "^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,6}$")  private String from;}

如果我們的屬性不滿足上訴條件，可能出現(xiàn)如下異常：

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'mail' to com.flydean.config.ConfigProperties$$EnhancerBySpringCGLIB$$f0f87cb9 failed:  Property: mail.port  Value: 0  Reason: 最小不能小于1025  Property: mail.hostName  Value: null  Reason: 不能為空Action:Update your application's configurationProcess finished with exit code 1

屬性轉(zhuǎn)換

@ConfigurationProperties也支持多種屬性轉(zhuǎn)換，下面我們以Duration和DataSize為例：

我們定義兩個(gè)Duration的字段：

@ConfigurationProperties(prefix = "conversion")public class PropertyConversion {   private Duration timeInDefaultUnit;  private Duration timeInNano;  ...}

在屬性文件中定義這兩個(gè)字段：

conversion.timeInDefaultUnit=10conversion.timeInNano=9ns

我們看到上面的屬性可以帶單位的?？蛇x的單位是：ns, us, ms, s, m, h 和 d，分別對應(yīng)納秒，微妙，毫秒，秒，分鐘，小時(shí)和天。默認(rèn)單位是毫秒。我們也可以在注解中指定單位：

@DurationUnit(ChronoUnit.DAYS)private Duration timeInDays;

對應(yīng)的配置文件如下：

conversion.timeInDays=2

下面我們再看看DataSize怎么使用：

private DataSize sizeInDefaultUnit; private DataSize sizeInGB; @DataSizeUnit(DataUnit.TERABYTES)private DataSize sizeInTB;

對應(yīng)的屬性文件：

conversion.sizeInDefaultUnit=300conversion.sizeInGB=2GBconversion.sizeInTB=4

Datasize支持B, KB, MB, GB 和TB。

自定義Converter

同樣的Spring Boot也支持自定義屬性轉(zhuǎn)換器。我們先定義一個(gè)POJO類：

public class Employee {  private String name;  private double salary;}

對應(yīng)的屬性文件：

conversion.employee=john,2000

我們需要自己實(shí)現(xiàn)一個(gè)Converter接口的轉(zhuǎn)換類：

@Component@ConfigurationPropertiesBindingpublic class EmployeeConverter implements Converter {   @Override  public Employee convert(String from) {    String[] data = from.split(",");    return new Employee(data[0], Double.parseDouble(data[1]));  }}

感謝各位的閱讀，以上就是“SpringBoot中@ConfigurationProperties怎么使用”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對SpringBoot中@ConfigurationProperties怎么使用這一問題有了更深刻的體會，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是創(chuàng)新互聯(lián)，小編將為大家推送更多相關(guān)知識點(diǎn)的文章，歡迎關(guān)注！