知識庫 / Spring / Spring Boot RSS 訂閱

Spring 對於屬性綁定使用了一些寬鬆的規則。因此，以下變體都會綁定到 hostName 屬性上：

mail.hostName
mail.hostname
mail.host_name
mail.host-name
mail.HOST_NAME

因此，我們可以使用以下屬性文件來設置所有字段：

#Simple properties
[email protected]
mail.port=9000
[email protected]

3.1. Spring Boot 2.2

自 Spring Boot 2.2 以來，Spring 通過 classpath 掃描查找並註冊 <em @ConfigurationProperties</em> 類。<em @ConfigurationProperties</em> 掃描需要顯式啓用，通過添加 <em @ConfigurationPropertiesScan</em> 註解即可。因此，我們無需使用 <em @Component</em> (以及其他元註解，如 <em @Configuration</em>) 註釋這些類，也不需要使用 <em @EnableConfigurationProperties</em>。

@ConfigurationProperties(prefix = "mail") 
@ConfigurationPropertiesScan 
public class ConfigProperties { 

    private String hostName; 
    private int port; 
    private String from; 

    // standard getters and setters 
}

通過 @SpringBootApplication 啓用類路徑掃描器可以找到 ConfigProperties 類，即使我們沒有用 @Component 註解此類。

此外，我們還可以使用 @ConfigurationPropertiesScan 註解來掃描自定義位置以查找配置屬性類。

@SpringBootApplication
@ConfigurationPropertiesScan("com.baeldung.configurationproperties")
public class EnableConfigurationDemoApplication { 

    public static void main(String[] args) {   
        SpringApplication.run(EnableConfigurationDemoApplication.class, args); 
    } 
}

這樣 Spring 才會只在 com.baeldung.properties 包中查找配置屬性類。

4. 嵌套屬性

我們可以擁有嵌套屬性，存在於列表、映射和類中。

讓我們創建一個新的 憑據 類來使用嵌套屬性：

public class Credentials {
    private String authMethod;
    private String username;
    private String password;

    // standard getters and setters
}

我們還需要更新 ConfigProperties 類，使其使用 List, Map, 以及 Credentials 類。

public class ConfigProperties {

    private String hostname;
    private int port;
    private String from;
    private List<String> defaultRecipients;
    private Map<String, String> additionalHeaders;
    private Credentials credentials;
 
    // standard getters and setters
}

以下屬性文件將設置所有字段：

#Simple properties
[email protected]
mail.port=9000
[email protected]

#List properties
mail.defaultRecipients[0][email protected]
mail.defaultRecipients[1][email protected]

#Map Properties
mail.additionalHeaders.redelivery=true
mail.additionalHeaders.secure=true

#Object properties
mail.credentials.username=john
mail.credentials.password=password
mail.credentials.authMethod=SHA1

5. 使用 @ConfigurationProperties 在 @Bean 方法上

我們也可以在 @Bean 註解的方法上使用 @ConfigurationProperties 註解。

這種方法在我們需要將屬性綁定到超出我們控制範圍的第三方組件時尤其有用。

讓我們創建一個簡單的 Item 類，我們將在此示例中使用它：

public class Item {
    private String name;
    private int size;

    // standard getters and setters
}

現在讓我們看看如何使用 @ConfigurationProperties 在 @Bean 方法中將外部化屬性綁定到 Item 實例：

@Configuration
public class ConfigProperties {

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

@NotBlank
private String hostName;

@Length(max = 4, min = 1)
private String authMethod;

@Min(1025)
@Max(65536)
private int port;

@Pattern(regexp = "^[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,6}$")
private String from;

@ConfigurationProperties(prefix = "conversion")
public class PropertyConversion {

    private Duration timeInDefaultUnit;
    private Duration timeInNano;
    ...
}

conversion.timeInDefaultUnit=10
conversion.timeInNano=9ns