新闻资讯

新闻资讯 通知公告

SpringBoot @ConfigurationProperties详解

编辑:016     时间:2020-02-15

添加依赖关系

首先我们需要添加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;
} 复制代码

上面的示例将会重新读取属性文件中所有以邮件开头的属性,并和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包中查找配置文件。

属性嵌套

我们可以嵌套类,列表,地图,下面我们举个例子,先创建一个普通的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 复制代码

数据大小支持B,KB,MB,GB和TB。

自定义转换器

同样的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]));
    }
}
郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。

回复列表