ApplicationEvent以及Listener是Spring為我們提供的一個(gè)事件監(jiān)聽、訂閱的實(shí)現(xiàn)，內(nèi)部實(shí)現(xiàn)原理是觀察者設(shè)計(jì)模式，設(shè)計(jì)初衷也是為了系統(tǒng)業(yè)務(wù)邏輯之間的解耦，提高可擴(kuò)展性以及可維護(hù)性。

通過 ApplicationEvent 類和 ApplicationListener 接口來提供在 ApplicationContext 中處理事件。如果一個(gè) bean 實(shí)現(xiàn) ApplicationListener，那么每次 ApplicationEvent 被發(fā)布到 ApplicationContext 上，那個(gè) bean 會(huì)被通知。

Spring 提供了以下的標(biāo)準(zhǔn)事件：

一下通過一個(gè)實(shí)例說明：

項(xiàng)目的整體結(jié)構(gòu)如下圖所示

image.png

1、構(gòu)建項(xiàng)目

 <groupId>com.br</groupId>
    <artifactId>ListenerDemo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <dependencies>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.16</version>
        </dependency>
        <!--test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

2、創(chuàng)建Event事件

首先注意：listener都是圍繞著event來掛起的。

package com.br.event;

import com.br.bean.User;
import org.springframework.context.ApplicationEvent;

/**
 * @author jackcooper
 * @create 2018-02-27 13:54
 */
public class UserRegisterEvent extends ApplicationEvent {

    public User user;

    /**
     *
     * @param source 發(fā)生事件的對象
     * @param user 注冊用戶對象
     */
    public UserRegisterEvent(Object source,User user) {
        super(source);
        this.user = user;
    }

    
    
    
    
    public User getUser() {
        return user;
    }

    public void setUser(User user) {
        this.user = user;
    }
}

3、事件發(fā)布

此部分主要在業(yè)務(wù)邏輯模塊觸發(fā)，主要用到ApplicationContext類以及它的publishEvent(ApplicationEvent t)方法。

package com.br.service;

import com.br.bean.User;
import com.br.event.UserRegisterEvent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Service;

/**
 * @author jackcooper
 * @create 2018-02-27 14:03
 */
@Service
public class UserService {

    @Autowired
    private ApplicationContext applicationContext;

    public void register(User user){
        //省略業(yè)務(wù)邏輯
        //。。。。
        //發(fā)布UserRegisterEvent事件
        applicationContext.publishEvent(new UserRegisterEvent(this,user));
    }
  
}

4、創(chuàng)建Event事件監(jiān)聽

第一種方式：基于EventListener注解實(shí)現(xiàn)

注解方式比較簡單，并不需要實(shí)現(xiàn)任何接口

package com.br.listener;

import com.br.bean.User;
import com.br.event.UserRegisterEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

/**
 * @author jackcooper
 * @create 2018-02-27 14:17
 * @deprecated 方法一：注解方式比較簡單，并不需要實(shí)現(xiàn)任何接口   排序隨機(jī)
 */
@Component
public class AnnotationRegisterListener {
    /**
     * 注冊監(jiān)聽實(shí)現(xiàn)方法
     * @param userRegisterEvent 用戶注冊事件
     */
    @EventListener
    public void sendEmail(UserRegisterEvent userRegisterEvent)
    {
        //獲取注冊用戶對象
        User user = userRegisterEvent.getUser();

        //todo

        //輸出注冊用戶信息
        System.out.println("發(fā)送郵件，用戶名："+user.getName()+"，郵箱："+user.getEmail());
    }

    /**
     * 注冊監(jiān)聽實(shí)現(xiàn)方法
     * @param userRegisterEvent 用戶注冊事件
     */
    @EventListener
    public void register(UserRegisterEvent userRegisterEvent)
    {
        //獲取注冊用戶對象
        User user = userRegisterEvent.getUser();

        //todo

        //輸出注冊用戶信息
        System.out.println("1注冊信息，用戶名："+user.getName()+"，郵箱："+user.getEmail());
    }

}

第二種方式：實(shí)現(xiàn) ApplicationListener接口

這種方式也是Spring之前比較常用的監(jiān)聽事件方式，在實(shí)現(xiàn)ApplicationListener接口時(shí)需要將監(jiān)聽事件作為泛型傳遞

package com.br.listener;

import com.br.bean.User;
import com.br.event.UserRegisterEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

/**
 * @author jackcooper
 * @create 2018-02-27 14:29
 * @deprecated ApplicationListener實(shí)現(xiàn)監(jiān)聽：這種方式也是Spring之前比較常用的監(jiān)聽事件方式，在實(shí)現(xiàn)ApplicationListener接口時(shí)需要將監(jiān)聽事件作為泛型傳遞，監(jiān)聽實(shí)現(xiàn)代碼如下所示
 */
@Component
public class RegisterListener implements ApplicationListener<UserRegisterEvent> {

    /**
     * 實(shí)現(xiàn)監(jiān)聽
     * @param userRegisterEvent
     */
    @Override
    public void onApplicationEvent(UserRegisterEvent userRegisterEvent) {
        //獲取注冊用戶對象
        User user = userRegisterEvent.getUser();

        //../省略邏輯

        //輸出注冊用戶信息
        System.out.println("2注冊信息，用戶名："+user.getName()+"，密碼："+user.getEmail());
    }
}

