Vue项目数据动态过滤实践

这个问题是在下在作一个Vue项目中遇到的实际场景，这里记录一下我遇到问题以后的思考和最后怎么解决的(老年程序员记性很差 -。-)，过程当中会涉及到一些Vue源码的概念好比 $mount、render watcher 等，若是不太了解的话能够瞅瞅 Vue源码阅读系列文章 ~

问题是这样的：页面从后台拿到的数据是由 0、1 之类的key，而这个key表明的value好比 0-女、1-男 的对应关系是要从另一个数据字典接口拿到的；相似于这样的Api：

{
  "SEX_TYPE": [
    { "paramValue": 0, "paramDesc": "女" },
    { "paramValue": 1, "paramDesc": "男" }
  ]
}
复制代码

那么若是view拿到的是 0，就要从字典中找到它的描述女而且显示出来；下面故事开始了～

1. 思考

有人说，这不是过滤器 filter 要作的事么，直接 Vue.filter 不就好了，然而问题是这个filter是要等待异步的数据字典接口返回以后才能拿到，若是在 $mount 的时候这个filter没有找到，那么就会致使错误影响以后的渲染(白屏并报undefined错)；

我想到的解决方法有两个：

1. 把接口变为同步，在 beforeCreate 或 created 钩子中同步地获取数据字典接口，保证在 $mount 的时候能够拿到注册好的filter，保证时序，可是这样会阻塞挂载，延长白屏时间，所以不推介；
2. 把filter的注册变为异步，在获取filter以后通知 render watcher 更新本身，这样能够利用vue本身的响应式化更新视图，不会阻塞渲染，所以在下初步采用了这个方法。

2. 实现

由于filter属于 asset_types ，关于在Vue实例中asset_types的访问链有如下几个结论；具体代码实践能够参考： Codepen - filter test

1. asset_types 包括 filters、components、directives，如下全部的 asset_types 都自行替换成前面几项
2. 子组件中的 asset_types 访问不到父组件中的 asset_types，可是能够访问到全局注册的挂载在 $root.$options.asset_types.__proto__ 上的 asset_types，这里对应源码 src/core/util/options.js
3. 全局注册方法Vue.asset_types，好比Vue.filters注册的asset_types会挂载到根实例(其余实例的 $root)的 $options.asset_types.__proto__ 上，并被之后全部建立的Vue实例继承，也就是说，之后全部建立的Vue实例均可以访问到
4. 组件的slot的做用域仅限于它被定义的地方，也就是它被定义的组件中，访问不到父组件的 asset_types，可是能够访问到全局定义的 asset_types
5. 同理，由于main.js中的 new Vue() 实例是根实例，它中注册的 asset_types 会被挂载在 $root.$options.asset_types 上而不是 $root.$options.asset_types.__proto__ 上

根据以上几个结论，能够着手coding了~

2.1 使用根组件的filters

所以首先我考虑的是把要注册的filter挂载到根组件上，这样其余组件经过访问 $root 能够拿到注册的 filter，这里的实现：

<template>
  <div>
    {{ rootFilters( sexVal )}}
  </div>
</template>
 
<script type='text/javascript'> import Vue from 'vue' import { registerFilters } from 'utils/filters' export default { data() { return { sexVal: 1 // 性别 } }, methods: { /* 根组件上的过滤器 */ rootFilters(val, id = 'SEX_TYPE') { const mth = this.$root.$options.filters[id] return mth && mth(val) || val } }, created() { // 把根组件中的filters响应式化 Vue.util.defineReactive(this.$root.$options, 'filters', this.$root.$options.filters) }, mounted() { registerFilters.call(this) .then(data => // 这里获取到数据字典的data ) } } </script>
复制代码

注册 filter 的 js

// utils/filters
 
import * as Api from 'api'
 
/** * 获取并注册过滤器 * 注册在$root.$options.filters上不是$root.$options.filters.__proto__上 * 注意这里的this是vue实例，须要用call或apply调用 * @returns {Promise} */
export function registerFilters() {
  return Api.sysParams()            // 获取数据字典的Api，返回的是promise
    .then(({ data }) => {
      Object.keys(data).forEach(T =>
        this.$set(this.$root.$options.filters, T, val => {
          const tar = data[T].find(item => item['paramValue'] === val)
          return tar['paramDesc'] || ''
        })
      )
      return data
    })
    .catch(err => console.error(err, ' in utils/filters.js'))
}
复制代码

这样把根组件上的 filters 变为响应式化的，而且在渲染的时候由于在 rootFilters 方法中访问了已经在 created 中被响应式化的 $root.$options.filters，因此当异步获取的数据被赋给 $root.$options.filters 的时候，会触发这个组件render watcher的从新渲染，这时候再获取 rootFilters 方法的时候就能取到filter了；

那这里为何不用 Vue.filter 方法直接注册呢，由于 Object.defineProperty 不能监听 __proto__ 上数据的变更，而全局 Vue.filter 是将过滤器注册在了根组件 $root.$options.asset_types.__proto__ 上，所以其变更不能被响应。

这里的代码能够进一步完善，可是这个方法存在必定的问题，首先这里使用了Vue.util上不稳定的方法，另外在使用中处处可见this.$root.$options这样访问vue实例内部属性的状况，不太文明，读起来也让人困惑。

所以在这个项目作完等待测试的时候我思考了一下，谁说过滤器就必定放在filters里面 -。-，也可使用mixin来实现嘛

2.2 使用 mixin

使用mixin要注意一点，由于vue中把data里全部以 _、$ 开头的变量都做为内部保留的变量，并不代理到当前实例上，所以直接 this._xx 是没法访问的，须要经过 this.$data._xx 来访问。

// mixins/sysParamsMixin.js

import * as Api from 'api'

export default {
  data() {
    return {
      _filterFunc: null,       // 过滤器函数
      _sysParams: null,        // 获取数据字典
      _sysParamsPromise: null  // 获取sysParams以后返回的Promise
    }
  },
  methods: {
    /* 注册过滤器到_filterFunc中 */
    _getSysParamsFunc() {
      const { $data } = this
      return $data._sysParamsPromise || ($data._sysParamsPromise = Api.sysParams()
        .then(({ data }) => {
          this.$data._sysParams = data
          this.$data._filterFunc = {}
          Object.keys(data).forEach(paramKey =>
            this.$data._filterFunc[paramKey] = val => {
              const tar = data[paramKey].find(item => item['paramValue'] === val)
              return tar && tar['paramDesc'] || ''
            })
          return data
        })
        .catch(err => console.error(err, ' in src/mixins/sysParamsMixin.js')))
    },

    /* 按照键值获取单个过滤器 */
    _rootFilters(val, id = 'SEX_TYPE') {
      const func = this.$data._filterFunc
      const mth = func && func[id]
      return mth && mth(val) || val
    },

    /* 获取数据字典 */
    _getSysParams() {
      return this.$data._sysParams
    }
  }
}
复制代码

这里把 Api 的 promise 保存下来，若是其余地方还用到的话直接返回已是 resolved 状态的 promise，就不用再次去请求数据了。另外为了在其余实例中也能够方便的访问，这里挂载在根组件上。

那在咱们的根组件中怎么使用呢：

// src/main.js

import sysParamsMixin from 'mixins/sysParamsMixin'

new Vue({
  el: '#app',
  mixins: [sysParamsMixin],
  render: h => h(App),
})
复制代码

在须要用过滤器的组件中：

<template>
  <div>
    {{ $root._rootFilters( sexVal )}}
  </div>
</template>
 
<script type='text/javascript'> export default { data() { return { sexVal: 1 } }, mounted() { this.$root._getSysParamsFunc() .then(data => // 这里获取到数据字典的data ) } } </script>
复制代码

这里不只注册了过滤器，并且也暴露了数据字典，以方便某些地方的列表显示，毕竟这是实际项目中常见的场景。

固然若是使用 vuex 更好，不过这里的场景我的以为不必用 vuex，若是还有更好的方法能够讨论一下下啊~

---

网上的帖子大多深浅不一，甚至有些先后矛盾，在下的文章都是学习过程当中的总结，若是发现错误，欢迎留言指出~

参考：

1. Vue.js 2.5.17 源码
2. Vue源码阅读系列
3. Vue 2.5.17 filter test

PS：欢迎你们关注个人公众号【前端下午茶】，一块儿加油吧~

另外能够加入「前端下午茶交流群」微信群，长按识别下面二维码便可加我好友，备注加群，我拉你入群～