知識庫 / Spring / Spring Boot RSS 訂閱

@Configuration
@ConfigurationProperties(prefix = "convert")
public class PropertyConversion {

    private DataSize uploadSpeed;

    @DataSizeUnit(DataUnit.GIGABYTES)
    private DataSize downloadSpeed;

    private Duration backupDay;

    @DurationUnit(ChronoUnit.HOURS)
    private Duration backupHour;

    // getters and setters
}

我們將會檢查轉換結果：

@ExtendWith(SpringExtension.class)
@EnableConfigurationProperties(value = PropertyConversion.class)
@ContextConfiguration(classes = CustomCredentialsConverter.class)
@TestPropertySource("classpath:spring-conversion-test.properties")
public class SpringPropertiesConversionUnitTest {

    @Autowired
    private PropertyConversion propertyConversion;

    @Test
    void whenUsingSpringDefaultSizeConversion_thenDataSizeObjectIsSet() {
        assertEquals(DataSize.ofMegabytes(500), propertyConversion.getUploadSpeed());
        assertEquals(DataSize.ofGigabytes(10), propertyConversion.getDownloadSpeed());
    }

    @Test
    void whenUsingSpringDefaultDurationConversion_thenDurationObjectIsSet() {
        assertEquals(Duration.ofDays(1), propertyConversion.getBackupDay());
        assertEquals(Duration.ofHours(8), propertyConversion.getBackupHour());
    }
}

6.2. 自定義轉換器

現在我們假設我們要轉換 convert.credentials 屬性：

convert.credentials=user,123

進入以下 Credential 類：

public class Credentials {

    private String username;
    private String password;

    // getters and setters
}

要實現這一點，我們可以實現一個自定義轉換器：

@Component
@ConfigurationPropertiesBinding
public class CustomCredentialsConverter implements Converter<String, Credentials> {

    @Override
    public Credentials convert(String source) {
        String[] data = source.split(",");
        return new Credentials(data[0], data[1]);
    }
}

最後，我們將向 PropertyConversion 類添加一個 Credentials 字段：

public class PropertyConversion {
    private Credentials credentials;
    // ...
}

在我們的 SpringPropertiesConversionUnitTest 測試類中，還需要添加 @ContextConfiguration 以在 Spring 的上下文中註冊自定義轉換器：

// other annotations
@ContextConfiguration(classes=CustomCredentialsConverter.class)
public class SpringPropertiesConversionUnitTest {
    
    //...
    
    @Test
    void whenRegisteringCustomCredentialsConverter_thenCredentialsAreParsed() {
        assertEquals("user", propertyConversion.getCredentials().getUsername());
        assertEquals("123", propertyConversion.getCredentials().getPassword());
    }
}

正如之前的斷言所展示的，Spring 使用了我們的自定義轉換器來解析 convert.credentials 屬性為 Credentials 實例

7. YAML 文檔綁定

對於層次化配置數據，YAML 配置可能更方便。YAML 還支持在同一個文檔中定義多個配置文件。

以下 application.yml 位於 src/test/resources/ 中，定義了 ServerConfig 類中的“test” 配置文件：

spring:
  config:
    activate:
      on-profile: test
server:
  address:
    ip: 192.168.0.4
  resources_path:
    imgs: /etc/test/imgs
---
# other profiles

因此，以下測試將通過：

@ExtendWith(SpringExtension.class)
@ContextConfiguration(initializers = ConfigDataApplicationContextInitializer.class)
@EnableConfigurationProperties(value = ServerConfig.class)
@ActiveProfiles("test")
public class BindingYMLPropertiesUnitTest {

    @Autowired
    private ServerConfig serverConfig;

    @Test
    void whenBindingYMLConfigFile_thenAllFieldsAreSet() {
        assertEquals("192.168.0.4", serverConfig.getAddress().getIp());

        // other assertions ...
    }
}

關於我們使用的註解的一些説明:

• @ContextConfiguration(initializers = ConfigDataApplicationContextInitializer.class) – 加載 application.yml 文件
• @ActiveProfiles(“test”) – 指定在本次測試中使用 “test” 配置文件

請記住， neither @ProperySource nor @TestProperySource 支持加載 .yml 文件。 因此，我們應該始終將我們的 YAML 配置放在 application.yml 文件中。

8. 覆蓋 @ConfigurationProperties<</em/> 配置

@TestPropertySource(properties = {"validate.mail_config.address=new_user@test"})

assertEquals("new_user@test", mailServer.getMailConfig().getAddress());