第三種方式：實(shí)現(xiàn)SmartApplicationListener接口

package com.br.listener;

import com.br.bean.User;
import com.br.event.UserRegisterEvent;
import com.br.service.UserService;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.SmartApplicationListener;
import org.springframework.stereotype.Component;

/**
 * @author 10400
 * @create 2018-02-27 15:03
 * @deprecated 有序監(jiān)聽
 */
@Component
public class SmartRegisterListener implements SmartApplicationListener {
    @Override
    public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
        //只有UserRegisterEvent監(jiān)聽類型才會(huì)執(zhí)行下面邏輯
        return aClass == UserRegisterEvent.class;
    }

    @Override
    public boolean supportsSourceType(Class<?> aClass) {
        //只有在UserService內(nèi)發(fā)布的UserRegisterEvent事件時(shí)才會(huì)執(zhí)行下面邏輯
        return aClass == UserService.class;
    }

    @Override
    public void onApplicationEvent(ApplicationEvent applicationEvent) {
        //轉(zhuǎn)換事件類型
        UserRegisterEvent userRegisterEvent = (UserRegisterEvent) applicationEvent;
        //獲取注冊用戶對象信息
        User user = userRegisterEvent.getUser();
        //.../完成注冊業(yè)務(wù)邏輯

        System.out.println("SmartRegisterListener" + user.getName());

    }

    /**
     * return 的數(shù)值越小證明優(yōu)先級越高，執(zhí)行順序越靠前。
     * @return
     */
    @Override
    public int getOrder() {
        return 10;
    }
}

SmartApplicationListener接口繼承了全局監(jiān)聽ApplicationListener，并且泛型對象使用的ApplicationEvent來作為全局監(jiān)聽，可以理解為使用SmartApplicationListener作為監(jiān)聽父接口的實(shí)現(xiàn)，監(jiān)聽所有事件發(fā)布。

可以看到除了上面的方法，還提供了一個(gè)getOrder方法，這個(gè)方法就可以解決執(zhí)行監(jiān)聽的順序問題，return的數(shù)值越小證明優(yōu)先級越高，執(zhí)行順序越靠前。

第四種方式：使用@Async實(shí)現(xiàn)異步監(jiān)聽

@Aysnc其實(shí)是Spring內(nèi)的一個(gè)組件，可以完成對類內(nèi)單個(gè)或者多個(gè)方法實(shí)現(xiàn)異步調(diào)用，這樣可以大大的節(jié)省等待耗時(shí)。內(nèi)部實(shí)現(xiàn)機(jī)制是線程池任務(wù)ThreadPoolTaskExecutor，通過線程池來對配置@Async的方法或者類做出執(zhí)行動(dòng)作。

• 線程任務(wù)池配置
  我們創(chuàng)建一個(gè)ListenerAsyncConfiguration，并且使用@EnableAsync注解開啟支持異步處理，具體代碼如下所示：

@Configuration
@EnableAsync
public class ListenerAsyncConfiguration implements AsyncConfigurer
{
    /**
     * 獲取異步線程池執(zhí)行對象
     * @return
     */
    @Override
    public Executor getAsyncExecutor() {
        //使用Spring內(nèi)置線程池任務(wù)對象
        ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
        //設(shè)置線程池參數(shù)
        taskExecutor.setCorePoolSize(5);
        taskExecutor.setMaxPoolSize(10);
        taskExecutor.setQueueCapacity(25);
        taskExecutor.initialize();
        return taskExecutor;
    }

    @Override
    public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
        return null;
    }
}

我們自定義的監(jiān)聽異步配置類實(shí)現(xiàn)了AsyncConfigurer接口并且實(shí)現(xiàn)內(nèi)getAsyncExecutor方法以提供線程任務(wù)池對象的獲取。
我們只需要在異步方法上添加@Async注解就可以實(shí)現(xiàn)方法的異步調(diào)用，為了證明這一點(diǎn)，我們在發(fā)送郵件onApplicationEvent方法內(nèi)添加線程阻塞3秒，修改后的代碼如下所示：

/**
     * supportsEventType & supportsSourceType 兩個(gè)方法返回true時(shí)調(diào)用該方法執(zhí)行業(yè)務(wù)邏輯
     * @param applicationEvent 具體監(jiān)聽實(shí)例，這里是UserRegisterEvent
     */
    @Override
    @Async
    public void onApplicationEvent(ApplicationEvent applicationEvent) {
        try {
            Thread.sleep(3000);//靜靜的沉睡3秒鐘
        }catch (Exception e)
        {
            e.printStackTrace();
        }
        //轉(zhuǎn)換事件類型
        UserRegisterEvent userRegisterEvent = (UserRegisterEvent) applicationEvent;
        //獲取注冊用戶對象信息
        UserBean user = userRegisterEvent.getUser();
        System.out.println("用戶："+user.getName()+"，注冊成功，發(fā)送郵件通知。");
    }

文章參考

http://www.lxweimin.com/p/4359dd4b36a6