ApplicationEvent解耦业务

最新推荐文章于 2024-02-03 14:29:16 发布

原创最新推荐文章于 2024-02-03 14:29:16 发布 · 161 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring

本文介绍了Spring框架中使用ApplicationEvent和ApplicationListener实现事件监听和发布的步骤。首先，创建自定义事件TaskEvent，继承ApplicationEvent并设置消息字段。然后，通过ApplicationEventPublisher发布事件，当满足条件时触发事件。接着，使用@Async和@EventListener注解实现异步监听，监听到事件后进行处理，如结合WebSocket发送消息。此外，还提及了ApplicationContextAware接口，用于获取ApplicationContext中的bean。

一、ApplicationEvent+Listener

spring提供了ApplicationEvent+Listener实现事件监听等功能，实现了观察者模式。通过 ApplicationEvent 类和 ApplicationListener 接口来提供在 ApplicationContext 中处理事件。如果一个 bean 实现 ApplicationListener，那么每次 ApplicationEvent 被发布到 ApplicationContext 上。

二、使用步骤

1.继承ApplicationEvent，重写构造方法，建立需要监听发布的事件

public class TaskEvent extends ApplicationEvent {
    /**
     * 消息
     */
    private String msg;

    public  TaskEvent(Object source,String msg){
        super(source);
        this.msg = msg;
    }

    public  String getMsg(){
        return msg;
    }
}

2.ApplicationEventPublisher 发布事件

ApplicationContext扩展了ApplicationEventPublisher，也可用ApplicationContext发布事件

    @Autowired
    private ApplicationEventPublisher applicationEventPublisher; 
    @PostMapping("/handler")
    public ErrorMsg handler(@RequestBody String  msg){
        try{
           JSONObject jsonObject = JSONObject.parseObject(msg);
           if(jsonObject.containsKey("user")){
               applicationEventPublisher.publishEvent(new TaskEvent(this,msg));
           }
            return new ErrorMsg("0","success");

        }catch (Exception e){
            logger.error("发布失败！",e);
            return  new ErrorMsg("-1","failed","执行异常！");
        }
    }

3.监听事件

使用EventListener注解，也可实现ApplicationListener接口，传递事件，重写onApplicationEvent方法。
@Async注解实现异步监听，是Spring内的一个组件，可以完成对类内单个或者多个方法实现异步调用，节省等待耗时。内部实现机制是线程池任务ThreadPoolTaskExecutor，通过线程池来对配置@Async的方法或者类做出执行动作。
监听事件后做相应处理，可以结合websocket进行消息推送。

@Component
public class TaskListener {

    @Async
    @EventListener
    public void sendMsg(TaskEvent event){
        System.out.println("任务事件触发！！！！");
    }
}

通过postman调用接口，可以看到成功触发事件
在这里插入图片描述

顺手记录下ApplicationContextAware，通过ApplicationContextAware接口进行实现从已有的spring上下文取得已实例化的bean。

当一个类实现了这个接口（ApplicationContextAware）之后，这个类就可以方便获得ApplicationContext中的所有bean。这个类可以直接获取spring配置文件中，所有有引用到的bean对象。
用作工具类实现ApplicationContextAware接口，重写setApplicationContext方法，从而可以使用spring上下文的getBean等方法获取对象。

    @Override
    public void setApplicationContext(ApplicationContext arg0) throws BeansException {
        applicationContext = arg0;
    }

参考：
[1] https://www.jianshu.com/p/ef2cee8c5dd1
[2] https://segmentfault.com/a/1190000011433514
[3] https://blog.youkuaiyun.com/shenchaohao12321/article/details/85303453
[4] https://www.jianshu.com/p/e450cded3306
[5] https://www.jianshu.com/p/4c0723615a52