Подробное объяснение Springboot @configurationProperties

Spring Boot

Подробное объяснение 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>

простой пример

@ConfigurationSproperties потребности и @configuration используются в сочетании с, мы обычно настраиваются в POJO внутри:

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

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

В приведенном выше примере будут считаны все свойства, начинающиеся с почты, в файле свойств и сопоставлены с полями в 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:

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

В этом случае программа найдет файл конфигурации в пакете com.flydean.config.

вложение свойств

Мы можем вложить класс, список, карту.Давайте возьмем пример и сначала создадим обычный 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:

@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

Размер данных поддерживает B, КБ, МБ, ГБ и ТБ.

Пользовательский конвертер

Тот же Spring Boot также поддерживает пользовательские преобразователи свойств. Сначала мы определяем класс POJO:

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

Соответствующий файл свойств:

conversion.employee=john,2000

Нам нужно реализовать их конвертер, преобразующий интерфейс класса:

@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]));
    }
}

Примеры этой статьи можно найти в:GitHub.com/Dadean2009/приходите…

Больше учебных пособий, пожалуйста, обратитесь кБлог Флайдина

Категории