SpringBoot常用接口–EnvironmentPostProcessor
一般用于读取环境变量达到多个微服务共同配置的修改与维护。当我们有多套环境(开发、测试、生产等等)时,每套环境都有专属的配置文件存放于配置中心(以nacos为例),可能存放于不同的配置中心(每个环境有专属的配置中心,服务地址不同),也可能存放于同一nacos的不同命名空间,也或者同一命名空间的不同分组等等。同一套代码在不同环境运行需要不同的配置文件,这时,我们就可以在项目启动时,实现EnvironmentPostProcessor接口,在postProcessEnvironment方法中读取环境变量或者启动命令参数,从而获取本环境下nacos的服务地址,或命名空间名称、分组名称等等,然后就可以根据获取的配置参数或环境变量来读取不同的配置文件,从而实现不同环境使用不同的配置文件,不用修改代码或者本地配置文件。
一、场景
假设每套环境我们都使用了单独的nacos作为配置中心,但是域名(或IP)不同,而且我们服务的工作文件目录需要带上环境作为父目录,例如开发环境的工作目录为/usr/local/dev/;测试环境的工作目录为/usr/local/st/;开发环境目录为/usr/local/prod/;为了测试EnvironmentPostProcessor接口读取配置的位置,我们设置环境变量APP_ENV=dev/st/prod,根据服务器的环境进行配置,设置项目启动命令参数为-DREGISTRY_URL=xxx.xxx.xxx.xx:8848(或者域名也可以),不同的环境设置对应的nacos地址。然后微服务之间使用double进行远程调用,nacos作为dubbo的注册中心和元数据中心。
nacos的配置如下:
spring:
application:
name: myApplication
double:
metadata-report:
address: nacos://${REGISTRY_SERVER_URL:127.0.0.1:8848}
id: meta-center
registry:
address: nacos://${REGISTRY_SERVER_URL:127.0.0.1:8848}
id: my-registry
file:
home: /usr/local/${APPLICATION_ENV}/
二、创建EnvironmentPostProcessor实现类
当有多个PostProcessor时,需要结合Ordered来设置执行顺序。
因为spring中也有默认的PostProcessor,并且最后一个的order为Integer.MIN_VALUE+10,所以我们自定义的postProcesssor可以从Integer.MIN_VALUE+10之后开始排序。order越小,执行顺序越靠前。根据自己需要进行排序设置。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.Ordered;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.util.StringUtils;
import javax.management.InvalidApplicationException;
public class BootEnvironmentPostProcessor implements EnvironmentPostProcessor, Ordered {
/**
* 该接口一般用于读取配置信息,包括系统环境变量配置、启动时命令参数配置等等,可以根据配置选择使用对应环境的配置(有多套环境配置文件),
* 一般来说我们可以根据环境变量或启动参数中的配置,确定本项目使用的配置文件,然后读取配置文件将配置信息存入System.setProperty(key,value)中,
* 然后在需要读取(使用)配置的位置,使用System.getProperty(key)来获取value,这样就可以达到不同的环境使用不同的配置的目的。
* 例如:我们可以在启动命令参数或环境变量中配置nacos的server地址:REGISTRY_URL=xxx.xxx.xx.xx:8848,然后使用environment.getProperty("REGISTRY_URL")
* 获取值,然后使用System.setProperties()设置到系统变量中去,使用@ConfigurationProperties注解可以读取系统变量中的配置,
* 所以NacosConfigProperties类就可以读取到我们设置的nacos的地址,然后读取nacos配置中心中配置的yml文件,从而实现不同的环境使用不同的nacos配置和注册中心。
* System.setProperty()设置的配置,也可以在yml文件中使用${key}来获取。
* @param environment
* @param application
*/
@Override
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
try {
this.setEnvironment(environment);
} catch (InvalidApplicationException e) {
e.printStackTrace();
}
}
/**
* 也可以自定义注解配置这些参数,用于本地启动。
* @param environment
* @throws InvalidApplicationException
*/
private void setEnvironment(ConfigurableEnvironment environment) throws InvalidApplicationException {
String applicationName = environment.getProperty("APPLICATION_NAME");
if (!StringUtils.isEmpty(applicationName)){
System.setProperty("spring.application.name",applicationName);
}
String appEnv = environment.getProperty("APP_ENV");
String registry_url = environment.getProperty("REGISTRY_URL");
if(StringUtils.isEmpty(appEnv)||StringUtils.isEmpty(registry_url)){
throw new InvalidApplicationException("解析应用基本信息错误:nacosAddr="+registry_url+",appEnv="+appEnv);
}else {
System.setProperty("spring.cloud.nacos.config.server-addr", registry_url);
System.setProperty("spring.cloud.nacos.discovery.server-addr", registry_url);
System.setProperty("spring.cloud.nacos.config.file-extension", "yml");
System.setProperty("REGISTRY_SERVER_URL", registry_url);
System.setProperty("APPLICATION_ENV",appEnv);
}
}
/**
* 因为spring中也有默认的PostProcessor,并且最后一个的order为Integer.MIN_VALUE+10,所以我们自定义的postProcesssor可以从Integer.MIN_VALUE+10之后开始排序。
* order越小,执行顺序越靠前。根据自己需要进行排序设置。
* @return
*/
@Override
public int getOrder() {
return Integer.MIN_VALUE+10+1;
}
}
三、使用配置
因为System.setProperty()方法设置的参数,能使用@ConfigurationProperties注解可以读取系统变量中的配置。所以NacosConfigProperties类就可以读取到我们设置的nacos的地址,根据代理模式创建NacosConfigService类实现ConfigService接口,然后根据NacosConfigProperties读取到的配置连接配置中心,并通过配置类的@Bean注解注入到IOC容器中。项目其他地方可以通过自动注入使用NacosConfigService来读取nacos配置中心的配置。
import com.alibaba.cloud.nacos.NacosConfigProperties;
import com.alibaba.nacos.api.NacosFactory;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.Listener;
import com.alibaba.nacos.api.exception.NacosException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import javax.annotation.PostConstruct;
public class NacosConfigService implements ConfigService {
private static final Logger log = LoggerFactory.getLogger(NacosConfigService.class);
@Autowired
private NacosConfigProperties nacosConfigProperties;
private ConfigService configService;
public NacosConfigService() {
}
@PostConstruct
public void init() {
try {
this.configService = NacosFactory.createConfigService(this.nacosConfigProperties.getServerAddr());
} catch (NacosException e) {
e.printStackTrace();
}
}
@Override
public String getConfig(String s, String s1, long l) throws NacosException {
return this.configService.getConfig(s, s1, l);
}
@Override
public String getConfigAndSignListener(String s, String s1, long l, Listener listener) throws NacosException {
return this.configService.getConfigAndSignListener(s, s1, l, listener);
}
@Override
public void addListener(String s, String s1, Listener listener) throws NacosException {
this.configService.addListener(s, s1, listener);
}
@Override
public boolean publishConfig(String s, String s1, String s2) throws NacosException {
try {
boolean result = this.configService.publishConfig(s, s1, s2);
if (result) {
log.info("----------发布配置{},{},成功", s, s1);
} else {
log.info("----------发布配置{},{},失败", s, s1);
}
return result;
} catch (Exception e) {
return false;
}
}
@Override
public boolean publishConfig(String s, String s1, String s2, String s3) throws NacosException {
try {
boolean result = this.configService.publishConfig(s, s1, s2, s3);
if (result) {
log.info("----------发布配置{},{},{}成功", new Object[]{s, s1, s3});
} else {
log.info("----------发布配置{},{},{}失败", new Object[]{s, s1, s3});
}
return result;
} catch (Exception e) {
return false;
}
}
@Override
public boolean removeConfig(String s, String s1) throws NacosException {
return this.configService.removeConfig(s, s1);
}
@Override
public void removeListener(String s, String s1, Listener listener) {
this.configService.removeListener(s, s1, listener);
}
@Override
public String getServerStatus() {
return this.configService.getServerStatus();
}
@Override
public void shutDown() throws NacosException {
this.configService.shutDown();
}
}
对于项目目录,可以编写目录初始化类,来统一根据配置的项目根目录创建文件夹,例如log、file、image等等,将项目的各种文件分类存放。
对于存放于System中的系统变量,可以在项目的其他地方使用System.getPerproties(key)获取,也可以使用@ConfigurationProperties注解获取。