跟混乱的页面弹窗说再见

喜欢ヅ旅行 2022-01-19 01:21 187阅读 0赞

对于一些快速迭代的产品来说，特别是移动端 `C`端产品，基于用户运营的目的，在 `app`首页给用户展示各种各样的弹窗是很常见的事情，在产品初期，由于迭代版本和运营策略变化地还不是太大，所以可能觉得没什么，但当产品运营到后期，各种八竿子打不着的运营策略轮番上阵，弹窗的样式、逻辑等都变了不知道多少遍的时候，问题就出来了

由于前期没有做好规划，首页的弹窗组件可能放了十多个甚至更多，不仅是首页有，首页内又引入了十多个个子组件，这些子组件内也有，搞不好这些子组件内还有子组件，子组件的子组件同样还有弹窗，每个弹窗都有对应的一组控制显隐逻辑，分散在多个组件多个方法中，但是首页只有一个页面，你不可能让所有符合显示条件的弹窗，全都一下子弹出来，反正我是没见过这么做的 `app`，那么如何管理这些弹窗就成了头等大事

而往往当你意识到这一点的时候，很可能也正是局势发展到无法控制的时候 治不了，等死吧

> 场景：A弹窗和 B弹窗位于主组件内，C弹窗位于主组件的子组件 C中，D弹窗位于主组件的子组件 B中，E弹窗位于主组件的子组件F的子组件G中

> PM：我希望刚进入这个页面的时候，只有当 A弹窗 和 B弹窗以及 C弹窗，都不展示的时候，才展示 D弹窗，如果 D弹窗展示过了，除非 B弹窗之后又展示了一遍，否则无论什么情况下都不展示 E弹窗
> 
> FE：？？？

所以，防患于未然是很重要的 别问我是怎么有这个感悟的

稍加思考一下，其实这件事情并不难办，交给后端通过接口控制所有弹窗的显隐就行了 主要是架构的提前规划，以及低耦合的代码逻辑

## 弹窗的配置化 ##

先确定一个大体思路，首先，必须要明确地知道当前页面共有哪些弹窗组件，包括页面的子组件以及子组件的子组件内的弹窗组件，这是必须的，否则你连有哪些组件都不知道怎么精确控制？

所以，还是上面那句话，提前规划，防患于未然是很重要的，不然等页面迭代了几十版，当初写代码的人都不在了你才想到去统计一下页面上到底有多少个弹窗，那真是够你喝一壶的

那么就需要在一个地方统一把这些弹窗全记录下来，方便管理，于是可以得到下面这种数据结构：

// modalMap.js
    export default {
      // 记录首页 index页面内的弹窗项
      index: {
        modalList: [{
          id: 1,
          condition: 'modal_1',
          level: 100,
          feShow: true
        }, {
          id: 2,
          condition: 'modal_2',
          level: 22,
          feShow: true
        }, {
          id: 3,
          condition: 'modal_3',
          level: 70,
          feShow: false
        }],
        children: {
          child1: {
            modalList: [{
              id: 11,
              condition: 'condition_1_1',
              level: 82,
              feShow: true
            }, {
              id: 12,
              condition: ['condition_1_2', 'condition_1_3', 'condition_1_4'],
              level: 12,
              feShow: true
            }],
            children: {
              child1_1: {
                modalList: [{
                  id: 21,
                  condition: ['condition_1_1_1', 'condition_1_1_2'],
                  level: 320,
                  feShow: true
                }, {
                  id: 22,
                  condition: 'condition_1_1_3',
                  level: 300,
                  feShow: true
                }]
              }
            }
          }
        }
      }
      // ...还可以继续记录其他页面的弹窗结构
    }
    复制代码

`modalMap.js`文件记录每个页面内所有的弹窗项，例如，首页 `index`内的弹窗项都在属性名`index`对应的值数据结构中，`index`这个页面主组件内存在两个 `modal`，它们的 `id`分别为 `1`和 `2`，如果 `index`这个页面主组件的子组件内也有 `modal`，则继续嵌套，例如，`index`主组件的子组件 `child1`中也有 `modal`，那么就把 `child1`放到 `index`的 `children`中继续记录，以此类推

这种结构看起来比较清晰，主组件及主组件内的子组件内的 `modal`都很清晰，一目了然，当然，你可以不用这种结构，完全取决于你，这里就暂时这么定义

每个 `modal`除了 `id`之外，还有 `condition`、`level` 和 `show`属性

`condition`是作为一种标识存在，后面会说到，`level` 用于标识当前 `modal`的层级，每个页面正常只能同时展示一个 `modal`，但如果有多个 `modal`都同一时间都满足展示的条件，则对比它们的 `level`值，哪个大就优先展示哪个，其余的忽略掉，杜绝一个页面可能提示展示多个弹窗的情况；

`feShow`属性则是在 `modal`内部来决定 `modal`最终是否展示，这样一来就可以无视外界条件，很轻松地在前端通过配置来禁止掉弹窗的显示

## 通过发布/订阅模式来管理弹窗 ##

弹窗的配置结构已经确定了，下一步就是对这些配置的管理了

一般情况下，多个页面同时满足条件需要进行展示的场景，大多数都是发生在刚进入页面，页面发出多个请求，这些请求的返回结果分别控制对应的一个弹窗的展示

因为发出去的这些请求很可能分属于不同的业务线或部门管辖，相互独立，所以说如果把弹窗的控制权交给后端来做，其实是有点困难的，再加上请求是异步的，前端想要用意大利面条式代码来保证弹窗之间的互斥性也不太容易，综合起来，也就导致了当页面上迭代出了数十个以上弹窗的时候，如果没有提前规划好，还是很容易出现弹窗同时展示的问题的

这里暂时就以刚进入页面的情况为例，进行逻辑梳理

首先，我需要知道页面上有哪些弹窗可能会在刚进入页面的时候弹出来（即通过接口控制单个弹窗的展现与否），然后在所有弹窗的数据都拿到了的时候（即跟弹窗相关的接口都已经返回数据），才进行弹窗的展示

这种情况比较适合使用发布/订阅者模式，单个接口的数据返回就是一个订阅，当所有接口都订阅之后，就进行发布，也就是弹窗展示

// modalManage.js
    class ModalManage {
      constructor () {
        // ...
      }
      add () {
        // ...
        this.nodify()
      }
      notify () {
        // ...
      }
    }
    复制代码

通过 `ModalManage`类来管理弹窗，在 `new ModalManage`的时候传入一个标识值，用于预先告知接下来一共将会进行 `n` 次订阅，`add`就是订阅方法，当接口返回弹窗是否展示信息的时候，就调用 `add`方法订阅一次，并且紧接着在 `add`方法里调用 `notify`，这个方法就是发布方法

`notify`方法中将检查当前订阅的次数是否已经达到了 `n`次，如果是，就说明订阅完毕，所有弹窗的信息都已经接收完毕，下一步就可以根据这些收集起来的弹窗信息，根据一定的逻辑进行展示，例如只展示 `level`值最大的那个弹窗

根据以上思路，`ModalManage`类的 `constructor`方法中需要设置的初始值差不多也就知道了

constructor (modalList) {
      this.modalFlatMap = {}
      this.modalList = modalList
    }
    复制代码

`modalFlatMap`用于缓存所有已经订阅的弹窗的信息

`conditionList` 是 `ModalManage` 类在初始化时接收一个的参数，这个参数其实就是刚进入页面时，页面上所有可能展示的弹窗(包括子组件的弹窗)的 `id`集合，也就是必须要知道页面上到底有多少个可能同时展示的弹窗，以上述示例代码 `modalMap.js`为例， `index`页面的 `modalList`值就是 `['1', '2', '3', '11', '12', '21', '22']`

这里其实直接传弹窗数量就行了，`index`中有 `7`个弹窗可能同时展示，所以可以直接传 `7`，我这里之所以要传名称进去，实际上是为了方便调试，如果代码出问题了，比如页面上实际有 `5`个接口可以控制 `5`个弹窗的展示，但你却只订阅了 `4`次，如果只传数字，你就需要一个个找过去看是哪一个忘记订阅了，但如果传名称，你一下子就能调试出来，也就是代码的可维护性会好一点

到这里其实有个问题

如果一个弹窗都是只由一个异步接口控制，那么上述没什么问题，但是如果某个弹窗的展示，需要根据多个异步接口的返回值来控制，那么就有问题了，特定弹窗的 `id`只有一个，但因为由多个接口控制，那么根据上述逻辑，就可能存在对同一个 `id`进行重复订阅的操作，所以这里需要改一下

constructor (conditionList) {
      this.modalFlatMap = {}
      this.conditionList = conditionList
      this.hasAddConditionList = []
    }
    复制代码

`id`只作为一个标识符，使用 `condition`来控制订阅，如果一个弹窗通过一个异步条件控制，则 `condition`的值就是一个字符串(这个字符串只是起到一个标识作用)，如果由 `n`(`n>=1`)个异步条件控制，则值为一个数组，数组的长度就是 `n` `conditionList`就是页面上所有 `condition`的集合，`hasAddConditionList`用于缓存当前已经进行订阅操作的 `condition`

当页面上任意一个弹窗的状态（即是否满足展示的条件）确定下来后，就进行订阅操作：

// modalManage.js
    add (condition, infoObj) {
      if (!this.conditionList.includes(condition)) return console.log('无效订阅:', condition)
      if (this.hasAddConditionList.includes(condition)) return console.log('重复订阅:', condition)
      this.hasAddConditionList.push(condition)
      const modalItem = getModalItemByCondition(condition, modalMap)
      const existMap = this.modalFlatMap[modalItem.id]
      if (existMap) {
        // 说明当前弹窗由多个逻辑字段控制
        const handler = existMap.handler
        existMap.rdShow = existMap.rdShow && infoObj.rdShow
        existMap.handler = () => {
          handler && handler()
          infoObj.handler && infoObj.handler()
        }
      } else {
        this.modalFlatMap[modalItem.id] = {
          level: modalItem.level,
          feShow: modalItem.feShow,
          rdShow: infoObj.rdShow,
          handler: infoObj.handler
        }
      }
      this.notify()
    }
    复制代码

