使用Spring的ApplicationEvent實現(xiàn)本地事件驅(qū)動的實現(xiàn)方法
一、介紹
Spring內(nèi)置了簡便的事件機制，可以非常方便的實現(xiàn)事件驅(qū)動，核心類包括
- ApplicationEvent，具體事件內(nèi)容，事件抽象基類，可繼承該類自定義具體事件
- ApplicationEventPublisher，事件發(fā)布器，可以發(fā)布ApplicationEvent，也可以發(fā)布普通的Object對象
- ApplicationListener，事件監(jiān)聽器，可以使用注解
@EventListener - TransactionalEventListener，事務事件監(jiān)聽，可監(jiān)聽事務提交前、提交后、事務回滾、事務完成（成功或失敗）
二、使用示例
不定義事件，直接發(fā)布Object對象，同步
1、定義發(fā)送事件對象
public class UserEntity {
private long id;
private String name;
private String msg;
}
2、定義事件監(jiān)聽器
可以添加條件condition，限制監(jiān)聽具體的事件
@Slf4j
@Component
public class RegisterListener {
@EventListener(condition = "#entity.id != null and #entity.async==false ")
public void handlerEvent(UserEntity entity) {
try {
// 休眠5秒
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
e.printStackTrace();
}
log.info("handlerEvent: {}", entity);
}
}
3、定義發(fā)送接口以及實現(xiàn)類
public interface IRegisterService {
public void register(String name);
}
@Service
public class RegisterServiceImpl implements IRegisterService {
@Resource
private ApplicationEventPublisher applicationEventPublisher;
@Override
public void register(String name) {
UserEntity entity = new UserEntity();
entity.setName(name);
entity.setId(1L);
entity.setMsg("新用戶注冊同步調(diào)用");
applicationEventPublisher.publishEvent(entity);
}
}
4、測試Controller類，進行測試
@Slf4j
@Controller
public class TestController {
@Resource
private IRegisterService registerService;
@RequestMapping("test")
@ResponseBody
public void test1(String name) {
registerService.register(name);
log.info("執(zhí)行同步調(diào)用結束");
}
}
在瀏覽器中輸入地址：http://localhost/test?name=nik
控制臺輸出：
handlerEvent: UserEntity(id=1, name=nik, msg=新用戶注冊同步調(diào)用)
執(zhí)行同步調(diào)用結束
三、異步發(fā)布示例
1、在啟動類添加異步注解 @EnableAsync
2、在監(jiān)聽方法上添加注解 @Async
@Async
@EventListener(condition = "#entity.name != null and #entity.async ")
public void handlerEventAsync(UserEntity entity) {
try {
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
e.printStackTrace();
}
log.info("handlerEventAsync: {}", entity);
}
3、在service中添加異步發(fā)送方法
@Override
public void registerAsyn(String name) {
UserEntity entity = new UserEntity();
entity.setName(name);
entity.setId(1L);
entity.setMsg("新用戶注冊異步調(diào)用");
entity.setAsync(true);
applicationEventPublisher.publishEvent(entity);
}
4、測試
@RequestMapping("test")
@ResponseBody
public void test(String name) {
registerService.registerAsyn(name);
log.info("執(zhí)行異步調(diào)用結束");
}
控制臺輸出：
執(zhí)行異步調(diào)用結束
handlerEventAsync: UserEntity(id=1, name=nik, msg=新用戶注冊異步調(diào)用)
四、在事務提交后發(fā)布事件示例
比如，用戶注冊成功后給用戶發(fā)送成功短信，那么注冊成功必然是注冊方法事務提交成功后才代表成功。
Spring提供了注解@TransactionalEventListener監(jiān)聽事務事件，在@EventListener基礎上增加了屬性phase，包含以下四個值：
AFTER_COMMIT，事務提交成功后，默認BEFORE_COMMIT，事務提交前AFTER_ROLLBACK，事務回滾后AFTER_COMPLETION，事務完成，AFTER_COMMIT或AFTER_ROLLBACK
1、自定義事務處理事件
public class RegisterCommitEvent extends ApplicationEvent {
@Getter
@Setter
private String msg;
@Getter
@Setter
private String name;
public RegisterCommitEvent(UserEntity source) {
super(source);
this.msg = source.getMsg();
this.name = source.getName();
}
}
2、在處理方法上添加事務注解，@Transactional
@Override
@Transactional
public void registerCommit(String name) {
UserEntity entity = new UserEntity();
entity.setName(name);
entity.setMsg("新用戶注冊事務提交事件");
RegisterCommitEvent registerEvent = new RegisterCommitEvent(entity);
userDao.save(entity);
// 發(fā)送事件
applicationEventPublisher.publishEvent(registerEvent);
}
3、添加事務事件監(jiān)聽
@Async
@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
public void handlerEventCmmit(RegisterCommitEvent event) {
try {
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
e.printStackTrace();
}
log.info("handlerEventCmmit: {}", event);
}
4、測試
@RequestMapping("test")
@ResponseBody
public void test(String name) {
registerService.registerCommit(name);
log.info("執(zhí)行事務調(diào)用結束");
}
控制臺輸出：
執(zhí)行事務調(diào)用結束
handlerEventCmmit: RegisterCommitEvent[source=UserEntity(id=0, name=nik, msg=新用戶注冊事務提交事件)]
總結
Spring ApplicationEvent事件處理機制使用起來簡單方便，可以對程序進行有效解耦。
雖然可以發(fā)送任意類型的對象，但是在實際業(yè)務中容易產(chǎn)生混亂，建議根據(jù)實際業(yè)務，定義好各類事件，并在監(jiān)聽方法中實現(xiàn)異步處理。
到此這篇關于使用Spring的ApplicationEvent實現(xiàn)本地事件驅(qū)動的實現(xiàn)方法的文章就介紹到這了,更多相關Spring ApplicationEvent本地事件驅(qū)動內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
java使用poi在excel單元格添加超鏈接設置字體顏色的方法
這篇文章主要介紹了java使用poi在excel單元格添加超鏈接，設置字體顏色,poi功能還是很強大的，基本能想到的功能都能通過poi實現(xiàn)，本文結合實例代碼給大家介紹的非常詳細，需要的朋友可以參考下2023-09-09
Java基礎教程之基本類型數(shù)據(jù)類型、包裝類及自動拆裝箱
這篇文章主要給大家介紹了關于Java基礎教程之基本類型數(shù)據(jù)類型、包裝類及自動拆裝箱的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-06-06
這篇文章主要介紹了Java使用Tessdata做OCR圖片文字識別的詳細思路,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-07-07
JetBrains?發(fā)布下一代?IDE無比輕量幾秒就能啟動干活
雖然?JetBrains?公司說?Fleet?的定位和目標并不是代替其他?IDE，但個人覺得，?如果?Fleet?火起來了，其他?IDE?就會黯然失色，特別是多語言開發(fā)者，誰愿意裝多個?IDE?呢？到時候，可能?JetBrains?以后的所有?IDE?要一統(tǒng)江湖了2021-12-12
這篇文章主要介紹了SpringBoot使用protobuf格式的接口方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
SpringBoot之自定義Filter獲取請求參數(shù)與響應結果案例詳解
這篇文章主要介紹了SpringBoot之自定義Filter獲取請求參數(shù)與響應結果案例詳解,本篇文章通過簡要的案例,講解了該項技術的了解與使用,以下就是詳細內(nèi)容,需要的朋友可以參考下2021-09-09
這篇文章主要介紹了java中1+1d/5和1+1/5的區(qū)別說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-10-10
springboot2中HikariCP連接池的相關配置問題
這篇文章主要介紹了springboot2中HikariCP連接池的相關配置問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-12-12
這篇文章主要為大家詳細介紹了基于JavaMail實現(xiàn)郵件發(fā)送功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-03-03
Java中LinkedHashSet的實現(xiàn)原理詳解
這篇文章主要介紹了Java中LinkedHasSet的實現(xiàn)原理詳解,LinkedHashSet?是具有可預知迭代順序的?Set?接口的哈希表和鏈接列表實現(xiàn),此實現(xiàn)與HashSet?的不同之處在于,后者維護著一個運行于所有條目的雙重鏈接列表,需要的朋友可以參考下2023-09-09