com.ctrip.framework.apollo.spring.boot

Class ApolloApplicationContextInitializer

java.lang.Object

com.ctrip.framework.apollo.spring.boot.ApolloApplicationContextInitializer

All Implemented Interfaces:

org.springframework.boot.env.EnvironmentPostProcessor, org.springframework.context.ApplicationContextInitializer<org.springframework.context.ConfigurableApplicationContext>

public class ApolloApplicationContextInitializer
extends Object
implements org.springframework.context.ApplicationContextInitializer<org.springframework.context.ConfigurableApplicationContext>, org.springframework.boot.env.EnvironmentPostProcessor

Initialize apollo system properties and inject the Apollo config in Spring Boot bootstrap phase

Configuration example:

   # set app.id
   app.id = 100004458
   # enable apollo bootstrap config and inject 'application' namespace in bootstrap phase
   apollo.bootstrap.enabled = true
 

or

   # set app.id
   app.id = 100004458
   # enable apollo bootstrap config
   apollo.bootstrap.enabled = true
   # will inject 'application' and 'FX.apollo' namespaces in bootstrap phase
   apollo.bootstrap.namespaces = application,FX.apollo
 

If you want to load Apollo configurations even before Logging System Initialization Phase, add

   # set apollo.bootstrap.eagerLoad.enabled
   apollo.bootstrap.eagerLoad.enabled = true
 

This would be very helpful when your logging configurations is set by Apollo. for example, you have defined logback-spring.xml in your project, and you want to inject some attributes into logback-spring.xml.

Constructor Summary

Constructors

Constructor and Description
ApolloApplicationContextInitializer()

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(org.springframework.context.ConfigurableApplicationContext context)
void	postProcessEnvironment(org.springframework.core.env.ConfigurableEnvironment configurableEnvironment, org.springframework.boot.SpringApplication springApplication) In order to load Apollo configurations as early as even before Spring loading logging system phase, this EnvironmentPostProcessor can be called Just After ConfigFileApplicationListener has succeeded.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApolloApplicationContextInitializer

public ApolloApplicationContextInitializer()

Method Detail

initialize

public void initialize(org.springframework.context.ConfigurableApplicationContext context)

Specified by:

initialize in interface org.springframework.context.ApplicationContextInitializer<org.springframework.context.ConfigurableApplicationContext>

postProcessEnvironment

public void postProcessEnvironment(org.springframework.core.env.ConfigurableEnvironment configurableEnvironment,
                          org.springframework.boot.SpringApplication springApplication)

In order to load Apollo configurations as early as even before Spring loading logging system phase, this EnvironmentPostProcessor can be called Just After ConfigFileApplicationListener has succeeded.
The processing sequence would be like this:
Load Bootstrap properties and application properties -----> load Apollo configuration properties ----> Initialize Logging systems

Specified by:

postProcessEnvironment in interface org.springframework.boot.env.EnvironmentPostProcessor

Parameters:

configurableEnvironment -

springApplication -