基於Spring Boot應用ApplicationEvent案例場景
記錄:276
場景:利用Spring的機制發佈ApplicationEvent和監聽ApplicationEvent。
版本:Spring Boot 2.6.3
一、案例場景
1.發起restful請求,根據請求參數發佈不同的事件。
2.事件監聽者,監聽到事件後,做預定操作。
3.本例是事件同步處理機制,即發佈事件後,會同步監聽事件。
二、使用類
org.springframework.context.ApplicationEvent,spring的事件對象。
org.springframework.context.ApplicationListener,事件監聽者接口。
org.springframework.context.ApplicationEventPublisher,事件發佈者接口。
三、代碼
1.事件對象
事件對象實現ApplicationEvent。
1.1 ExampleApplicationEvent
ExampleApplicationEvent,一個抽象類。繼承ApplicationEvent,自定義拓展微服務中需求的一些屬性。
public abstract class ExampleApplicationEvent extends ApplicationEvent { private static final String eventSource = "Example"; private String eventType = null; private Object eventData = null; public ExampleApplicationEvent(Object eventData) { super(eventSource); this.eventData = eventData; } public ExampleApplicationEvent(Object eventData, String eventType) { super(eventSource); this.eventData = eventData; this.eventType = eventType; } public String getEventType() { return eventType; } public Object getEventData() { return eventData; } }
1.2 ExampleLocalApplicationEvent
ExampleLocalApplicationEvent,是抽象類ExampleApplicationEvent的實現類,在此處按需拓展屬性。
public class ExampleLocalApplicationEvent extends ExampleApplicationEvent { public ExampleLocalApplicationEvent(Object eventData) { super(eventData); } public ExampleLocalApplicationEvent(Object eventData, String eventType) { super(eventData, eventType); } }
1.3 EventTypeEnum
EventTypeEnum,自定義事件類型枚舉,按需擴展。
public enum EventTypeEnum { CHANGE("change", "變更事件"), ADD("add", "新增事件"); private String id; private String name; public String getId() { return id; } public String getName() { return name; } EventTypeEnum(String id, String name) { this.id = id; this.name = name; } public static EventTypeEnum getEventTypeEnum(String id) { for (EventTypeEnum var : EventTypeEnum.values()) { if (var.getId().equalsIgnoreCase(id)) { return var; } } return null; } }
2.事件監聽者
事件監聽者包括接口和抽象類。
2.1 IEventListener
IEventListener,一個接口,繼承ApplicationListener接口。
@SuppressWarnings("rawtypes") public interface IEventListener extends ApplicationListener { }
2.2 AbstractEventListener
AbstractEventListener,一個抽象類,實現IEventListener接口。並提供抽象方法便於實現類擴展和代碼解耦。
public abstract class AbstractEventListener implements IEventListener { @Override public void onApplicationEvent(ApplicationEvent event){ if(!(event instanceof ExampleApplicationEvent)){ return; } ExampleApplicationEvent exEvent = (ExampleApplicationEvent) event; try{ onExampleApplicationEvent(exEvent); }catch (Exception e){ e.printStackTrace(); } } protected abstract void onExampleApplicationEvent(ExampleApplicationEvent event); }
2.3 OrderEventListener
OrderEventListener,實現類AbstractEventListener抽象類。監聽事件,並對事件做處理,是一個業務類。
@Slf4j @Component public class OrderEventListener extends AbstractEventListener { @Override protected void onExampleApplicationEvent(ExampleApplicationEvent event) { log.info("OrderEventListener->onSpApplicationEvent,監聽事件."); Object eventData = event.getEventData(); log.info("事件類型: " + EventTypeEnum.getEventTypeEnum(event.getEventType())); log.info("事件數據: " + eventData.toString()); } }
3.事件發佈者
事件監聽者包括接口和實現類。
3.1 IEventPublisher
IEventPublisher,自定義事件發佈接口,方便擴展功能和屬性。
public interface IEventPublisher { boolean publish(ExampleApplicationEvent event); }
3.2 LocalEventPublisher
LocalEventPublisher,事件發佈實現類,此類使用@Component,spring的IOC容器會加載此類。此類調用ApplicationEventPublisher的publishEvent發佈事件。
@Slf4j @Component("localEventPublisher") public class LocalEventPublisher implements IEventPublisher { @Override public boolean publish(ExampleApplicationEvent event) { try{ log.info("LocalEventPublisher->publish,發佈事件."); log.info("事件類型: " + EventTypeEnum.getEventTypeEnum(event.getEventType())); log.info("事件數據: " + event.getEventData().toString()); SpringUtil.getApplicationContext().publishEvent(event); }catch (Exception e){ log.info("事件發佈異常."); e.printStackTrace(); return false; } return true; } }
4.Restful請求觸發事件
使用Restful請求觸發事件發生。
4.1 EventController
EventController,接收Restful請求。
@Slf4j @RestController @RequestMapping("/event") public class EventController { @Autowired private LocalEventPublisher eventPublisher; @PostMapping("/f1") public Object f1(@RequestBody Object obj) { log.info("EventController->f1,接收參數,obj = " + obj.toString()); Map objMap = (Map) obj; OrderInfo orderInfo = new OrderInfo(); orderInfo.setUserName((String) objMap.get("userName")); orderInfo.setTradeName((String) objMap.get("tradeName")); orderInfo.setReceiveTime(DateUtil.format(new Date(), "yyyy-MM-dd HH:mm:ss")); String flag = (String) objMap.get("flag"); if (StringUtils.equals("change", flag)) { eventPublisher.publish(new ExampleLocalApplicationEvent(orderInfo, EventTypeEnum.CHANGE.getId())); } else if (StringUtils.equals("add", flag)) { eventPublisher.publish(new ExampleLocalApplicationEvent(orderInfo, EventTypeEnum.ADD.getId())); } else { eventPublisher.publish(new ExampleLocalApplicationEvent(orderInfo)); } log.info("EventController->f1,返回."); return ResultObj.builder().code("200").message("成功").build(); } }
4.2 OrderInfo
OrderInfo,數據對象,放入事件對象中傳遞。
@Data @NoArgsConstructor public class OrderInfo { private String userName; private String tradeName; private String receiveTime; }
4.3 ResultObj
ResultObj,restful返回通用對象。
@Data @NoArgsConstructor @AllArgsConstructor @Builder public class ResultObj { private String code; private String message; }
5.測試
5.1 請求信息
URL請求: http://127.0.0.1:8080/server/event/f1
入參:
{ "userName": "HangZhou", "tradeName": "Vue進階教程", "flag": "add" }
返回值:
{ "code": "200", "message": "成功" }
5.2 日志
輸出日志:
以上,感謝。
到此這篇關於基於Spring Boot應用ApplicationEvent的文章就介紹到這瞭,更多相關Spring Boot應用ApplicationEvent內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- java和Spring中觀察者模式的應用詳解
- SpringBoot中ApplicationEvent和ApplicationListener用法小結
- 詳解Spring事件發佈與監聽機制
- Spring ApplicationListener源碼解析
- @TransactionalEventListener的使用和實現原理分析