观察者模式实际应用场景：Spring事件机制

比眉伴天荒 2022-10-22 04:25 179阅读 0赞

![6a0407de05acf7109bd5d71678044693.png][]

*来源：blog.csdn.net/weixin\_39035120/article/details/86225377*

以下伪代码是一个保存订单的功能，并会发送短信消息：

现有新需求：需要加一个微信通知的功能，代码如下：

@Service
    public class OrderServiceImpl implements OrderService {
     
        @Override
        public void saveOrder() {
            //1.创建订单
            System.out.println("订单创建成功");
            //2.发送短信
            System.out.println("恭喜您订单创建成功！----by sms");
            //新需求：微信通知
            // 3.发送微信
            System.out.println("恭喜您订单创建成功！----by wechat");
        }
    }

存在问题：每次创建订单需要加新功能（如新的通知方式），则要修改原有的类，难以维护。（搜索公众号Java知音，回复“2021”，送你一份Java面试题宝典）

违背设计模式的原则

1.  单一职责：订单保存功能，杂糅了消息通知这些功能
2.  开闭原则：对拓展开放，对修改关闭

优化方案：使用观察者模式，使创建订单和消息通知进行分离，低耦合。可以选择消息队列，spring事件机制等，本文选择Spring事件机制。

### 改造开始 ###

#### 1.创建事件 ####

package com.pengshu.magicwallet.admin.test;
     
    import org.springframework.context.ApplicationEvent;
     
    import java.util.List;
     
    /**
    * 订单创建活动事件
    */
    public class OrderCreateEvent extends ApplicationEvent {
     
        private String name;
     
        //消息参数
        private List<String> contentList;
     
        public OrderCreateEvent(Object source, String name, List<String> contentList) {
            super(source);
            this.name = name;
            this.contentList = contentList;
        }
     
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
        public List<String> getContentList() {
            return contentList;
        }
        public void setContentList(List<String> contentList) {
            this.contentList = contentList;
        }
    }

#### 2.监听器 ####

package com.pengshu.magicwallet.admin.test;
     
    import org.springframework.context.ApplicationListener;
    import org.springframework.stereotype.Component;
     
    /**
    * 短信监听器
    * ApplicationListener是无序的
    */
    @Component
    public class SmsListener implements ApplicationListener<OrderCreateEvent> {
     
        @Override
        public void onApplicationEvent(OrderCreateEvent event) {
            //发送短信
            System.out.println(event.getContentList().get(0) + ",您的订单:" + event.getContentList().get(1) + "创建成功! ----by sms");
     
        }
    }

package com.pengshu.magicwallet.admin.test;
     
    import org.springframework.context.ApplicationListener;
    import org.springframework.stereotype.Component;
     
    /**
    * 微信监听器
    */
    @Component
    public class WechatListener implements ApplicationListener<OrderCreateEvent> {
     
        @Override
        public void onApplicationEvent(OrderCreateEvent event) {
            //发送微信
            System.out.println(event.getContentList().get(0) + ",您的订单:" + event.getContentList().get(1) + "创建成功! ----by wechat");
     
        }
    }

#### 3.事件发布 ####

package com.pengshu.magicwallet.admin.test;
     
    import org.springframework.context.ApplicationContext;
    import org.springframework.stereotype.Service;
     
    import javax.annotation.Resource;
    import java.util.ArrayList;
     
    @Service
    public class OrderServiceImpl implements OrderService {
     
        @Resource
        private ApplicationContext applicationContext;
     
        @Autowired
        private ApplicationEventPublisher applicationEventPublisher;
     
        @Override
        public void saveOrder() {
            //1.创建订单
            System.out.println("订单创建成功");
            //2.发布事件
            ArrayList<String> contentList = new ArrayList<>();
            contentList.add("heling");
            contentList.add("123456789");
            OrderCreateEvent orderCreateEvent = new OrderCreateEvent(this, "订单创建", contentList);
            applicationContext.publishEvent(orderCreateEvent);//ApplicationContext是我们的事件容器上层，我们发布事件，也可以通过此容器完成发布
            //applicationEventPublisher.publishEvent(orderCreateEvent);//也可以
            System.out.println("finished!");
        }
    }

打印结果：

订单创建成功
    
    heling,您的订单:123456789创建成功! ----by sms
    
    heling,您的订单:123456789创建成功! ----by wechat
    
    finished!

### 如何异步执行监听器？ ###

#### 1.springboot开启事件异步设置 ####

package com.pengshu.magicwallet;
     
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.scheduling.annotation.EnableAsync;
    import org.springframework.transaction.annotation.EnableTransactionManagement;
     
    @SpringBootApplication
    @MapperScan("com.pengshu.magicwallet.mapper")
    @PropertySource("classpath:authority.properties")
    @EnableTransactionManagement
    @EnableAsync //开启spring事件异步设置，加@Async注解
    public class MagicWalletAdminApplication {
        public static void main(String[] args) {
            SpringApplication.run(MagicWalletAdminApplication.class, args);
        }
    }

#### 2.监听器类或方法添加@Async注解 ####

打印结果：

订单创建成功
    
    finished!
    
    heling,您的订单:123456789创建成功! ----by sms
    
    heling,您的订单:123456789创建成功! ----by wechat

### 如何制定监听器执行顺序？ ###

package com.pengshu.magicwallet.admin.test;
     
    import org.springframework.context.ApplicationEvent;
    import org.springframework.context.event.SmartApplicationListener;
    import org.springframework.stereotype.Component;
     
    /**
    * 微信监听器
    * SmartApplicationListener可以设置顺序等
    */
    @Component
    public class WechatListener implements SmartApplicationListener {
     
        //设置监听优先级
        @Override
        public int getOrder() {
            return 1;
        }
     
        //监听器智能所在之一，能够根据事件类型动态监听
        @Override
        public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
            return aClass == OrderCreateEvent.class;
        }
     
        //监听器智能所在之二，能够根据事件发布者类型动态监听
        @Override
        public boolean supportsSourceType(Class<?> aClass) {
            return aClass == OrderServiceImpl.class;
        }
     
        @Override
        public void onApplicationEvent(ApplicationEvent applicationEvent) {
            OrderCreateEvent event = (OrderCreateEvent) applicationEvent;
            //发送微信
            System.out.println(event.getContentList().get(0) + ",您的订单:" + event.getContentList().get(1) + "创建成功! ----by wechat");
     
        }
     
    //    @Override
    //    @Async
    //    public void onApplicationEvent(OrderCreateEvent event) {
    //
    //        //发送微信
    //        System.out.println(event.getContentList().get(0) + ",您的订单:" + event.getContentList().get(1) + "创建成功! ----by wechat");
    //
    //    }
    }

package com.pengshu.magicwallet.admin.test;
     
    import org.springframework.context.ApplicationEvent;
    import org.springframework.context.event.SmartApplicationListener;
    import org.springframework.stereotype.Component;
     
    /**
    * 短信监听器
    */
    @Component
    public class SmsListener implements SmartApplicationListener {
     
        @Override
        public int getOrder() {
            return 2;
        }
     
        @Override
        public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
            return aClass == OrderCreateEvent.class;
        }
     
        @Override
        public boolean supportsSourceType(Class<?> aClass) {
            return aClass == OrderServiceImpl.class;
        }
     
        @Override
        public void onApplicationEvent(ApplicationEvent applicationEvent) {
            OrderCreateEvent event = (OrderCreateEvent) applicationEvent;
            //发送短信
            System.out.println(event.getContentList().get(0) + ",您的订单:" + event.getContentList().get(1) + "创建成功! ----by sms");
     
        }
     
    //    @Override
    //    @Async
    //    public void onApplicationEvent(OrderCreateEvent event) {
    //
    //        //发送短信
    //        System.out.println(event.getContentList().get(0) + ",您的订单:" + event.getContentList().get(1) + "创建成功! ----by sms");
    //
    //    }
    }

打印结果：

订单创建成功
    
    heling,您的订单:123456789创建成功! ----by wechat
    
    heling,您的订单:123456789创建成功! ----by sms
    
    finished!

在实现了SmartApplicationListener的监听器中，我们通过重写GetOrder方法来修改不同监听器的顺序，**优先级越小，则越先被调用**。通过配置不同的优先级，且让监听器之间阻塞调用。我们就能实现流水线式的有序事件调用，这在实际应用场景中还是蛮有意义的

推荐好文

[强大，10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程！][10k_ SpringBoot]

[分享一套基于SpringBoot和Vue的企业级中后台开源项目，代码很规范！][SpringBoot_Vue]

[能挣钱的，开源 SpringBoot 商城系统，功能超全，超漂亮][SpringBoot]![f076a103281607f7769d998c74d0450a.png][]

[6a0407de05acf7109bd5d71678044693.png]: /images/20221022/3e2753b075da4357ba62f4c5e66eb9f7.png
[10k_ SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzI4Njc5NjM1NQ%3D%3D&chksm=ebd5c411dca24d07446a4f22772cd12d2cc1143b62eb922a14500ae981cd57fb850ef74ca257&idx=2&mid=2247498557&scene=21&sn=84902d7030e174e152615d8fae3755cc#wechat_redirect
[SpringBoot_Vue]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799be6cb0e12f0b58479f8b031bc5ae79efdca1880ff9b19f0a107c3a88c37b9596dc73203&idx=2&mid=2247497288&scene=21&sn=65d7111a19e920df1e9416959594b2f4#wechat_redirect
[SpringBoot]: http://mp.weixin.qq.com/s?__biz=MzU2MTI4MjI0MQ%3D%3D&chksm=fc799a9ccb0e138a64a2671f31b8d4be1b3c061a288f7b0d1d4af02a60c45a72231446b91e00&idx=2&mid=2247497522&scene=21&sn=c5b4e596be4ac7d7f293e7e2f0ea0769#wechat_redirect
[f076a103281607f7769d998c74d0450a.png]: /images/20221022/eb2e59765bd348ae8f9a60f087331a31.png