Spring Boot # EnvironmentPostProcessor

#EnvironmentPostProcessor简介

EnvironmentPostProcessor在Spring IOC容器创建之前执行，为我们提供了一个很方便的扩展点。

比如

• ConfigFileApplicationListener是load配置文件的
• HostInfoEnvironmentPostProcessor可以获取本机的网络相关的信息
• CloudFoundryVcapEnvironmentPostProcessor
• DevToolsHomePropertiesPostProcessor
• DevToolsPropertyDefaultsPostProcessor
• SpringApplicationJsonEnvironmentPostProcessor
• ServoEnvironmentPostProcessor

一个小问题

前面出过一个问题是，在HostInfoEnvironmentPostProcessor中使用InetUtils获取本机网卡信息时，如果是多网卡的情况下，在application配置文件中配置了spring.cloud.inetutils.preferred-networks的时候，HostInfoEnvironmentPostProcessor中获取的网卡信息和Spring Cloud App中的IOC容器启动之后（这里的描述不准确，往下看），获取的信息不一致。

具体原因可以参看Spring Cloud Eureka 多网卡配置终极说明​此文的描述。下面我们看一下根本原因，

Spring Boot在启动过程中，会通过同步事件监听机制，阶段性的发送事件，比如说ApplicationStartEvent，ApplicationEnvironmentPreparedEvent，ApplicationPreparedEvent等，其中ApplicationEnvironmentPreparedEvent事件会被ConfigFileApplicationListener捕获，捕获之后会执行如下的方法：

private void onApplicationEnvironmentPreparedEvent(
    ApplicationEnvironmentPreparedEvent event) {
  List<EnvironmentPostProcessor> postProcessors = loadPostProcessors();
  postProcessors.add(this);
  AnnotationAwareOrderComparator.sort(postProcessors);
  for (EnvironmentPostProcessor postProcessor : postProcessors) {
    postProcessor.postProcessEnvironment(event.getEnvironment(),
        event.getSpringApplication());
  }
}

List<EnvironmentPostProcessor> loadPostProcessors() {
  return SpringFactoriesLoader.loadFactories(EnvironmentPostProcessor.class,
      getClass().getClassLoader());
}      

可以看到，上面的方法是将spring.factories中配置的EnvironmentPostProcessor接口的实现都找出来。

加上ConfigFileApplicationListener自己，然后按照Order注解指定的值排序，排序之后的顺序如下：

• org.springframework.boot.env.SpringApplicationJsonEnvironmentPostProcessor@6b13d1ff,
• org.springframework.cloud.client.HostInfoEnvironmentPostProcessor@693c9f97,
• org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor@4406d3dc,
• org.springframework.boot.context.config.ConfigFileApplicationListener@757f11f0,
• org.springframework.cloud.netflix.metrics.ServoEnvironmentPostProcessor@63f2959b,
• org.springframework.boot.devtools.env.DevToolsHomePropertiesPostProcessor@161b3c33,
• org.springframework.boot.devtools.env.DevToolsPropertyDefaultsPostProcessor@1b56c940

问题就出在这里，HostInfoEnvironmentPostProcessor是在ConfigFileApplicationListener执行的，导致HostInfoEnvironmentPostProcessor在使用InetUtils获取网卡信息的时候，上下文环境中没有application文件中指定的spring.cloud.inetutils.preferred-networks配置。