`this.modalFlatMap`的属性名就是弹窗的 `id`，每个属性的值都是一个包含 `4`个属性的对象，`level` 和 `feShow`就是上面 `modalMap.js`中的 `level`、`feShow`，`rdShow`是从异步接口或其他逻辑返回的用于控制弹窗是否展示的值，`handler`则是用于当选择出了需要展示的弹窗时，该执行的函数

如果对于同一个 `id`，有多个`condition`进行订阅，则将这些订阅的弹窗信息进行合并

`this.hasAddConditionList`记录了订阅列表的信息，当订阅列表的长度和 `thisconditionList`长度相同时，说明所有的弹窗状态都已经准备就绪，可以根据这些弹窗的优先级进行展示了，也就是 `notify`方法要做的事情

`notify`方法中，先排除掉属性 `feShow && rdShow`为 `false`的弹窗项，再对比剩下的弹窗的 `level`，只展示 `level`最大的那个弹窗：

// modalManage.js
    notify () {
      if (this.hasAddConditionList.length === this.conditionList.length) {
        const highLevelModal = Object.values(this.modalFlatMap).filter(item => item.rdShow && item.feShow).reduce((t, c) => {
          return c.level > t.level ? c : t
        }, { level: -1 })
        highLevelModal.handler && highLevelModal.handler()
      }
    }
    复制代码

## 使用单例模式管理嵌套组件以及多个页面的弹窗 ##

上述的 `ModalManage`类已经足以管理弹窗了，但还有个问题，如果一个页面上的弹窗，分散位于页面主组件及其子组件，甚至是子组件的子组件内，怎么办？

这个时候就需要使用单例了

// 单例管理
    const manageTypeMap = {}
    // 获取单例
    function createModalManage (type) {
      if (!manageTypeMap[type]) {
        manageTypeMap[type] = new ModalManage(getAllConditionList(modalMap[type]))
      }
      return manageTypeMap[type]
    }
    复制代码

通过 `createModalManage`这个方法来创建 `ModalManage`实例，根据传入的 `type`来决定是否创建新的实例，如果单例管理对象 `manageTypeMap`中不存在 `type`对于的实例，则 `new`一个 `ModalManage`实例，存入 `manageTypeMap`中，并返回这个新实例，否则就返回 `manageTypeMap`中已经创建好了的实例

这样一来，无论弹窗分散在多少个组件内，无论这些组件嵌套得有多深，都能够在保证代码低耦合的前提下，顺利地订阅/发布事件

这里的 `getAllConditionList`方法是个工具方法，用于从 `modalMap`中获取页面对应的弹窗数据结构：

const getAllConditionList = modalInfo => {
      let currentList = []
      if (modalInfo.modalList) {
        currentList = currentList.concat(
          modalInfo.modalList.reduce((t, c) => t.concat(c.condition), [])
        )
      }
      if (modalInfo.children) {
        currentList = currentList.concat(
          Object.values(modalInfo.children).reduce((t, c) => {
            return t.concat(getAllConditionList(c))
          }, [])
        )
      }
      return currentList
    }
    复制代码

至于 `createModalManage`的参数`type`，其值可以就是一个字符串，例如如果需要管理首页 `index`上可能同时展示的所有的弹窗，则可以将 `type` 的值指定为 `index`，在 `index`主组件以及其包含弹窗的子组件内，都通过这个字段来获取 `ModalManage`单例对象：

const modalManage = createModalManage('index')
    复制代码

这样做同时也解决了另外一个问题，就是多个页面的弹窗管理问题，`index`页面通过 `index`创建 `ModalManage`单例，详情页就可以通过 `detail`来创建 `ModalManage`单例，双方互不干扰

## 总结 ##

> **上述所有示例代码已经上传到 [github][]，有兴趣地可以看下**

本文只是对弹窗这么一种具体的案例进行分析，实际上应用于其他场景，例如页面同一个位置的悬浮挂件管理等都是可行的

无论是弹窗的管理还是挂件的管理，放在 `mvvm`框架中，都是数据的管理，主流前端框架对于复杂的数据管理，都已经有对应的解决方案，例如 `vuex` 和 `redux`等，这些解决方案当然也能够解决上面的问题

本文主要是对这种理念的探讨，探讨出一种通用的解决方案，无论你用的是 `vue`、`react`、`angular`还是`jquery`一把梭，亦或是微信小程序、支付宝小程序、快应用等，都可以在不依赖其他库的前提下，低成本地轻松套入使用

转载于:https://juejin.im/post/5caaa9f2f265da24ba188f10

[github]: https://link.juejin.im?target=https%3A%2F%2Fgithub.com%2Faccforgit%2Fblog-data%2Ftree%2Fmaster%2F%25E8%25B7%259F%25E6%25B7%25B7%25E4%25B9%25B1%25E7%259A%2584%25E9%25A1%25B5%25E9%259D%25A2%25E5%25BC%25B9%25E7%25AA%2597%25E8%25AF%25B4%25E5%2586%258D%25E8%25A7%2581