SpringBoot @ConfigurationProperties詳解
簡介
本文將會詳細講解@ConfigurationProperties在Spring Boot中的使用。
添加依賴關系
首先我們需要添加Spring Boot依賴：
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<relativePath/> <!-- lookup parent from repository -->
</parent>
一個簡單的例子
@ConfigurationProperties需要和@Configuration配合使用，我們通常在一個POJO里面進行配置：
@Data
@Configuration
@ConfigurationProperties(prefix = "mail")
public class ConfigProperties {
private String hostName;
private int port;
private String from;
}
上面的例子將會讀取properties文件中所有以mail開頭的屬性，並和bean中的字段進行匹配：
#Simple properties
mail.hostname=host@mail.com
mail.port=9000
mail.from=mailer@mail.com
Spring的屬性名字匹配支持很多格式，如下所示所有的格式都可以和hostName進行匹配：
mail.hostName
mail.hostname
mail.host_name
mail.host-name
mail.HOST_NAME
如果你不想使用@Configuration， 那么需要在@EnableConfigurationProperties注解中手動導入配置文件如下：
@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， 下面我們舉個例子，先創建一個普通的POJO：
@Data
public class Credentials {
private String authMethod;
private String username;
private String password;
}
然后創建一個嵌套的配置文件：
@Data
@Configuration
@ConfigurationProperties(prefix = "nestmail")
public class NestConfigProperties {
private String host;
private int port;
private String from;
private List<String> defaultRecipients;
private Map<String, String> additionalHeaders;
private Credentials credentials;
}
對應的屬性文件如下：
# nest Simple properties
nestmail.hostname=mailer@mail.com
nestmail.port=9000
nestmail.from=mailer@mail.com
#List properties
nestmail.defaultRecipients[0]=admin@mail.com
nestmail.defaultRecipients[1]=owner@mail.com
#Map Properties
nestmail.additionalHeaders.redelivery=true
nestmail.additionalHeaders.secure=true
#Object properties
nestmail.credentials.username=john
nestmail.credentials.password=password
nestmail.credentials.authMethod=SHA1
@ConfigurationProperties和@Bean
@ConfigurationProperties也可以和@Bean一起使用如下所示：
@Data
public class Item {
private String name;
private int size;
}
看下怎么使用：
@Data
@Configuration
public class BeanConfigProperties {
@Bean
@ConfigurationProperties(prefix = "item")
public Item item() {
return new Item();
}
}
屬性驗證
@ConfigurationProperties可以使用標准的JSR-303格式來做屬性驗證。我們舉個例子：
@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;
}
如果我們的屬性不滿足上訴條件，可能出現如下異常：
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 configuration
Process finished with exit code 1
屬性轉換
@ConfigurationProperties也支持多種屬性轉換，下面我們以Duration和DataSize為例：
我們定義兩個Duration的字段：
@ConfigurationProperties(prefix = "conversion")
public class PropertyConversion {
private Duration timeInDefaultUnit;
private Duration timeInNano;
...
}
在屬性文件中定義這兩個字段：
conversion.timeInDefaultUnit=10
conversion.timeInNano=9ns
我們看到上面的屬性可以帶單位的。可選的單位是：ns, us, ms, s, m, h 和 d，分別對應納秒，微妙，毫秒，秒，分鍾，小時和天。默認單位是毫秒。我們也可以在注解中指定單位：
@DurationUnit(ChronoUnit.DAYS)
private Duration timeInDays;
對應的配置文件如下：
conversion.timeInDays=2
下面我們再看看DataSize怎么使用：
private DataSize sizeInDefaultUnit;
private DataSize sizeInGB;
@DataSizeUnit(DataUnit.TERABYTES)
private DataSize sizeInTB;
對應的屬性文件：
conversion.sizeInDefaultUnit=300
conversion.sizeInGB=2GB
conversion.sizeInTB=4
Datasize支持B, KB, MB, GB 和TB。
自定義Converter
同樣的Spring Boot也支持自定義屬性轉換器。我們先定義一個POJO類：
public class Employee {
private String name;
private double salary;
}
對應的屬性文件：
conversion.employee=john,2000
我們需要自己實現一個Converter接口的轉換類：
@Component
@ConfigurationPropertiesBinding
public class EmployeeConverter implements Converter<String, Employee> {
@Override
public Employee convert(String from) {
String[] data = from.split(",");
return new Employee(data[0], Double.parseDouble(data[1]));
}
}
本文的例子可以參看: https://github.com/ddean2009/learn-springboot2/tree/master/springboot-ConfigurationProperties
更多教程請參考 flydean的博客