详解Spring获取配置的三种方式

详解Spring获取配置的三种方式

目录前言Spring中获取配置的三种方式通过@Value动态获取单个配置通过@ConfigurationProperties+前缀方式批量获取通过Environment动态获取单个配置总结

前言

最近在写框架时遇到需要根据特定配置（可能不存在）加载 bean 的需求，所以就学习了下 Spring 中如何获取配置的几种方式。

Spring 中获取配置的三种方式

通过 @Value 方式动态获取单个配置通过 @ConfigurationProperties + 前缀方式批量获取配置通过 Environment 动态获取单个配置

通过 @Value 动态获取单个配置

1.作用

可修饰到任一变量获取，使用较灵活

2.优点

使用简单，且使用关联的链路较短

3.缺点

配置名不能被有效枚举到每一个配置的使用都需重新定义，使用较为麻烦项目强依赖配置的定义，配置不存在则会导致项目无法启动

4.使用场景

项目强依赖该配置的加载，想要从源头避免因配置缺失导致的未知问题只想使用少数几个配置

5.代码示例

@Configuration

public class ConfigByValueAnnotation {

@Value("${server.port}")

private String serverPort;

public String getServerPort() {

return serverPort;

}

}

6.测试代码

@DisplayName("multipart get config")

@SpringBootTest

public class MultipartGetConfigTest {

private static final Logger log = LoggerFactory.getLogger(MultipartGetConfigTest.class);

@Autowired

private ConfigByValueAnnotation configByValueAnnotation;

@Test

public void getByValueAnnotation(){

log.info("get by @Value, value: {}", configByValueAnnotation.getServerPort());

}

}

7.测试结果

org.spring.demo.MultipartGetConfigTest   : get by @Value, value: 7100

通过@ConfigurationProperties+前缀方式批量获取

1.作用

用于配置类的修饰或批量配置的获取

2.优点

使用配置只需确定 key 的前缀即能使用，有利于批量获取场景的使用因采用前缀匹配，所以在使用新的相同前缀 key 的配置时无需改动代码

3.缺点

使用复杂，需定义配置类或者手动创建 bean 后引入使用增加新的前缀相同 key 时可能会引入不稳定因素

4.使用场景

需要同时使用多前缀相同 key 的配置期望增加新配置但不修改代码的 properties 注入

5.代码示例

@Component

@ConfigurationProperties(prefix = "server", ignoreInvalidFields = true)

public class ConfigByConfigurationProperties {

private Integer port;

public Integer getPort() {

return port;

}

public ConfigByConfigurationProperties setPort(Integer port) {

this.phttp://ort = port;

return this;

}

}

@Configuration

public class ConfigByConfigurationPropertiesV2 {

@Bean("configByValueAnnotationV2")

@ConfigurationProperties(prefix = "server2")

public Properties properties(){

return new Properties();

}

}

6.测试代码

@DisplayName("multipart get config")

@SpringBootTest

public class MultipartGetConfigTest {

private static final Logger log = LoggerFactory.getLogger(MultipartGetConfigTest.class);

@Autowired

private ConfigByConfigurationProperties configByConfigurationProperties;

@Autowired

@Qualifier("configByValueAnnotationV2")

private Properties properties;

@Test

public void getByConfigurationProperties(){

log.info("get by @ConfigurationProperties, value: {}", configByConfigurationProperties.getPort());

log.info("get by @ConfigurationProperties and manual create bean, value: {}", properties.getProperty("port"));

}

}

7.测试结果

org.spring.demo.MultipartGetConfigTest   : get by @ConfigurationProperties, value: 7100org.spring.demo.MultipartGetConfigTest   : get by @ConfigurationProperties and manual create bean, value: 7100

通过 Environment 动态获取单个配置

1.作用

用于动态在程序代码中获取配置，而配置 key 不需提前定义

2.优点

获取的配置的 key 可不提前定义，程序灵活性高配置 key 可使用枚举统一放置与管理

3.缺点

使用较复杂，需继承 Environment 接口形成工具类进行获取获取 key 对应的枚举与 key 定义分离，value 获取链路较长

4.使用场景

只需使用少量的配置获取配置的 key 无提前定义，需要根据对配置的有无进行灵活使用

5.代码示例

@Component

public class ConfigByEnvironment implements EnvironmentAware {

private static final Logger log = LoggerFactory.getLogger(ConfigByEnvironment.class);

private Environment environment;

public Optional get(String configKey){

String config = environment.getProperty(configKey);

return Objects.isNull(config) ? Optional.empty() : Optional.of(config);

}

public void get(String configKey, Consumer consumer){

Optional config = get(configKey);

if(!config.isPresent()){

log.warn("application config, get config by key fail, key: {}", configKey);

}

config.ifPresent(consumer);

}

@Override

public void setEnvironment(@NonNull Environment environment) {

this.environment = environment;

}

}

public enum ConfigByEnvironmentKey {

SERVER_PORT("server.port", "server port");

private String key;

private String description;

ConfigByEnvironmentKey(String key, String description) {

this.key = key;

this.description = description;

}

public String getKey() {

return key;

}

public String getDescription() {

return description;

}

}

6.测试代码

@DisplayName("multipart get config")

@SpringBootTest

public class MultipartGetConfigTest {

private static final Logger log = LoggerFactory.getLogger(MultipartGetConfigTest.class);

@Autowired

private ConfigByEnvironment configByEnvironment;

@Test

public void getByEnvironment(){

configByEnvironment.get(ConfigByEnvironmentKey.SERVER_PORT.getKey()).ifPresent(value -> log.info("get by environment, value: {}", value));

}

}

7.测试结果

org.spring.demo.MultipartGetConfigTest   : get by environment, value: 7100

总结

获取配置方式优点缺点使用场景通过 @Value 动态获取单个配置使用简单，且使用关联的链路较短1. 配置名不能被有效枚举到2. 每一个配置的使用都需重新定义，使用较为麻烦3. 项目强依赖配置的定义，配置不存在则会导致项目无法启动1. 项目强依赖该配置的加载，想要从源头避免因配置缺失导致的未知问题2. 只想使用少数几个配置通过 @ConfigurationProperties + 前缀方式批量获取1. 使用配置只需确定 key 的前缀即能使用，有利于批量获取场景的使用2. 因采用前缀匹配，所以在使用新的相同前缀 key 的配置时无需改动代码1. 使用复杂，需定义配置类或者手动创建 bean 后引入使用2. 增加新的前缀相同 key 时可能会引入不稳定因素1. 需要同时使用多前缀相同 key 的配置2. 期望增加新配置但不修改代码的 properties 注入通过 Environment 动态获取单个配置1. 获取的配置的 key 可不提前定义，程序灵活性高2. 配置 key 可使用枚举统一放置与管理1. 使用较复杂，需继承 Environment 接口形成工具类进行获取2. 获取 key 对应的枚举与 key 定义分离，value 获取链路较长1. 只需使用少量的配置2. 获取配置的 key 无提前定义，需要根据对配置的有无进行灵活使用

以上就是详解Spring获取配置的三种方式的详细内容，更多关于Spring 获取配置的资料请关注我们其它相关文章！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。