前言

在有列表頁(yè)的系統(tǒng)中，常常為了提高用戶體驗(yàn)，需要保持列表頁(yè)的篩選條件、分頁(yè)情況。需要做到刷新頁(yè)面，從詳情頁(yè)返回列表頁(yè)保留之前的篩選情況。你可能會(huì)說(shuō) vue 用 keep-alive 緩存列表頁(yè)不就行了？為什么不好呢？

因?yàn)檎_的做法是將篩選條件保存在 url 上，這樣可以復(fù)制給別人直接使用，并且你可以看到幾乎所有網(wǎng)站都是使用這種方法。接下來(lái)會(huì)帶大家了解有關(guān) url 參數(shù)的基礎(chǔ)知識(shí)和設(shè)計(jì)思路。并且封裝成了一個(gè) hook vue-use-sync-url，歡迎在你的項(xiàng)目中直接使用。

基礎(chǔ)知識(shí)

假設(shè) url 上的參數(shù)為 ?a=1&a=2&b=true，來(lái)看看獲取參數(shù)的方法

const searchParams = new URLSearchParams(window.location.search);
// ["1", "2"]
searchParams.getAll("a");
// "1"
searchParams.get(a);
// ["true"]
searchParams.getAll(b);
// "true"
searchParams.get(b);

添加

searchParams.append("a", "1");
searchParams.append("a", "2");
// ?a=1&a=2
searchParams.set("b", "3");
searchParams.set("b", "4");
// ?b=4

從上面的結(jié)果可以得知，無(wú)論什么值最后都會(huì)被解析成 string 類型， 如果存在兩個(gè)名字相同的 key，則會(huì)被解析為 string[]。 所以從 url 參數(shù)獲取到的類型只會(huì)為 string ｜ string[]。

最后使用 history.pushState 來(lái)修改瀏覽器地址欄的 url 參數(shù)。與 history.replaceState 不同的是，一個(gè)是添加一條新記錄，一個(gè)是替換。在這里我們當(dāng)然是選擇添加新記錄了。

設(shè)計(jì)思路

首先肯定要知道哪些值需要同步到 url 參數(shù)上，所以我們定義了一個(gè) configs 參數(shù)，來(lái)配置需要同步的值。類型為數(shù)組，這樣可以讓用戶自定義順序，每項(xiàng)需要傳入一個(gè) key 值。

hook 內(nèi)部返回一個(gè) syncToUrl 方法，傳入包含配置的所有 key 的值。用戶可以在自己需要的時(shí)候同步 url。

const { syncToUrl } = useSyncUrl({
  configs: [{ key: "title" }, { key: "status" }]
})
// 同步
syncToUrl(values)

假設(shè) title 與輸入框綁定，且沒(méi)有值，傳入 syncToUrl 的是 ""，這就沒(méi)有必要同步到 url 上了。所以我們添加一個(gè)配置 omitEmptyString，如果值為空字符串，則忽略。

[{ key: "title", omitEmptyString: true }]

同理，可以增加 omitNull、omitUndefined。這三個(gè)默認(rèn)都設(shè)為 true。

接下來(lái)，我們先明白兩個(gè)概念。在頁(yè)面第一次加載、執(zhí)行瀏覽器前進(jìn)回退操作時(shí)，需要將 url 參數(shù)的值轉(zhuǎn)換到當(dāng)前頁(yè)面的組件中，在這里我們稱其為 decode。

在頁(yè)面中篩選結(jié)束點(diǎn)擊提交或切換頁(yè)碼時(shí)，需要將這些值轉(zhuǎn)換成參數(shù)并設(shè)置到 url 的參數(shù)上，在這里我們稱其為 encode。

decode

了解后，我們就可以知道上面例子中 key: "status"，可以想成是一個(gè) Select 組件，值為 boolean 類型。從基礎(chǔ)知識(shí)可以得知，從 url 取下來(lái)的值為 string 類型。 需要使用 decode 轉(zhuǎn)換成 boolean 類型。

const values = reactive({ title: "", status: false });
const booleanValues = {
  true: true,
  false: false,
}
const { syncToUrl } = useSyncUrl({
  configs: [
    {
      // title 的值是字符串類型，所以不需要 decode
      key: "title",
    },
    { 
      key: "status", 
      // 參數(shù)是從 url 上 key 為 status 的值
      decode: (value) => booleanValues[value] 
    }
  ],
  onDecode: (params) => {
    Object.keys(params).forEach(key => {
        values[key] = params[key]
    });
    // 設(shè)置完成后，在這里請(qǐng)求數(shù)據(jù)
  }
})

