Spring中ApplicationListener的使用

charles_paul 發(fā)布于2019-08-16 18:36 / 851人閱讀

摘要：背景是事件機(jī)制的一部分，與抽象類(lèi)類(lèi)配合來(lái)完成的事件機(jī)制。如果容器中存在的，當(dāng)調(diào)用方法時(shí)，對(duì)應(yīng)的會(huì)被觸發(fā)。單元測(cè)試類(lèi)執(zhí)行單元測(cè)試，會(huì)發(fā)現(xiàn)事件發(fā)布之后，監(jiān)聽(tīng)器方法被調(diào)用，日志被打印出來(lái)。

背景

ApplicationListener是Spring事件機(jī)制的一部分，與抽象類(lèi)ApplicationEvent類(lèi)配合來(lái)完成ApplicationContext的事件機(jī)制。

如果容器中存在A(yíng)pplicationListener的Bean，當(dāng)ApplicationContext調(diào)用publishEvent方法時(shí)，對(duì)應(yīng)的Bean會(huì)被觸發(fā)。這一過(guò)程是典型的觀(guān)察者模式的實(shí)現(xiàn)。

ApplicationListener源碼

@FunctionalInterface
public interface ApplicationListener extends EventListener {

    /**
     * Handle an application event.
     * @param event the event to respond to
     */
    void onApplicationEvent(E event);

}

ContextRefreshedEvent事件的監(jiān)聽(tīng)

以Spring的內(nèi)置事件ContextRefreshedEvent為例，當(dāng)ApplicationContext被初始化或刷新時(shí)，會(huì)觸發(fā)ContextRefreshedEvent事件，下面我們就實(shí)現(xiàn)一個(gè)ApplicationListener來(lái)監(jiān)聽(tīng)此事件的發(fā)生。

@Component // 需對(duì)該類(lèi)進(jìn)行Bean的實(shí)例化
public class LearnListener implements ApplicationListener {
   @Override
   public void onApplicationEvent(ContextRefreshedEvent event) {
      // 打印容器中出事Bean的數(shù)量
      System.out.println("監(jiān)聽(tīng)器獲得容器中初始化Bean數(shù)量：" + event.getApplicationContext().getBeanDefinitionCount());
   }
}

如上，便完成了一個(gè)事件監(jiān)聽(tīng)類(lèi)的實(shí)現(xiàn)和實(shí)例化。

自定義事件及監(jiān)聽(tīng)

首先自定義事件：NotifyEvent。

public class NotifyEvent extends ApplicationEvent {


    private String email;

    private String content;

    public NotifyEvent(Object source) {
        super(source);
    }

    public NotifyEvent(Object source, String email, String content) {
        super(source);
        this.email = email;
        this.content = content;
    }
    // 省略getter/setter方法
}

定義監(jiān)聽(tīng)器NotifyListener：

@Component
public class NotifyListener implements ApplicationListener {

    @Override
    public void onApplicationEvent(NotifyEvent event) {
        System.out.println("郵件地址：" + event.getEmail());
        System.out.println("郵件內(nèi)容：" + event.getContent());
    }
}

監(jiān)聽(tīng)器通過(guò)@Component注解進(jìn)行實(shí)例化，并在onApplicationEvent中打印相關(guān)信息。

單元測(cè)試類(lèi)：

@RunWith(SpringRunner.class)
@SpringBootTest
public class ListenerTest {

    @Autowired
    private WebApplicationContext webApplicationContext;

    @Test
    public void testListener() {

        NotifyEvent event = new NotifyEvent("object", "abc@qq.com", "This is the content");

        webApplicationContext.publishEvent(event);
    }
}

執(zhí)行單元測(cè)試，會(huì)發(fā)現(xiàn)事件發(fā)布之后，監(jiān)聽(tīng)器方法被調(diào)用，日志被打印出來(lái)。

原文鏈接：https://www.choupangxia.com/2...