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：歡迎你們關注個人公衆號【前端下午茶】，一塊兒加油吧~

另外能夠加入「前端下午茶交流羣」微信羣，長按識別下面二維碼便可加我好友，備註加羣，我拉你入羣～