ApplicationContextInitializer的三种使用方法

阳光穿透心脏的1/2处 2022-10-10 12:53 185阅读 0赞

# ApplicationContextInitializer的三种使用方法 #

> 概述：ApplicationContextInitializer是在springboot启动过程(refresh方法前)调用,主要是在ApplicationContextInitializer中initialize方法中拉起了ConfigurationClassPostProcessor这个类(我在springboot启动流程中有描述)，通过这个processor实现了beandefinition。言归正传，ApplicationContextInitializer实现主要有3种方式：

## 1、使用spring.factories方式： ##

> 首先我们自定义个类实现了ApplicationContextInitializer,然后在resource下面新建/META-INF/spring.factories文件。

public class Demo01ApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> { 
     
        @Override
        public void initialize(ConfigurableApplicationContext configurableApplicationContext) { 
            System.out.println("user add method ==> ApplicationContextInitializer");
        }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDMwNjY1_size_16_color_FFFFFF_t_70_pic_center]

> 这个加载过程是在SpringApplication中的getSpringFactoriesInstances()方法中直接加载并实例后执行对应的initialize方法。代码如下：

private <T> Collection<? extends T> getSpringFactoriesInstances(Class<T> type,
    			Class<?>[] parameterTypes, Object... args) { 
    		ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
    		// Use names and ensure unique to protect against duplicates
    		Set<String> names = new LinkedHashSet<String>(
    				SpringFactoriesLoader.loadFactoryNames(type, classLoader));
    		List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
    				classLoader, args, names);
    		AnnotationAwareOrderComparator.sort(instances);
    		return instances;
    	}

## 2、application.properties添加配置方式： ##

> 对于这种方式是通过DelegatingApplicationContextInitializer这个初始化类中的initialize方法获取到application.properties中context.initializer.classes对应的类并执行对应的initialize方法。只需要将实现了ApplicationContextInitializer的类添加到application.properties即可。如下:

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDMwNjY1_size_16_color_FFFFFF_t_70_pic_center 1]

下面我们看看DelegatingApplicationContextInitializer是如何加载的。看代码：

private static final String PROPERTY_NAME = "context.initializer.classes";
    
    private List<Class<?>> getInitializerClasses(ConfigurableEnvironment env) { 
    		String classNames = env.getProperty(PROPERTY_NAME);
    		List<Class<?>> classes = new ArrayList<Class<?>>();
    		if (StringUtils.hasLength(classNames)) { 
    			for (String className : StringUtils.tokenizeToStringArray(classNames, ",")) { 
    				classes.add(getInitializerClass(className));
    			}
    		}
    		return classes;
    	}

是从配置文件中获取到对应的初始化类信息，然后执行初始化方法。

## 3、直接通过add方法: ##

> 这个方法就比较简单，直接在springboot启动的时候，add一个实现了ApplicationContextInitializer的类即可，代码如下：

@SpringBootApplication
    public class InitializerDemoApplication { 
     
    	public static void main(String[] args) { 
    		//type01
    		SpringApplication springApplication = new SpringApplication(InitializerDemoApplication.class);
    		springApplication.addInitializers(new Demo01ApplicationContextInitializer());
    		springApplication.run(args);
     
    		//SpringApplication.run(InitializerDemoApplication.class,args);
    	}
    }

## 总结 ##

以上3种方法都可以实现自定义的Initializer，只不过执行的顺序有差异。这里我比较感兴趣有2个，一个通过spring.factories实现SPI模式，有兴趣的可以看下jdbc-starter等一些相关springboot starter。第二个就是作为一个钩子去拉起来"一坨"的bean。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDMwNjY1_size_16_color_FFFFFF_t_70_pic_center]: /images/20221005/ca4300ed84bb4762a56291a1efad59ad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMxNDMwNjY1_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221005/3a702d6c93554448892167352b72d69f.png