Spring Cloud针对Environment的属性源性能做了加强，
在spring-cloud-contenxt这个包中，提供了PropertySourceLocator接口，用来实现属性文件加载的扩大。咱们能够通过这个接口来扩大本人的内部化配置加载。这个接口的定义如下
public interface PropertySourceLocator { /** * @param environment The current Environment. * @return A PropertySource, or null if there is none. * @throws IllegalStateException if there is a fail-fast condition. */ PropertySource<?> locate(Environment environment);}locate这个形象办法，须要返回一个PropertySource对象。
这个PropertySource就是Environment中存储的属性源。 也就是说，咱们如果要实现自定义内部化配置加载，只须要实现这个接口并返回PropertySource即可。
依照这个思路，咱们依照上面几个步骤来实现内部化配置的自定义加载。
自定义PropertySource
既然PropertySourceLocator须要返回一个PropertySource，那咱们必须要定义一个本人的PropertySource，来从内部获取配置起源。
GpDefineMapPropertySource 示意一个以Map后果作为属性起源的类。
/** * 咕泡教育，ToBeBetterMan * Mic老师微信: mic4096 * 微信公众号： 跟着Mic学架构 * https://ke.gupaoedu.cn * 应用Map作为属性起源。 **/public class GpDefineMapPropertySource extends MapPropertySource { /** * Create a new {@code MapPropertySource} with the given name and {@code Map}. * * @param name the associated name * @param source the Map source (without {@code null} values in order to get * consistent {@link #getProperty} and {@link #containsProperty} behavior) */ public GpDefineMapPropertySource(String name, Map<String, Object> source) { super(name, source); } @Override public Object getProperty(String name) { return super.getProperty(name); } @Override public String[] getPropertyNames() { return super.getPropertyNames(); }}扩大PropertySourceLocator
扩大PropertySourceLocator，重写locate提供属性源。
而属性源是从gupao.json文件加载保留到自定义属性源GpDefineMapPropertySource中。
public class GpJsonPropertySourceLocator implements PropertySourceLocator { //json数据起源 private final static String DEFAULT_LOCATION="classpath:gupao.json"; //资源加载器 private final ResourceLoader resourceLoader=new DefaultResourceLoader(getClass().getClassLoader()); @Override public PropertySource<?> locate(Environment environment) { //设置属性起源 GpDefineMapPropertySource jsonPropertySource=new GpDefineMapPropertySource ("gpJsonConfig",mapPropertySource()); return jsonPropertySource; } private Map<String,Object> mapPropertySource(){ Resource resource=this.resourceLoader.getResource(DEFAULT_LOCATION); if(resource==null){ return null; } Map<String,Object> result=new HashMap<>(); JsonParser parser= JsonParserFactory.getJsonParser(); Map<String,Object> fileMap=parser.parseMap(readFile(resource)); processNestMap("",result,fileMap); return result; } //加载文件并解析 private String readFile(Resource resource){ FileInputStream fileInputStream=null; try { fileInputStream=new FileInputStream(resource.getFile()); byte[] readByte=new byte[(int)resource.getFile().length()]; fileInputStream.read(readByte); return new String(readByte,"UTF-8"); } catch (IOException e) { e.printStackTrace(); }finally { if(fileInputStream!=null){ try { fileInputStream.close(); } catch (IOException e) { e.printStackTrace(); } } } return null; } //解析残缺的url保留到result汇合。 为了实现@Value注入 private void processNestMap(String prefix,Map<String,Object> result,Map<String,Object> fileMap){ if(prefix.length()>0){ prefix+="."; } for (Map.Entry<String, Object> entrySet : fileMap.entrySet()) { if (entrySet.getValue() instanceof Map) { processNestMap(prefix + entrySet.getKey(), result, (Map<String, Object>) entrySet.getValue()); } else { result.put(prefix + entrySet.getKey(), entrySet.getValue()); } } }}Spring.factories
在/META-INF/spring.factories文件中，增加上面的spi扩大，让Spring Cloud启动时扫描到这个扩大从而实现GpJsonPropertySourceLocator的加载。
org.springframework.cloud.bootstrap.BootstrapConfiguration=\ com.gupaoedu.env.GpJsonPropertySourceLocator编写controller测试
@RestControllerpublic class ConfigController { @Value("${custom.property.message}") private String name; @GetMapping("/") public String get(){ String msg=String.format("配置值:%s",name); return msg; }}阶段性总结
通过上述案例能够发现，基于Spring Boot提供的PropertySourceLocator扩大机制，能够轻松实现自定义配置源的扩大。
于是，引出了两个问题。
- PropertySourceLocator是在哪个被触发的？
- 既然可能从
gupao.json中加载数据源，是否能从近程服务器上加载呢？
PropertySourceLocator加载原理
先来摸索第一个问题，PropertySourceLocator的执行流程。
SpringApplication.run
在spring boot我的项目启动时，有一个prepareContext的办法，它会回调所有实现了ApplicationContextInitializer的实例，来做一些初始化工作。
ApplicationContextInitializer是Spring框架原有的货色， 它的次要作用就是在,ConfigurableApplicationContext类型(或者子类型)的ApplicationContext做refresh之前，容许咱们对ConfiurableApplicationContext的实例做进一步的设置和解决。
它能够用在须要对应用程序上下文进行编程初始化的web应用程序中，比方依据上下文环境来注册propertySource，或者配置文件。而Config 的这个配置核心的需要恰好须要这样一个机制来实现。
public ConfigurableApplicationContext run(String... args) { //省略代码... prepareContext(context, environment, listeners, applicationArguments, printedBanner); //省略代码 return context;}PropertySourceBootstrapConfiguration.initialize
其中,PropertySourceBootstrapConfiguration就实现了ApplicationContextInitializer，initialize办法代码如下。
@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) { List<PropertySource<?>> composite = new ArrayList<>(); //对propertySourceLocators数组进行排序，依据默认的AnnotationAwareOrderComparator AnnotationAwareOrderComparator.sort(this.propertySourceLocators); boolean empty = true; //获取运行的环境上下文 ConfigurableEnvironment environment = applicationContext.getEnvironment(); for (PropertySourceLocator locator : this.propertySourceLocators) { //回调所有实现PropertySourceLocator接口实例的locate办法，并收集到source这个汇合中。 Collection<PropertySource<?>> source = locator.locateCollection(environment); if (source == null || source.size() == 0) { //如果source为空，间接进入下一次循环 continue; } //遍历source，把PropertySource包装成BootstrapPropertySource退出到sourceList中。 List<PropertySource<?>> sourceList = new ArrayList<>(); for (PropertySource<?> p : source) { sourceList.add(new BootstrapPropertySource<>(p)); } logger.info("Located property source: " + sourceList); composite.addAll(sourceList);//将source增加到数组 empty = false; //示意propertysource不为空 } //只有propertysource不为空的状况，才会设置到environment中 if (!empty) { //获取以后Environment中的所有PropertySources. MutablePropertySources propertySources = environment.getPropertySources(); String logConfig = environment.resolvePlaceholders("${logging.config:}"); LogFile logFile = LogFile.get(environment); // 遍历移除bootstrapProperty的相干属性 for (PropertySource<?> p : environment.getPropertySources()) { if (p.getName().startsWith(BOOTSTRAP_PROPERTY_SOURCE_NAME)) { propertySources.remove(p.getName()); } } //把后面获取到的PropertySource，插入到Environment中的PropertySources中。 insertPropertySources(propertySources, composite); reinitializeLoggingSystem(environment, logConfig, logFile); setLogLevels(applicationContext, environment); handleIncludedProfiles(environment); }}上述代码逻辑阐明如下。
- 首先
this.propertySourceLocators，示意所有实现了PropertySourceLocators接口的实现类，其中就包含咱们后面自定义的GpJsonPropertySourceLocator。 - 依据默认的 AnnotationAwareOrderComparator 排序规定对propertySourceLocators数组进行排序。
- 获取运行的环境上下文ConfigurableEnvironment
- 遍历propertySourceLocators时
- 调用 locate 办法，传入获取的上下文environment
- 将source增加到PropertySource的链表中
- 设置source是否为空的标识标量empty
- source不为空的状况，才会设置到environment中
- 返回Environment的可变模式，可进行的操作如addFirst、addLast
- 移除propertySources中的bootstrapProperties
- 依据config server覆写的规定，设置propertySources
- 解决多个active profiles的配置信息
留神：this.propertySourceLocators这个汇合中的PropertySourceLocator，是通过主动拆卸机制实现注入的，具体的实现在BootstrapImportSelector这个类中。ApplicationContextInitializer的了解和应用
ApplicationContextInitializer是Spring框架原有的货色， 它的次要作用就是在,ConfigurableApplicationContext类型(或者子类型)的ApplicationContext做refresh之前，容许咱们对ConfiurableApplicationContext的实例做进一步的设置和解决。
它能够用在须要对应用程序上下文进行编程初始化的web应用程序中，比方依据上下文环境来注册propertySource，或者配置文件。而Config 的这个配置核心的需要恰好须要这样一个机制来实现。
创立一个TestApplicationContextInitializer
public class TestApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext>{ @Override public void initialize(ConfigurableApplicationContext applicationContext) { ConfigurableEnvironment ce=applicationContext.getEnvironment(); for(PropertySource<?> propertySource:ce.getPropertySources()){ System.out.println(propertySource); } System.out.println("--------end"); }}增加spi加载
创立一个文件/resources/META-INF/spring.factories。增加如下内容
org.springframework.context.ApplicationContextInitializer= \ com.gupaoedu.example.springcloudconfigserver9091.TestApplicationContextInitializer在控制台就能够看到以后的PropertySource的输入后果。
ConfigurationPropertySourcesPropertySource {name='configurationProperties'}StubPropertySource {name='servletConfigInitParams'}StubPropertySource {name='servletContextInitParams'}PropertiesPropertySource {name='systemProperties'}OriginAwareSystemEnvironmentPropertySource {name='systemEnvironment'}RandomValuePropertySource {name='random'}MapPropertySource {name='configServerClient'}MapPropertySource {name='springCloudClientHostInfo'}OriginTrackedMapPropertySource {name='applicationConfig: [classpath:/application.yml]'}MapPropertySource {name='kafkaBinderDefaultProperties'}MapPropertySource {name='defaultProperties'}MapPropertySource {name='springCloudDefaultProperties'}版权申明：本博客所有文章除特地申明外，均采纳 CC BY-NC-SA 4.0 许可协定。转载请注明来自Mic带你学架构！
如果本篇文章对您有帮忙，还请帮忙点个关注和赞，您的保持是我一直创作的能源。欢送关注同名微信公众号获取更多技术干货！