Springboot的扩展点

1、SpringApplicationRunListener接口

        SpringApplicationRunListener接口用于在Springboot启动初始化的过程中可以通过接口回调来让用户在启动的各个流程中可以加入自己的逻辑。

 

        用来在整个启动流程中接收不同执行点事件通知的监听者，SpringApplicationRunListener接口规定了SpringBoot的生命周期，在各个生命周期广播相应的事件，调用实际的ApplicationListener类。

 

创建实现类：

public class SeasySpringApplicationRunListener implements SpringApplicationRunListener {
	private final SpringApplication application;
    private final String[] args;

	public SeasySpringApplicationRunListener(SpringApplication application, String[] args){
		this.application = application;
        this.args = args;
	}
	
	@Override
	public void starting() {
		System.out.println("starting...");
	}

	@Override
	public void environmentPrepared(ConfigurableEnvironment environment) {
		System.out.println("environmentPrepared...");
	}

	@Override
	public void contextPrepared(ConfigurableApplicationContext context) {
		System.out.println("contextPrepared...");
	}

	@Override
	public void contextLoaded(ConfigurableApplicationContext context) {
		System.out.println("contextLoaded...");
	}
	
	@Override
	public void failed(ConfigurableApplicationContext context, Throwable exception) {
		System.out.println("failed...");
		if(exception != null){
			exception.printStackTrace();
		}
	}
	
	@Override
	public void started(ConfigurableApplicationContext context) {
		System.out.println("started...");
	}
	
	@Override
	public void running(ConfigurableApplicationContext context) {
		System.out.println("running...");
	}
}

 

在META-INF\spring.fatories文件中添加以下内容：

org.springframework.boot.SpringApplicationRunListener=com.seasy.springboottest.extension.SeasySpringApplicationRunListener

 

2、ApplicationContextInitializer接口

        这是一个在ConfigurableApplicationContext刷新之前初始化ConfigurableApplicationContext的回调接口，对ConfigurableApplicationContext的实例做进一步的设置或者处理。

 

创建实现类：

public class SeasyApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
	public void initialize(ConfigurableApplicationContext applicationContext) {
		System.out.println("initialize...");
	};
}

 

使用方式有三种：

1、使用SpringApplication.addInitializers或者SpringApplication.setInitializers
		SpringApplication springApplication = new SpringApplication(Main.class);
		springApplication.addInitializers(new SeasyApplicationContextInitializer());
		springApplication.run(args);

2、在Application.properties属性文件中添加以下配置：
	context.initializer.classes=com.seasy.springboottest.extension.SeasyApplicationContextInitializer

3、在META-INF\spring.fatories文件中添加以下内容：
	org.springframework.context.ApplicationContextInitializer=com.seasy.springboottest.extension.SeasyApplicationContextInitializer

 

3、ApplicationListener接口

        ApplicationListener是上下文监听器，Spring框架对Java中实现的监听者模式的一种框架实现。当需要监听自定义事件时，可以新建一个实现ApplicationListener接口的类，并将该类配置到Spring容器中。

 

创建实现类：

//@Component("seasyApplicationListener")
public class SeasyApplicationListener implements ApplicationListener<ContextRefreshedEvent> {
	@Override
	public void onApplicationEvent(ContextRefreshedEvent event) {
		System.out.println("onApplicationEvent >> " + event.getClass().getName());
	}
}

 

使用方式有三种：

1、在META-INF\spring.fatories文件中添加以下内容：
	org.springframework.context.ApplicationListener=com.seasy.springboottest.extension.SeasyApplicationListener

2、用 @Component 注解类标注该类，由容器自动扫描、加载和实例化
	@Component("seasyApplicationListener")

3、使用SpringApplication.addListener或者SpringApplication.setListeners
	SpringApplication springApplication = new SpringApplication(Main.class);
	springApplication.addListeners(new SeasyApplicationListener());
	springApplication.run(args);

 

4、CommandLineRunner接口

        用于在应用程序初始化之后执行某些逻辑，它在所有Spring Beans都初始化之后执行。如果存在多个CommandLineRunner的实现类，可以使用@Order注解来排序。

 

创建实现类：

@Component
@Order(value=1)
public class SeasyCommandLineRunner implements CommandLineRunner {
	@Override
	public void run(String... args) throws Exception {
		//如果该方法内部抛出异常，则导致应用启动失败
		System.out.println("SeasyCommandLineRunner.run()...");
	}
}

 

5、ApplicationRunner接口

        如果需要在SpringBoot启动完成之后实现一些功能，可以通过实现ApplicationRunner接口来完成。如果存在多个实现类，可以使用@Order注解来排序。

 

ApplicationRunner的实现类：

@Component
@Order(value=2)
public class SeasyApplicationRunner implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
		System.out.println("SeasyApplicationRunner.run()...");
    }
}