QQ小程序 自定義組件擴展

為了更好定制自定義組件的功能，可以使用自定義組件擴展機制。

擴展后的效果

// behavior.js
module.exports = Behavior({
  definitionFilter(defFields) {
    defFields.data.from = 'behavior'
  },
})


// component.js
Component({
  data: {
    from: 'component'
  },
  behaviors: [require('behavior.js')],
  ready() {
    console.log(this.data.from) // 此處會發(fā)現(xiàn)輸出 behavior 而不是 component
  }
})

通過例子可以發(fā)現(xiàn)，自定義組件的擴展其實就是提供了修改自定義組件定義段的能力，上述例子就是修改了自定義組件中的data 定義段里的內(nèi)容。

使用擴展

Behavior() 構造器提供了新的定義段 definitionFilter ，用于支持自定義組件擴展。 definitionFilter 是一個函數(shù)，在被調(diào)用時會注入兩個參數(shù)，第一個參數(shù)是使用該 behavior 的 component/behavior 的定義對象，第二個參數(shù)是該 behavior 所使用的 behavior 的 definitionFilter 函數(shù)列表。 以下舉個例子來說明：

// behavior3.js
module.exports = Behavior({
  definitionFilter(defFields, definitionFilterArr) {},
})


// behavior2.js
module.exports = Behavior({
  behaviors: [require('behavior3.js')],
  definitionFilter(defFields, definitionFilterArr) {
    // definitionFilterArr[0](defFields)
  },
})


// behavior1.js
module.exports = Behavior({
  behaviors: [require('behavior2.js')],
  definitionFilter(defFields, definitionFilterArr) {},
})


// component.js
Component({
  behaviors: [require('behavior1.js')],
})

上述代碼中聲明了1個自定義組件和3個 behavior，每個 behavior 都使用了 definitionFilter 定義段。那么按照聲明的順序會有如下事情發(fā)生：

1. 當進行 behavior2 的聲明時就會調(diào)用 behavior3 的 definitionFilter 函數(shù)，其中 defFields 參數(shù)是 behavior2 的定義段， definitionFilterArr 參數(shù)即為空數(shù)組，因為 behavior3 沒有使用其他的 behavior 。
2. 當進行 behavior1 的聲明時就會調(diào)用 behavior2 的 definitionFilter 函數(shù)，其中 defFields 參數(shù)是 behavior1 的定義段， definitionFilterArr 參數(shù)是一個長度為1的數(shù)組，definitionFilterArr[0] 即為 behavior3 的 definitionFilter 函數(shù)，因為 behavior2 使用了 behavior3。用戶在此處可以自行決定在進行 behavior1 的聲明時要不要調(diào)用 behavior3 的 definitionFilter 函數(shù)，如果需要調(diào)用，在此處補充代碼 definitionFilterArr0 即可，definitionFilterArr 參數(shù)會由基礎庫補充傳入。
3. 同理，在進行 component 的聲明時就會調(diào)用 behavior1 的 definitionFilter 函數(shù)。
4. 簡單概括，definitionFilter 函數(shù)可以理解為當 A 使用了 B 時，A 聲明就會調(diào)用 B 的 definitionFilter 函數(shù)并傳入 A 的定義對象讓 B 去過濾。此時如果 B 還使用了 C 和 D ，那么 B 可以自行決定要不要調(diào)用 C 和 D 的 definitionFilter 函數(shù)去過濾 A 的定義對象。

真實案例

下面利用擴展簡單實現(xiàn)自定義組件的計算屬性功能:

// behavior.js
module.exports = Behavior({
  lifetimes: {
    created() {
      this._originalSetData = this.setData // 原始 setData
      this.setData = this._setData // 封裝后的 setData
    }
  },
  definitionFilter(defFields) {
    const computed = defFields.computed || {}
    const computedKeys = Object.keys(computed)
    const computedCache = {}


    // 計算 computed
    const calcComputed = (scope, insertToData) => {
      const needUpdate = {}
      const data = defFields.data = defFields.data || {}


      for (const key of computedKeys) {
        const value = computed[key].call(scope) // 計算新值
        if (computedCache[key] !== value) needUpdate[key] = computedCache[key] = value
        if (insertToData) data[key] = needUpdate[key] // 直接插入到 data 中，初始化時才需要的操作
      }


      return needUpdate
    }


    // 重寫 setData 方法
    defFields.methods = defFields.methods || {}
    defFields.methods._setData = function (data, callback) {
      const originalSetData = this._originalSetData // 原始 setData
      originalSetData.call(this, data, callback) // 做 data 的 setData
      const needUpdate = calcComputed(this) // 計算 computed
      originalSetData.call(this, needUpdate) // 做 computed 的 setData
    }


    // 初始化 computed
    calcComputed(defFields, true) // 計算 computed
  }
})

在組件中使用：

const beh = require('./behavior.js')
Component({
  behaviors: [beh],
  data: {
    a: 0,
  },
  computed: {
    b() {
      return this.data.a + 100
    },
  },
  methods: {
    onTap() {
      this.setData({
        a: ++this.data.a,
      })
    }
  }
})

<view>data: {{a}}</view>
<view>computed: {}</view>
<button bindtap="onTap">click</button>

實現(xiàn)原理很簡單，對已有的 setData 進行二次封裝，在每次 setData 的時候計算出 computed 里各字段的值，然后設到 data 中，已達到計算屬性的效果。

此實現(xiàn)只是作為一個簡單案例來展示，請勿直接在生產(chǎn)環(huán)境中使用。