怎么使用Spring的ApplicationEvent實現本地事件驅動

本篇內容介紹了“怎么使用Spring的ApplicationEvent實現本地事件驅動”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！

一、介紹

Spring內置了簡便的事件機制，可以非常方便的實現事件驅動，核心類包括

• ApplicationEvent，具體事件內容，事件抽象基類，可繼承該類自定義具體事件

• ApplicationEventPublisher，事件發布器，可以發布ApplicationEvent，也可以發布普通的Object對象

• ApplicationListener，事件監聽器，可以使用注解@EventListener

• TransactionalEventListener，事務事件監聽，可監聽事務提交前、提交后、事務回滾、事務完成（成功或失敗）

二、使用示例

不定義事件，直接發布Object對象，同步

1、定義發送事件對象

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

2、定義事件監聽器

可以添加條件condition，限制監聽具體的事件

@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、定義發送接口以及實現類

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("新用戶注冊同步調用");
        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("執行同步調用結束");
    }
}

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

控制臺輸出：

handlerEvent: UserEntity(id=1, name=nik, msg=新用戶注冊同步調用)
執行同步調用結束

三、異步發布示例

1、在啟動類添加異步注解 @EnableAsync

2、在監聽方法上添加注解 @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中添加異步發送方法

@Override
public void registerAsyn(String name) {
    UserEntity entity = new UserEntity();
    entity.setName(name);
    entity.setId(1L);
    entity.setMsg("新用戶注冊異步調用");
    entity.setAsync(true);
    applicationEventPublisher.publishEvent(entity);
}

4、測試

@RequestMapping("test")
@ResponseBody
public void test(String name) {
    registerService.registerAsyn(name);
    log.info("執行異步調用結束");
}

控制臺輸出：

執行異步調用結束
handlerEventAsync: UserEntity(id=1, name=nik, msg=新用戶注冊異步調用)

四、在事務提交后發布事件示例

比如，用戶注冊成功后給用戶發送成功短信，那么注冊成功必然是注冊方法事務提交成功后才代表成功。

Spring提供了注解@TransactionalEventListener監聽事務事件，在@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);
    // 發送事件
    applicationEventPublisher.publishEvent(registerEvent);
}

3、添加事務事件監聽

@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("執行事務調用結束");
}

控制臺輸出：

執行事務調用結束
handlerEventCmmit: RegisterCommitEvent[source=UserEntity(id=0, name=nik, msg=新用戶注冊事務提交事件)]

“怎么使用Spring的ApplicationEvent實現本地事件驅動”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！