考拉消息中心消息盒子处理重构（策略模式）

叁歲伎倆 2022-04-05 07:49 231阅读 0赞

本文由作者周敏敏授权网易云社区发布。

**一.消息中心简单介绍**

考拉app的消息中心是负责发送和接受app站内信的服务，比如营销系统发送的活动消息，优惠券到期消息等。考拉app中的消息中心入口在首页的右上角。点击进去能够看到消息盒子列表，点击消息盒子能够看到该盒子中的消息列表（有些盒子点击是跳转到特定URL）。

![1d9d6063-feed-4bf8-b084-9eb05a87b3c8][]![eceb12c5-ffb4-4585-b932-887003a7867d][]

消息中心的功能简单来说只有**提供接口发送消息、用户接收查看消息两类**。

**发送消息可分为发送私信、组播、广播**

**接受查看消息可分为：**

1.发消息时，根据消息类型设置消息盒子的未读计数（+1操作），最新文案，最新时间等

2.查询返回消息盒子列表（正确返回每个盒子的未读计数，最新文案，最新时间）

3.点击盒子，消除未读消息数（当前实现是只要点击了盒子，就清空该盒子所有未读消息数），返回盒子的消息列表（有些消息盒子是跳转到特定url）

**二.消息盒子越加越多，处理方式各不相同**

刚接触消息中心时，只有活动精选等6个消息盒子（处理逻辑相同，统称为普通盒子），**每个盒子的处理逻辑都一样：**

1.发消息时，增加盒子未读计数、消息ID塞入盒子的消息ID列表中、设置盒子的最新文案和时间

2.点击盒子，清空盒子的未读计数

3.进入盒子，根据盒子的消息ID列表返回消息列表

如果一直是这样，那将是很美好的，可惜……。**在增加种草社区盒子的需求中，种草社区盒子的处理逻辑不同于普通盒子，大概要求**：

1.种草社区盒子只作为查看种草消息的一个入口，消息体不存在消息中心，盒子上的未读计数和文案由种草社区给出。

2.点击种草社区盒子不清空未读计数。

3.点击种草社区盒子跳转到用户的种草社区消息页。

所以对于种草社区盒子的未读计数、最新文案、最新时间以及清空未读计数、点击种草社区盒子跳转等操作，都要求不同于普通盒子的一套逻辑。

如果仅仅是种草社区盒子需要特殊处理，也就罢了，**可惜还有售后进度消息盒子。**不仅仅如此，后面陆续增加了**黑卡先生消息盒子和品牌动态消息盒子**，这两个盒子的处理逻辑也都不相同。如黑卡先生消息盒子需求要求所有关注了黑卡先生账号或者是正式会员的用户才能看到黑卡先生盒子，每当黑卡先生账号有新文章发布或更新就通过未读计数提示用户……。

如此一来就有4个消息盒子需要特殊处理了，可以预见未来可能需要接入更多的，需特殊处理的消息盒子。

**三.简单的实现方式**

1.种草社区消息盒子简单的实现方式是通过mq消息设置最新文案，未读计数等，即完全由种草社区发mq消息告诉消息中心盒子的数据，消息中心只消费mq消息。

2.售后进度消息盒子则是开出两个单独的dubbo接口，用户设置和读取售后进度盒子，这两个dubbo接口只能用于售后消息盒子

// 设置售后进度消息盒子
        public boolean setAfterSaleMessageBoxContent(String accountId, Integer msgNum, String lastContent, Long lastTime, boolean oldReadStatus);    // 读取售后进度消息盒子
        public boolean readAfterSaleMessageBox(String accountId);

这种实现方式的优点是简单直接，再有特殊处理盒子只需要再开dubbo接口实现特殊逻辑即可。缺点是接口不通用，每次都需要开dubbo接口，可扩展性差，部分操作NCR代码重复编写。

四.利用策略模式重构消息盒子处理

在接黑卡先生和品牌动态消息盒子需求时，考虑到再开dubbo接口会让代码变得难以维护，因此考虑采用策略模式将每个盒子的处理抽象成统一的行为。

先介绍策略模式，参考资料：https://blog.csdn.net/zuoxiaolong8810/article/details/9104281定义：策略模式定义了一系列的算法，并将每一个算法封装起来，而且使它们还可以相互替换。策略模式让算法独立于使用它的客户而独立变化。

分析下定义，策略模式定义和封装了一系列的算法，它们是可以相互替换的，也就是说它们具有共性，而它们的共性就体现在策略接口的行为上，另外为了达到最后一句话的目的，也就是说让算法独立于使用它的客户而独立变化，我们需要让客户端依赖于策略接口。

![3e70be3a-68bf-45be-b9de-cfaefc9ed412][]

对比策略模式的定义，我们可以将所有消息盒子的处理抽象成一个策略接口，每个具体盒子的处理对应一个具体的策略实现类。同时实现一个简单工厂方法，根据消息盒子类型选择特定的策略类去处理这个盒子。

