springboot监听器实现

自定义监听器

要在springboot中注入自定义的监听器，需要完成以下两个步骤

• 实现接口
• 注入框架

实现接口

第一种【实现ApplicationListener接口】

• 实现ApplicationListener接口
• 在实现时声明支持的事件

// 示例中ApplicationStartedEvent就是声明的支持的事件，监听器将会在监听到该事件后打印出"hello world"
public class DiyListener implements ApplicationListener<ApplicationStartedEvent> {
    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        // 编写实现的代码逻辑
        System.out.println("hello world");
    }
}

第二种【实现SmartApplicationListener接口】

• 实现SmartApplicationListener接口
• 重写supportsEventType/supportsSourceType声明支持的事件/类型

public class DiyListener implements SmartApplicationListener {
    @Override
    public boolean supportsEventType(Class<? extends ApplicationEvent> eventType) {
        //确定这个监听器是否支持给定的事件类型,如下示例是支持ApplicationStartedEvent
        return ApplicationStartedEvent.class.isAssignableFrom(eventType);
    }

    @Override
    public boolean supportsSourceType(Class<?> sourceType) {
        //确定这个监听器是否支持给定的类型，可使用自定义的类
        return false;
    }

    @Override
    public void onApplicationEvent(ApplicationEvent event) {
        // 监听到支持的事件后打印出hello world
        System.out.println("hello world");
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

注入框架

第一种【springfactories中定义】

// 示例：org.springframework.context.ApplicationContextInitalizer=com.common.TestInitalizer
org.springframework.context.ApplicationContextInitalizer=包名.类名

• 第二种【在SpringApplication初始化后添加初始化器】

@SpringBootApplication
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication springApplication = new SpringApplication(TestApplication.class);
        // TestInitialzer就是实现了ApplicationContextInitalizer的类
        springApplication.addInitialzer(new TestInitialzer());
        springApplication.run(args);
    }
}

• 第三种【在application.properties配置】

// 示例：context.initialzer.classesr=com.common.TestInitalizer
context.initialzer.classes=包名.类名

tips

• 实现ApplicationListener只能监听单一事件，需要实现多种事件监听时需要使用SmartApplicationListener
• 接口实现中，order值越小，越先执行

// order中设置的就是order值
@Order(1)
public class TextInitialzer implements ApplicationContextInitializer<ConfigurableApplicationContext> {

• application.properties中配置的最先执行，在源码中，他的order直接定为0，所以会直接忽略开发者自定义order值的影响