vue3結(jié)合ts從零實(shí)現(xiàn)vueuse的useRouteQuery方法

更新時(shí)間：2024年03月28日 11:29:21 作者：求知若饑

這篇文章主要為大家詳細(xì)介紹了如何使用vue3與ts從零實(shí)現(xiàn)一個(gè)類(lèi)vueuse的useRouteQuery方法,并解決vueuse的useRouteQuery方法存在的一些問(wèn)題,感興趣的可以了解下

使用 vueuse 的 useRouteQuery 碰到的問(wèn)題

問(wèn)：為什么不使用vueuse的提供的useRouteQuery方法？

答：因?yàn)樵谑褂?code><KeepAlive>?；畹捻?yè)面級(jí)組件之間切換時(shí)，在所有組件中使用vueuse的useRouteQuery方法定義的變量都會(huì)更新。

例如：打開(kāi)A頁(yè)面(?；?后，修改page為2，假設(shè)url現(xiàn)在為/pageA?page=2，然后切換到B頁(yè)面，A頁(yè)面將會(huì)觸發(fā)watch且page將會(huì)更新為默認(rèn)值，并且每次修改B頁(yè)面的query都會(huì)觸發(fā)A頁(yè)面的query更新。代碼如下。

import { useRouteQuery } from '@vueuse/router'
import { watch } from 'vue'

// 頁(yè)面A (KeepAlive)
const page = useRouteQuery('page', 1, { transform: Number })
watch(page, (value) => {
    console.log('page A', value)
})

// 頁(yè)面B  (KeepAlive)
const pageSize = useRouteQuery('pagesize', 10, { transform: Number })
watch(pageSize, (value) => {
    console.log('page B', value)
})

查看vueuse的useRouteQuery的源碼后發(fā)現(xiàn)它是根據(jù)router對(duì)象去保存query信息的，因此每次url的query變化時(shí)，所有已存在的相關(guān)變量都會(huì)更新。

從零實(shí)現(xiàn)一個(gè) useRouteQuery

思考：

監(jiān)聽(tīng)route.query的變化，在值變化時(shí)更新響應(yīng)式變量的值；
監(jiān)聽(tīng)響應(yīng)式變量的變化，在值變化時(shí)修改route.query的值；
在route.query變化時(shí)，判斷是否是當(dāng)前頁(yè)面，不是則跳過(guò)更新過(guò)程。

1. 簡(jiǎn)易實(shí)現(xiàn)

import { watch, ref, type Ref } from 'vue'
import { useRoute, useRouter } from 'vue-router'

type IQuery = string | number | string[] | null | undefined

/**
 * 獲取當(dāng)前頁(yè)面的query
 * @param name
 * @param defaultValue
 * @param options
 * @returns
 */
export const useRouteQuery = <T extends IQuery, K extends IQuery = T>(
  name: string,
  defaultValue?: T,
  options: {
    transform?: (value: any) => K
    mode?: 'push' | 'replace'
    isEncodeURIComponent?: boolean
  } = {}
) => {
  const { mode = 'push', transform = (value) => value, isEncodeURIComponent = false } = options

  const route = useRoute()
  const router = useRouter()
  const currentPath = route.path
  const query = ref(defaultValue) as Ref<T | K>

  watch(
  () => route.query[name],
    (value) => {
      // 不是當(dāng)前頁(yè)面時(shí)不更新
      if (route.path !== currentPath) {
        return
      }
      if (value === undefined) {
        query.value = defaultValue as T
        return
      }
      if (!isEncodeURIComponent) {
        query.value = transform(value)
        return
      }
      query.value = transform(decodeURIComponent(value as string))
    },
    { immediate: true })

  watch(query, (value) => {
    const { params, query: oldQuery, hash } = route
    router[mode]({
      params,
      query: {
        ...oldQuery,
        [name]: isEncodeURIComponent ? encodeURIComponent(value as string) : value
      },
      hash
    })
  })

  return query
}

實(shí)際使用過(guò)后，我們會(huì)發(fā)現(xiàn)以上實(shí)現(xiàn)存在一些問(wèn)題：

多個(gè)變量同步修改時(shí)，route.query上只會(huì)保留最后一個(gè)修改的響應(yīng)式變量，代碼如下；

import { useRouteQuery } from '@/hooks/useRouteQuery'

const disabled = useRouteQuery('disabled', 0)
const title = useRouteQuery('title', '')

disabled.value = 1
title.value = 'test'
// 預(yù)想：?disabled=1&title=test
// 實(shí)際：?title=test

特殊值undefined、null經(jīng)過(guò)encodeURIComponent處理后會(huì)轉(zhuǎn)換為字符串格式，因此還會(huì)帶在route.query上，如“?diabled=null&title=undefined”。

2. 完整實(shí)現(xiàn)

解決方案：

通過(guò)在函數(shù)外定義一個(gè)隊(duì)列來(lái)保存所有需要更新的值，并異步更新route.query；
特殊值不使用encodeURIComponent方法轉(zhuǎn)義。

import { nextTick, watch, ref, type Ref } from 'vue'
import { useRoute, useRouter } from 'vue-router'

type IQuery = string | number | string[] | null | undefined
// 用來(lái)保存所有的query
const queriesQueue = new Map<string, Record<string, IQuery>>()
/**
 * 獲取當(dāng)前頁(yè)面的query
 * @param name
 * @param defaultValue
 * @param options
 * @returns
 */
export const useRouteQuery = <T extends IQuery, K extends IQuery = T>(
  name: string,
  defaultValue?: T,
  options: {
    transform?: (value: any) => K
    mode?: 'push' | 'replace'
    isEncodeURIComponent?: boolean
  } = {}
) => {
  const { mode = 'push', transform = (value) => value, isEncodeURIComponent = false } = options

  const route = useRoute()
  const router = useRouter()
  const currentPath = route.path
  const query = ref(defaultValue) as Ref<T | K>

  watch(
    () => route.query[name],
    (value) => {
      if (route.path !== currentPath) {
        return
      }
      if (value === undefined) {
        query.value = defaultValue as T
        return
      }
      if (!isEncodeURIComponent) {
        query.value = transform(value)
        return
      }
      query.value = transform(decodeURIComponent(value as string))
    },
    { immediate: true })

  const setQueryQueue = (value: IQuery) => {
    const currentPageQueries = queriesQueue.get(currentPath) || {}
    // 特殊值不轉(zhuǎn)義
    if (value === null || value === undefined) {
      currentPageQueries[name] = value
    } else {
      currentPageQueries[name] = isEncodeURIComponent ? encodeURIComponent(value as string) : value
    }

    queriesQueue.set(currentPath, currentPageQueries)
  }

  watch(query, (value) => {
    setQueryQueue(value as IQuery)
    // 異步更新
    nextTick(() => {
      // 獲取當(dāng)前頁(yè)面所有的query
      const currentPageQueries = queriesQueue.get(currentPath) || {}
      const { params, query: oldQuery, hash } = route
      router[mode]({
        params,
        query: {
          ...oldQuery,
          ...currentPageQueries
        },
        hash
      })
    })
  })

  return query
}

查看完整實(shí)現(xiàn)源碼。

到此這篇關(guān)于vue3結(jié)合ts從零實(shí)現(xiàn)vueuse的useRouteQuery方法的文章就介紹到這了,更多相關(guān)vue實(shí)現(xiàn)vueuse的useRouteQuery內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: