Spring擴展點之EnvironmentPostProcessor

前言

EnvironmentPostProcessor是一個Environment后置處理器攒发,是spring中比較重要的一個擴展點篙顺。為什么重要呢?因為這個擴展點胁艰,是在日志模塊之前啟動的底洗。例如根據(jù)這個特性腋么,我們可以在日志啟動之前咕娄,利用EnvironmentPostProcessor接口來實現(xiàn)對日志模塊的準備工作亥揖。

源碼鏈路

以springboot啟動為例,(2.7.3版本圣勒,我回去看了2.1.4版本费变,邏輯沒啥變化)

1. run()方法
// 準備環(huán)境
2. ConfigurableEnvironment environment = this.prepareEnvironment(listeners, bootstrapContext, applicationArguments);
// 所有的實現(xiàn)了SpringApplicationRunListener的listeners
3. listeners.environmentPrepared(bootstrapContext, (ConfigurableEnvironment)environment);
// 輪詢所有l(wèi)istener發(fā)送事件
4. listener.environmentPrepared(bootstrapContext, environment);
// 默認的EventPublishingRunListener發(fā)布ApplicationEnvironmentPreparedEvent事件
5. this.initialMulticaster.multicastEvent(new ApplicationEnvironmentPreparedEvent(bootstrapContext, this.application, this.args, environment));

事件發(fā)布完畢,找一下訂閱方圣贸,2.4版本以后是在EnvironmentPostProcessorApplicationListener挚歧, 2.4版本之前是在ConfigFileApplicationListener
流程是一樣的:

1. if (event instanceof ApplicationEnvironmentPreparedEvent) {
            onApplicationEnvironmentPreparedEvent((ApplicationEnvironmentPreparedEvent) event);
        }
2. private void onApplicationEnvironmentPreparedEvent(ApplicationEnvironmentPreparedEvent event) {
        ConfigurableEnvironment environment = event.getEnvironment();
        SpringApplication application = event.getSpringApplication();
        for (EnvironmentPostProcessor postProcessor : getEnvironmentPostProcessors(application.getResourceLoader(),
                event.getBootstrapContext())) {
            postProcessor.postProcessEnvironment(environment, application);
        }
    }
3. List<EnvironmentPostProcessor> getEnvironmentPostProcessors(ResourceLoader resourceLoader,
            ConfigurableBootstrapContext bootstrapContext) {
        ClassLoader classLoader = (resourceLoader != null) ? resourceLoader.getClassLoader() : null;
        EnvironmentPostProcessorsFactory postProcessorsFactory = this.postProcessorsFactory.apply(classLoader);
        return postProcessorsFactory.getEnvironmentPostProcessors(this.deferredLogs, bootstrapContext);
    }
4. public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
        ClassLoader classLoaderToUse = classLoader;
        if (classLoader == null) {
            classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
        }

        String factoryTypeName = factoryType.getName();
        return (List)loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList());
    }
5. Enumeration urls = classLoader.getResources("META-INF/spring.factories");

總結(jié)從spring.factories文件里找key為org.springframework.boot.env.EnvironmentPostProcessor的類,以spi的方式注入的類吁峻。然后遍歷執(zhí)行postProcessEnvironment()方法滑负。

舉例

apollo

1.  將Apollo配置加載提到初始化日志系統(tǒng)之前(1.2.0+)