朝着这个方向思考，将盒子的处理抽象成如下一个MessageBoxHandler接口，该接口中有四个方法：

1.设置消息盒子的内容（最新文案，未读计数，最新时间等）

2.获取消息盒子的内容

3.读取清理消息盒子内容

4.获取消息盒子里的消息列表

/**
     * 通用消息盒子处理接口。使用策略模式
     */public interface MessageBoxHandler {    /**
         * 设置对应消息盒子的内容，包括最新文案，最新时间，强弱消息数，跳转url
         */
        public void setMessageBoxContent(KaolaAppMessage kaolaAppMessage, MessageBoxSetInfo messageBoxSetInfo, List accountIdList, int boxType, Boolean needUpdateNewMessageTime);    /**
         * 根据用户账号和盒子类型（或者是传入的盒子缓存）得到盒子内容（最新文案，最新时间，强弱消息数）
         */
        public KaolaAppMessageBox getMessageBoxContent(String accountId, int boxType, Map hintMap, boolean needMessage, boolean hasCalculate, Set filterMsgTypeSet);    /**
         * 清空消息盒子上的内容
         */
        public void clearMessageBoxContent(List accountIdList, int boxType);    /**
         * 根据账号和盒子类型返回该盒子中消息列表
         */
        public List getMessageList(String accountId, int boxType, Long indexMessageId, int limit, List filterMsgTypes);
    }

有具体盒子处理策略实现类：

UML图如下：

![675f2896-daff-4162-9b80-9d21a34b1027?imageView&thumbnail=980x0][675f2896-daff-4162-9b80-9d21a34b1027_imageView_thumbnail_980x0]

对照策略模式的UML图，可以看出MessageBoxHandler对应策略接口,抽象了消息盒子可以有的所有操作。MessageBoxHandlerWrapper是该接口的默认空实现，所有具体的盒子处理类只需要直接继承该类，然后覆盖需要的方法即可。对于消息盒子不需要的方法，则直接使用MessageBoxHandlerWrapper中的空实现（如种草社区盒子的getMessageList就是空实现）。

MessageBoxHandlerFactory中简单工厂方法getMessageBoxHandler根据盒子类型获取具体的盒子处理类：

public void init() {
            messageBoxhandlerArr = new MessageBoxHandler[11];
            messageBoxhandlerArr[0] = defaultMessageBoxHandler;
            messageBoxhandlerArr[1] = defaultMessageBoxHandler;
            messageBoxhandlerArr[2] = defaultMessageBoxHandler;
            messageBoxhandlerArr[3] = defaultMessageBoxHandler;
            messageBoxhandlerArr[4] = defaultMessageBoxHandler;
            messageBoxhandlerArr[5] = defaultMessageBoxHandler;
            messageBoxhandlerArr[6] = defaultMessageBoxHandler;
            messageBoxhandlerArr[7] = communityMessageBoxHandler;
            messageBoxhandlerArr[8] = afterSaleMessageBoxHandler;
            messageBoxhandlerArr[9] = blackCardMessageBoxHandler;
            messageBoxhandlerArr[10] = brandDynamicMessageBoxHandler;
        }    public static MessageBoxHandler getMessageBoxHandler(int boxType) {        if (boxType < 0 || boxType >= messageBoxhandlerArr.length) {            return messageBoxhandlerArr[0];
            }        return messageBoxhandlerArr[boxType];
        }

如此重构之后在代码中调用盒子处理类只需要如下调用

MessageBoxHandlerFactory.getMessageBoxHandler(boxType).getMessageList(accountId, boxType, indexMessageId, limit, filterMsgTypes);

重构之后的优点：

1.所有消息盒子的处理有一个统一的抽象，对外dubbo接口更加通用。

2.dubbo接口实现变得简单，只需要根据盒子类型调用相关Handler的方法即可。

3.可扩展性强，此后再接入特殊处理的消息盒子，只需要增加对应的Handler类，几乎不需要修改新增dubbo接口。

更多网易技术、产品、运营经验分享请访问[网易云社区][Link 1]。

相关文章：  
【推荐】 [Spring Boot 学习系列（02）—使用热部署，提升开发效][Spring Boot _02]

[1d9d6063-feed-4bf8-b084-9eb05a87b3c8]: http://nos.netease.com/knowledge/1d9d6063-feed-4bf8-b084-9eb05a87b3c8
[eceb12c5-ffb4-4585-b932-887003a7867d]: /images/20220405/99f9d6fe88d04c3d9a622ac65cbbdeed.png
[3e70be3a-68bf-45be-b9de-cfaefc9ed412]: /images/20220405/425e4240f5b94a40acbac3b30851f4b5.png
[675f2896-daff-4162-9b80-9d21a34b1027_imageView_thumbnail_980x0]: /images/20220405/5b9fbdc3318c4f49a015fb2559d422a1.png
[Link 1]: https://sq.163yun.com/blog?tag=M_tg_918_72
[Spring Boot _02]: https://blog.csdn.net/wangyiyungw/article/details/83574341