介紹

在 Vue 應(yīng)用的概念中，“組合式函數(shù)”(Composables) 是一個(gè)利用 Vue 的組合式 API 來封裝和復(fù)用有狀態(tài)邏輯的函數(shù)。

• 組合式函數(shù) | Vue.js
• 組合式 API 常見問答 | Vue.js

Composables 函數(shù)就是利用 Vue3 提出的 Composition API ，封裝出的一些可以復(fù)用的組合式函數(shù)，目前 Vue2 也可以使用（2.7 版本可以直接使用，2.6 需要引入另外composition-api的插件）。還沒寫過這種風(fēng)格代碼的同學(xué)，可以先看引用的官方文檔的兩個(gè)鏈接，介紹的比較詳細(xì)。

下面我簡單介紹一下： 組合式 API 的靈感來自Hooks，也是目前流行的函數(shù)式編程的思想，便于邏輯復(fù)用、測試以及類型推導(dǎo)，編寫Vue業(yè)務(wù)代碼的時(shí)候會更加的靈活。但組合式 API 不等于函數(shù)式編程，組合式 API 的特點(diǎn)是基于Vue數(shù)據(jù)響應(yīng)系統(tǒng)的，而函數(shù)式編程通常強(qiáng)調(diào)數(shù)據(jù)不可變的。 組合式API 包括：

• 響應(yīng)式相關(guān)（ref、reactive、computed、watch 等）
• 生命周期鉤子（onMounted 和 onUnmounted 等）
• provide、inject 等

一個(gè)簡單的組合式函數(shù)示例和使用：

import { computed } from 'vue'

export function useAdd(a,b) {
 return computed(() => a.value + b.value)
}

import { ref } from 'vue'
import { useAdd } from './add.js
const a = ref(1)
const b = ref(2)
const c = useAdd(a,b)

最佳實(shí)踐

像寫工具函數(shù)一樣，組合式函數(shù)也要設(shè)計(jì)好函數(shù)的接口，設(shè)計(jì)函數(shù)入?yún)⒌念愋鸵约澳J(rèn)值和返回值是什么樣，以及后期的可擴(kuò)展性。

1. options對象化

編寫組合式函數(shù)時(shí)如果傳入一些配置參數(shù)，可以把配置參數(shù)設(shè)計(jì)為 options 對象，好處就是不需要記住參數(shù)的位置，以及方便后期的擴(kuò)展，可通過 TS 類型提示。如 Lodash 的防抖節(jié)流函數(shù)，配置項(xiàng)也是放在 options 對象里的。 函數(shù)內(nèi)部實(shí)現(xiàn)通過解構(gòu)獲取 options 的配置項(xiàng)，可以賦值默認(rèn)值

export function useTitle(newTitle = null, options = {}) {
  const {
    document = defaultDocument,
    observe = false,
    titleTemplate = '%s',
  } = options
  // ...
}

2. 動態(tài)返回

通過 options 的配置項(xiàng)，可以動態(tài)返回不同的值

export default useNow(options) {
  const { controls = false } = options;

  // ...

  if (!controls) {
    return value;
  } else {
     return { value, controlAction1, controlAction2 };
  }
}

如：useNow vueuse.org/core/useNow…

import { useNow } from '@vueuse/core'

const now = useNow()

// 返回控制暫停/恢復(fù)的函數(shù)
const { now, pause, resume } = useNow({ controls: true })

3. 靈活地使用ref

入?yún)⒃谑褂玫倪^程中可能是普通類型或 ref 類型：

type MaybeRef<T> = Ref<T> | T

如果函數(shù)內(nèi)部期待入?yún)⑹瞧胀愋?，但是使用者可能傳入響?yīng)式的 Ref 類型，可以使用 unref 函數(shù)獲取值，兼容 ref類型：

import { unref } from 'vue'

function useFeature(maybeRef) {
  const value = unref(maybeRef)
  //...
}

unref 的實(shí)現(xiàn)：

function unref <T> (r:Ref<T>|T): T) {
  return isRef(r) ? r.value : r
}

如果函數(shù)內(nèi)部入?yún)⑹?ref 類型的，可以再使用 ref 函數(shù)包裹，該函數(shù)如果傳入一個(gè)ref類型的參數(shù)會原樣返回。

import { ref, watch } from 'vue'
export function useTitle(newTitle) {
  const title = ref(newTitle || document.title)
  watch(title, (t) => {
    if (t != null) document.title = t}, 
        { immediate: true }
  )
  return title
}

4. 異步變同步

通過響應(yīng)式數(shù)據(jù)的連接，不必使用await，在等待異步請求返回后將數(shù)據(jù)進(jìn)行更新。如：

const { res } = useFetch('https://xxx.com/').json()
const data = computed(() => res.value?.data)

import { shallowRef } from 'vue'

export function useFetch<>(url) {
    const data = shallowRef(null)
    const error = shallowRef(null)
    fetch(unref(url)).then(r => r.json())
    .then(r => data.value = r)
    .catch(e => error.value = e)

  return {
        data,
        error
    }
}

5. 簡單的狀態(tài)管理

由于響應(yīng)性系統(tǒng)與組件層是解耦的，簡單的場景下我們可以使用 reactive 創(chuàng)建一個(gè)響應(yīng)式對象，在多個(gè)組件實(shí)例間共享數(shù)據(jù)。

// store.js
import { reactive } from 'vue'

export const store = reactive({
  a: 0,
  b: 1
})

復(fù)雜場景則需要使用 pinia 進(jìn)行狀態(tài)管理

參考資料

• vueuse.org/
• 可組合的 Vue - Anthony Fu
• michaelnthiessen.com/coding-bett…

到此這篇關(guān)于vue composition-api 封裝組合式函數(shù)的操作方法的文章就介紹到這了,更多相關(guān)vue composition-api 內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論