從1.2.0版本開始在张,如果希望把日志相關的配置(如`logging.level.root=info`或`logback-spring.xml`中的參數(shù))也放在Apollo管理,那么可以額外配置`apollo.bootstrap.eagerLoad.enabled=true`來使Apollo的加載順序放到日志系統(tǒng)加載之前矮慕,更多信息可以參考[PR 1614](https://github.com/apolloconfig/apollo/pull/1614)帮匾。參考配置示例如下:
     # will inject 'application' namespace in bootstrap phase
     apollo.bootstrap.enabled = true
     # put apollo initialization before logging system initialization
     apollo.bootstrap.eagerLoad.enabled=true

上面這一段這是從apollo官方文檔copy過來的,我們看看如何實現(xiàn)的痴鳄。
ApolloApplicationContextInitializer實現(xiàn)了EnvironmentPostProcessor接口瘟斜, 然后在springboot啟動發(fā)布ApplicationEnvironmentPreparedEvent事件的時候,觸發(fā)回調(diào)到ApolloApplicationContextInitializer的postProcessEnvironment()方法

@Override
  public void postProcessEnvironment(ConfigurableEnvironment configurableEnvironment, SpringApplication springApplication) {

    // should always initialize system properties like app.id in the first place
    initializeSystemProperty(configurableEnvironment);

    Boolean eagerLoadEnabled = configurableEnvironment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_EAGER_LOAD_ENABLED, Boolean.class, false);

    //EnvironmentPostProcessor should not be triggered if you don't want Apollo Loading before Logging System Initialization
    if (!eagerLoadEnabled) {
      return;
    }

    Boolean bootstrapEnabled = configurableEnvironment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED, Boolean.class, false);

    if (bootstrapEnabled) {
      initialize(configurableEnvironment);
    }

  }

代碼通俗易懂痪寻,直接拿配置的apollo.bootstrap.eagerLoad.enabled螺句,如果是true,觸發(fā)apollo初始化工作橡类。也就是說當你需要使用到apollo作為自己的配置中心蛇尚,并且需要在日志模塊之前完成初始化,利用的就是Spring的EnvironmentPostProcessor擴展點猫态。小伙伴們可以舉一反三佣蓉,合理的運用到自己項目中。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末亲雪,一起剝皮案震驚了整個濱河市勇凭,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌义辕,老刑警劉巖虾标,帶你破解...
    沈念sama閱讀 216,591評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異灌砖,居然都是意外死亡璧函,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評論 3 392
  • 文/潘曉璐 我一進店門基显,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蘸吓,“玉大人,你說我怎么就攤上這事撩幽】饧蹋” “怎么了?”我有些...
    開封第一講書人閱讀 162,823評論 0 353
  • 文/不壞的土叔 我叫張陵窜醉,是天一觀的道長宪萄。 經(jīng)常有香客問我,道長榨惰,這世上最難降的妖魔是什么拜英? 我笑而不...
    開封第一講書人閱讀 58,204評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮琅催,結(jié)果婚禮上居凶,老公的妹妹穿的比我還像新娘虫给。我一直安慰自己,他們只是感情好侠碧,可當我...
    茶點故事閱讀 67,228評論 6 388
  • 文/花漫 我一把揭開白布狰右。 她就那樣靜靜地躺著,像睡著了一般舆床。 火紅的嫁衣襯著肌膚如雪棋蚌。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,190評論 1 299
  • 那天挨队,我揣著相機與錄音谷暮,去河邊找鬼。 笑死盛垦,一個胖子當著我的面吹牛湿弦,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播腾夯,決...
    沈念sama閱讀 40,078評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼颊埃,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了蝶俱?” 一聲冷哼從身側(cè)響起班利,我...
    開封第一講書人閱讀 38,923評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎榨呆,沒想到半個月后罗标,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,334評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡积蜻,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,550評論 2 333
  • 正文 我和宋清朗相戀三年闯割,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片竿拆。...
    茶點故事閱讀 39,727評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡宙拉,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出丙笋,到底是詐尸還是另有隱情谢澈,我是刑警寧澤,帶...
    沈念sama閱讀 35,428評論 5 343
  • 正文 年R本政府宣布不见,位于F島的核電站澳化,受9級特大地震影響崔步,放射性物質(zhì)發(fā)生泄漏稳吮。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,022評論 3 326
  • 文/蒙蒙 一井濒、第九天 我趴在偏房一處隱蔽的房頂上張望灶似。 院中可真熱鬧列林,春花似錦、人聲如沸酪惭。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,672評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽春感。三九已至砌创,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間鲫懒,已是汗流浹背嫩实。 一陣腳步聲響...
    開封第一講書人閱讀 32,826評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留窥岩,地道東北人甲献。 一個月前我還...
    沈念sama閱讀 47,734評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像颂翼,于是被迫代替她去往敵國和親晃洒。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,619評論 2 354

推薦閱讀更多精彩內(nèi)容