在 decode 中，我們將值 return 出去，在 onDecode 中將每個(gè)配置項(xiàng)返回的值統(tǒng)一收集起來(lái)，設(shè)置完成后，請(qǐng)求列表數(shù)據(jù)。像 title 這種值本身是字符串的就不用寫 decode。假設(shè) url 上的參數(shù)為 ?title=11&status=true，這里的 params 的值就為

{
  title: "11",
  status: true
}

decode 也可以返回一個(gè)對(duì)象，如果是對(duì)象也會(huì)被收集到 onDecode 中。如果不想被收集，可以返回空對(duì)象 {}。所以如果你想在 decode 中進(jìn)行賦值也可以，但要返回 {}。

decode: (value) => {
  return {
    a: "1",
    b: "2"
  }
}
// 不會(huì)被收集
decode: (value) => {
  return {};
}

encode

const values = reactive({ rangeDate: ["2022-10-1", "2022-10-2"] });
useSyncUrl({
  configs: [
   {
     key: "rangeDate",
     encode: (value) => {
       return {
         starDate: value[0],
         endDate: value[1]
       }
     }
   }
  ]
})

encode 可以將值轉(zhuǎn)換成你想要的格式同步到 url 上。這個(gè)例子中如果不寫 encode，通過(guò)了解上面的基礎(chǔ)知識(shí)，則會(huì)被轉(zhuǎn)換成兩個(gè) rangeDate 的鍵值對(duì)。這里自定義轉(zhuǎn)換成了 starDate 和 endDate。所以還要配合 decode 使用。

decode: (value) => ...

但是這個(gè) value 返回的是 url 上 key 為 "rangeDate" 的值，我們要怎么 decode starDate 和 endDate 呢？所以增加一個(gè)配置項(xiàng) decodeKeys 來(lái)實(shí)現(xiàn)。。

{
 key: "rangeDate",
 decodeKeys: ["starDate", "endDate"],
 decode: value => {
   return {
     rangeDate: [value.starDate, value.endDate]
   }
 }
}

通過(guò)上面基礎(chǔ)知識(shí)可以得知，url 的值只能為 string | string[]，所以 encode 返回的值也只能是 EncodeResult | Record<string, EncodeResult>。內(nèi)部將 number 和 boolean 轉(zhuǎn)換成了 string。

type EncodeResult = string | number | boolean | (string | number | boolean)[];

這時(shí)候就有問(wèn)題了，我想將一個(gè)比較復(fù)雜類型的值同步到 url 上怎么辦？這時(shí)候就要用到 encodeURIComponent 和 decodeURIComponent 了，如果你不認(rèn)識(shí)，可以上 MDN 學(xué)習(xí)。這里判定數(shù)據(jù)一定為正確的，實(shí)際使用中在 decode 這步中 JSON.parse 可能會(huì)報(bào)錯(cuò)，你需要自行處理一下，因?yàn)?url 可能會(huì)被人為修改。

const values = reactive({
  obj: { a: { b: { c: true } } },
});
const { syncToUrl } = useSyncUrl({
  configs: [
    {
      key: "obj",
      encode: (value) => encodeURIComponent(JSON.stringify(value)),
      decode: (value) => JSON.parse(decodeURIComponent(value)),
    },
  ],
});

詳情頁(yè)返回列表頁(yè)

假如你的詳情頁(yè)有一個(gè)按鈕點(diǎn)擊返回列表頁(yè)，要怎么保留上次的篩選條件呢？因?yàn)?vue-router 的 push 操作，不能直接傳 url 參數(shù)的字符串，只能傳對(duì)象，所以返回一個(gè)參數(shù)對(duì)象。

localStorage.setItem("listSearch", window.location.search);
// 在詳情頁(yè)
router.push(`/list${localStorage.getItem("listSearch")}`)
或
const { searchParams } = useSyncUrl(...)
localStorage.setItem("listSearch", JSON.stringify(searchParams))
// 在詳情頁(yè)
router.push({ path: "/list", query: JSON.parse(localStorage.getItem("listSearch")) })

結(jié)語(yǔ)

源碼放在 github 了，readme 中還有測(cè)試地址，可以來(lái)試一試。

以上就是vue實(shí)現(xiàn)前端保持篩選條件到url并進(jìn)行同步參數(shù)設(shè)計(jì)的詳細(xì)內(nèi)容，更多關(guān)于vue篩選條件url同步參數(shù)設(shè)計(jì)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論