本篇内容介绍了“怎么使用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=新用户注册事务提交事件)]