快捷導(dǎo)航

使用Spring的ApplicationEvent實(shí)現(xiàn)本地事件驅(qū)動(dòng)的實(shí)現(xiàn)方法

更新時(shí)間：2023年04月26日 09:56:11 作者：頑石九變

本文介紹了如何使用Spring的ApplicationEvent實(shí)現(xiàn)本地事件驅(qū)動(dòng)，通過(guò)自定義事件和監(jiān)聽(tīng)器，實(shí)現(xiàn)模塊之間的松耦合，提升代碼的可維護(hù)性和擴(kuò)展性。同時(shí)還介紹了異步事件和事件傳遞的相關(guān)知識(shí)

一、介紹

Spring內(nèi)置了簡(jiǎn)便的事件機(jī)制，可以非常方便的實(shí)現(xiàn)事件驅(qū)動(dòng)，核心類包括

ApplicationEvent，具體事件內(nèi)容，事件抽象基類，可繼承該類自定義具體事件
ApplicationEventPublisher，事件發(fā)布器，可以發(fā)布ApplicationEvent，也可以發(fā)布普通的Object對(duì)象
ApplicationListener，事件監(jiān)聽(tīng)器，可以使用注解@EventListener
TransactionalEventListener，事務(wù)事件監(jiān)聽(tīng)，可監(jiān)聽(tīng)事務(wù)提交前、提交后、事務(wù)回滾、事務(wù)完成（成功或失?。?/li>

二、使用示例

不定義事件，直接發(fā)布Object對(duì)象，同步

1、定義發(fā)送事件對(duì)象

public class UserEntity {
    private long id;
    private String name;
    private String msg;
}

2、定義事件監(jiān)聽(tīng)器

可以添加條件condition，限制監(jiān)聽(tīng)具體的事件

@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ā)送接口以及實(shí)現(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("新用戶注冊(cè)同步調(diào)用");
        applicationEventPublisher.publishEvent(entity);
    }
}

4、測(cè)試Controller類，進(jìn)行測(cè)試

@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)用結(jié)束");
    }
}

在瀏覽器中輸入地址：http://localhost/test?name=nik

控制臺(tái)輸出：

handlerEvent: UserEntity(id=1, name=nik, msg=新用戶注冊(cè)同步調(diào)用)
執(zhí)行同步調(diào)用結(jié)束

三、異步發(fā)布示例

1、在啟動(dòng)類添加異步注解 @EnableAsync

2、在監(jiān)聽(tīng)方法上添加注解 @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("新用戶注冊(cè)異步調(diào)用");
    entity.setAsync(true);
    applicationEventPublisher.publishEvent(entity);
}

4、測(cè)試

@RequestMapping("test")
@ResponseBody
public void test(String name) {
    registerService.registerAsyn(name);
    log.info("執(zhí)行異步調(diào)用結(jié)束");
}

控制臺(tái)輸出：

執(zhí)行異步調(diào)用結(jié)束
handlerEventAsync: UserEntity(id=1, name=nik, msg=新用戶注冊(cè)異步調(diào)用)

四、在事務(wù)提交后發(fā)布事件示例

比如，用戶注冊(cè)成功后給用戶發(fā)送成功短信，那么注冊(cè)成功必然是注冊(cè)方法事務(wù)提交成功后才代表成功。

Spring提供了注解@TransactionalEventListener監(jiān)聽(tīng)事務(wù)事件，在@EventListener基礎(chǔ)上增加了屬性phase，包含以下四個(gè)值：

AFTER_COMMIT，事務(wù)提交成功后，默認(rèn)
BEFORE_COMMIT，事務(wù)提交前
AFTER_ROLLBACK，事務(wù)回滾后
AFTER_COMPLETION，事務(wù)完成，AFTER_COMMIT 或 AFTER_ROLLBACK

1、自定義事務(wù)處理事件

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、在處理方法上添加事務(wù)注解，@Transactional

@Override
@Transactional
public void registerCommit(String name) {
    UserEntity entity = new UserEntity();
    entity.setName(name);
    entity.setMsg("新用戶注冊(cè)事務(wù)提交事件");
    RegisterCommitEvent registerEvent = new RegisterCommitEvent(entity);
    userDao.save(entity);
    // 發(fā)送事件
    applicationEventPublisher.publishEvent(registerEvent);
}

3、添加事務(wù)事件監(jiān)聽(tīng)

@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、測(cè)試

@RequestMapping("test")
@ResponseBody
public void test(String name) {
    registerService.registerCommit(name);
    log.info("執(zhí)行事務(wù)調(diào)用結(jié)束");
}

控制臺(tái)輸出：

執(zhí)行事務(wù)調(diào)用結(jié)束
handlerEventCmmit: RegisterCommitEvent[source=UserEntity(id=0, name=nik, msg=新用戶注冊(cè)事務(wù)提交事件)]

總結(jié)

Spring ApplicationEvent事件處理機(jī)制使用起來(lái)簡(jiǎn)單方便，可以對(duì)程序進(jìn)行有效解耦。

雖然可以發(fā)送任意類型的對(duì)象，但是在實(shí)際業(yè)務(wù)中容易產(chǎn)生混亂，建議根據(jù)實(shí)際業(yè)務(wù)，定義好各類事件，并在監(jiān)聽(tīng)方法中實(shí)現(xiàn)異步處理。

到此這篇關(guān)于使用Spring的ApplicationEvent實(shí)現(xiàn)本地事件驅(qū)動(dòng)的實(shí)現(xiàn)方法的文章就介紹到這了,更多相關(guān)Spring ApplicationEvent本地事件驅(qū)動(dòng)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: