Vue專案資料動態過濾實踐

SHERlocked93發表於2018-09-08
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：歡迎大家關注我的公眾號【前端下午茶】，一起加油吧~

Vue專案資料動態過濾實踐

相關文章