在 Spring 中如何设计一个获取配置的接口?

2022-09-05 2022-09-12 约 1200 字预计阅读 3 分钟

1. 需求

希望根据 propertyName 来获取相应的 propertyValue, 这个接口需要支持多种数据来源。

2. 设计接口

很明显这个接口应该设计为这样, 有一个方法为 Object getProperty(String name) 来获取属性。

因为是在 spring 中，所以我就直接复用了 org.springframework.core.env.PropertySource, 但这个类需要泛型，所以我就随便实现了一个 Map<String, String> 的泛型，也不会用到这个。

抽象类的设计如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
public abstract class AbstractSimplePropertySource extends PropertySource<Map<String, String>> implements EnvironmentAware {
	
	protected Environment environment;
	
	public AbstractSimplePropertySource(String name) {
		super(name, Collections.emptyMap());
	}
	
	public void setEnvironment(@NonNull Environment environment) {
		this.environment = environment;
	}
	
	public Environment getEnvironment() {
		return environment;
	}
	
}

3. 具体类的实现

3.1 根据请求参数来获取配置

先从请求参数中获取
再从请求头中获取

代码逻辑是比较简单的，我就不解释了。

这种形式，解决了前端可以传入相应的配置，来改变后端的执行逻辑。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@Order(0)
public class RequestParamsPropertySource extends AbstractSimplePropertySource {
	
	public RequestParamsPropertySource() {
		super(ENV_PREFIX + "request_params");
	}
	
	@Override
	public Object getProperty(String name) {
		String propertyKey = ENV_PREFIX + name.replace(".", "_");
		String propertyValue = null;
		try {
			// 先请求参数中获取
			ServletRequestAttributes attr = (ServletRequestAttributes) RequestContextHolder.currentRequestAttributes();
      HttpServletRequest request = attr.getRequest();
      propertyValue = request.getParameter(propertyKey);
			if (StringUtils.isBlank(propertyValue)) {
				// 再从请求头中获取
				propertyValue = request.getHeader(propertyKey);
			}
		} catch (Throwable ignored) {
		}
		// 空字符也当做null
		propertyValue = defaultIfBlank(propertyValue, null);
		return propertyValue;
	}
	
}

3.2 根据环境变量来获取配置

代码逻辑是比较简单的，我就不解释了。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
@Order(2)
public class EnvironmentPropertySource extends AbstractSimplePropertySource {
	
	public EnvironmentPropertySource() {
		super(ENV_PREFIX + "environment");
	}
	
	@Override
	public Object getProperty(String name) {
		String env_property_key = ENV_PREFIX + name.replace(".", "_");
		return System.getenv(env_property_key.toUpperCase());
	}
}

3.3 根据本地配置文件来获取参数

在实际开发过程，大家可能是共用一套数据库环境，在这个情况下，如果某一个人改了数据库配置，这样会对其他人造成影响，所以必须要设计出一个用于开发的配置类。

使用 apache 的 configuration 包，来实现配置文件的动态刷新
从 builder.getConfiguration() 对象中获取配置

大致代码如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@Order(1)
public class LocalPropertiesPropertySource extends AbstractSimplePropertySource implements InitializingBean {
	
	@Autowired
	private ApplicationEventPublisher publisher;
	
	private ReloadingFileBasedConfigurationBuilder<PropertiesConfiguration> builder;
	
	private static final String DEFAULT_LOCAL_PROPERTIES_PATH = "sysoptions.properties";
	
	public LocalPropertiesPropertySource() {
		super(ENV_PREFIX + "local_properties");
		log.debug("开发环境，启用[{}]配置", getClass());
	}
	
	@Override
	public void afterPropertiesSet() {
		Integer sysOptionsLoadInterval = getEnvironment().getProperty("dev.localPropertiesLoadInterval", Integer.class, 1);
		String sysOptionsPath = getEnvironment().getProperty("dev.localPropertiesPath", DEFAULT_LOCAL_PROPERTIES_PATH);
		File propertiesFile = new File(sysOptionsPath);
		if (!propertiesFile.exists()) {
			return;
		}
		
		// server boot will publish event
		publisher.publishEvent(new LocalProperitesReReloadingEvent(new Object(), propertiesFile.getAbsolutePath()));
		builder = new ReloadingFileBasedConfigurationBuilder<>(PropertiesConfiguration.class).configure(new Parameters().fileBased().setFile(propertiesFile));
		ReloadingController reloadingController = builder.getReloadingController();
		reloadingController.addEventListener(ReloadingEvent.ANY, e -> publisher.publishEvent(new LocalProperitesReReloadingEvent(e, propertiesFile.getAbsolutePath())));
		
		PeriodicReloadingTrigger trigger = new PeriodicReloadingTrigger(reloadingController, null, sysOptionsLoadInterval, SECONDS);
		trigger.start();
	}
	
	@Override
	public Object getProperty(@NonNull String name) {
		if (builder == null) return null;
		Configuration configuration = null;
		try {
			configuration = builder.getConfiguration();
			String config_value = configuration.getString(name);
			if (config_value != null) {
				return config_value;
			}
		} catch (ConfigurationException e) {
			log.error(e.getMessage(), e);
		}
		return null;
	}
}

3.4 其他的扩展

到这里，你就应该很清楚的知道怎么去扩展其他的类了，比如数据库的实现， redis 的实现

4. 使用的入口

上面只是定义了一个接口和几个实现类，统一的入口类，实际上还没有。

使用构造函数的方式来注入所有的 AbstractSimplePropertySource 。
对于每个获取配置的类，肯定有优先级，所以要排序。
使用 MutablePropertySources 这个类做辅助。

大致代码如下：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@Slf4j
@Order
public class CompositePropertySources implements PropertySources {
	
	private final MutablePropertySources mutablePropertySources = new MutablePropertySources();
	
	public CompositePropertySources(List<AbstractSimplePropertySource> sources) {
		if (sources == null) return;
		AnnotationAwareOrderComparator.sort(sources);
		for (AbstractSimplePropertySource source : sources) {
			mutablePropertySources.addLast(source);
		}
	}
	
	public boolean containsProperty(String name) {
		return stream().anyMatch(p -> p.containsProperty(name));
	}
	
	public String getProperty(String name) {
		return isBlank(name) ? name : getProperty(name, null);
	}
	
	public String getProperty(String propertyName, String defaultValue) {
		String value = null;
		for (PropertySource<?> ps : mutablePropertySources) {
			value = (String) ps.getProperty(propertyName);
			if (value != null) {
				return value;
			}
		}
		return defaultValue;
	}
	
	public Map<String, String> getProperties(String... propertyNames) {
		if (propertyNames != null) {
			Map<String, String> map = new HashMap<>();
			for (String key : propertyNames) {
				map.put(key, getProperty(key, null));
			}
			return map;
		}
		return null;
	}
}

5. 完整代码实现

github 地址

收录于合集・微信文章 18

在 Spring 中如何扩展现有类的功能 ? 在 Spring 中如何扩展现有类的功能2 ?