基于spring如何實現(xiàn)事件驅動實例代碼

更新時間：2019年04月08日 09:43:06 作者：稀飯下雪

這篇文章主要給大家介紹了關于基于spring如何實現(xiàn)事件驅動的相關資料，文中通過示例代碼介紹的非常詳細，對大家學習或者使用spring具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧

干貨點

通過閱讀該篇博客，你可以了解了解java的反射機制、可以了解如何基于spring生命周期使用自定義注解解決日常研發(fā)問題。具體源碼可以點擊鏈接。

問題描述

在日常研發(fā)中，經(jīng)常會遇見業(yè)務A的某個action被觸發(fā)后，同時觸發(fā)業(yè)務B的action的行為，這種單對單的形式可以直接在業(yè)務A的action執(zhí)行結束后直接調(diào)用業(yè)務B的action，那么如果是單對多的情況呢？

方案解決

這里提供一種在日常研發(fā)中經(jīng)常使用到的機制，基于spring實現(xiàn)的事件驅動，即在業(yè)務A的action執(zhí)行完，拋出一個事件，而業(yè)務B、C、D等監(jiān)聽到該事件后處理相應的業(yè)務。

場景范例

這里提供一個場景范例，該范例基于springboot空殼項目實現(xiàn)，具體可以查看源碼，此處只梳理關鍵步驟。

步驟一：

定義一個注解，標志接收事件的注解，即所有使用了該注解的函數(shù)都會在對應事件被拋出的時候被調(diào)用，該注解實現(xiàn)比較簡單，代碼如下

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc 接收事件的注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ReceiveAnno {

 // 監(jiān)聽的事件
 Class clz();
}

如果想了解注解多個參數(shù)的意義是什么的可以點擊鏈接查看博主之前寫過文章。

定義事件接口

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc
 */
public interface IEvent {
}

所有事件都需要實現(xiàn)該接口，主要是為了后面泛型和類型識別。

定義MethodInfo

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc
 */
public class MethodInfo {

 public Object obj;
 public Method method;

 public static MethodInfo valueOf(Method method, Object obj) {

 MethodInfo info = new MethodInfo();
 info.method = method;
 info.obj = obj;
 return info;
 }

 public Object getObj() {
 return obj;
 }

 public Method getMethod() {
 return method;
 }
}

該類只是做了Object和Method的封裝，沒有其他作用。

步驟二：

實現(xiàn)一個事件容器，該容器的作用是存放各個事件以及需要觸發(fā)的各個業(yè)務的method的對應關系。

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc 事件容器
 */
public class EventContainer {

 private static Map<Class<IEvent>, List<MethodInfo>> eventListMap = new HashMap<>();

 public static void addEventToMap(Class clz, Method method, Object obj) {

 List<MethodInfo> methodInfos = eventListMap.get(clz);
 if (methodInfos == null) {
 methodInfos = new ArrayList<>();
 eventListMap.put(clz, methodInfos);
 }

 methodInfos.add(MethodInfo.valueOf(method, obj));
 }

 public static void submit(Class clz) {

 List<MethodInfo> methodInfos = eventListMap.get(clz);
 if (methodInfos == null) {
 return;
 }

 for (MethodInfo methodInfo : methodInfos) {
 Method method = methodInfo.getMethod();
 try {
 method.setAccessible(true);
 method.invoke(methodInfo.getObj());
 } catch (IllegalAccessException e) {
 e.printStackTrace();
 } catch (InvocationTargetException e) {
 e.printStackTrace();
 }
 }
 }
}

其中的addEventToMap函數(shù)的作用是將對應的事件、事件觸發(fā)后需要觸發(fā)的對應業(yè)務內(nèi)的Method存放在eventListMap內(nèi)；而submit函數(shù)會在其他業(yè)務類內(nèi)拋出事件的時候被調(diào)用，而作用是從eventListMap中取出對應的Method，并通過反射觸發(fā)。

步驟三：

實現(xiàn)事件處理器，該事件處理器的作用是在bean被spring容器實例化后去判斷對應的bean是否有相應函數(shù)加了@ReceiveAnno注解，如果有則從中取出對應的Event并放入EventContainer中。

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc 事件處理器
 */
@Component
public class EventProcessor extends InstantiationAwareBeanPostProcessorAdapter {

 @Override
 public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {

 ReflectionUtils.doWithLocalMethods(bean.getClass(), new ReflectionUtils.MethodCallback() {
 @Override
 public void doWith(Method method) throws IllegalArgumentException, IllegalAccessException {

 ReceiveAnno anno = method.getAnnotation(ReceiveAnno.class);
 if (anno == null) {
  return;
 }

 Class clz = anno.clz();
 try {
  if (!IEvent.class.isInstance(clz.newInstance())) {
  FormattingTuple message = MessageFormatter.format("{}沒有實現(xiàn)IEvent接口", clz);
  throw new RuntimeException(message.getMessage());
  }
 } catch (InstantiationException e) {
  e.printStackTrace();
 }

 EventContainer.addEventToMap(clz, method, bean);
 }
 });

 return super.postProcessAfterInstantiation(bean, beanName);
 }

}

關于InstantiationAwareBeanPostProcessorAdapter的描述，有需要的可以查看我之前的文章，其中比較詳細描述到Spring中的InstantiationAwareBeanPostProcessor類的作用。

步驟四：

對應的業(yè)務類的實現(xiàn)如下：

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc
 */
@Slf4j
@Service
public class AFuncService implements IAFuncService {

 @Override
 public void login() {
 log.info("[{}]拋出登錄事件 ... ", this.getClass());
 EventContainer.submit(LoginEvent.class);
 }
}

A業(yè)務類，login會在被調(diào)用的生活拋出LoginEvent事件。

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc
 */
@Service
@Slf4j
public class BFuncService implements IBFuncService {

 @ReceiveAnno(clz = LoginEvent.class)
 private void doAfterLogin() {
 log.info("[{}]監(jiān)聽到登錄事件 ... ", this.getClass());
 }
}

/**
 * @author xifanxiaxue
 * @date 3/31/19
 * @desc
 */
@Service
@Slf4j
public class CFuncService implements ICFuncService {

 @ReceiveAnno(clz = LoginEvent.class)
 private void doAfterLogin() {
 log.info("[{}]監(jiān)聽到登錄事件 ... ", this.getClass());
 }
}

B和C業(yè)務類的doAfterLogin都分別加了注解 @ReceiveAnno(clz = LoginEvent.class) ，在監(jiān)聽到事件LoginEvent后被觸發(fā)。
為了觸發(fā)方便，我在spring提供的測試類內(nèi)加了實現(xiàn)，代碼如下：

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

 @Autowired
 private AFuncService aFuncService;

 @Test
 public void contextLoads() {
 aFuncService.login();
 }
}

可以從中看出啟動該測試類后，會調(diào)用業(yè)務A的login函數(shù)，而我們要的效果是B業(yè)務類和C業(yè)務類的doAfterLogin函數(shù)會被自動觸發(fā)，那么結果如何呢？

結果打印