技術文章 » Vue3這樣寫列表頁，讓效能更好更高效！

Vue3這樣寫列表頁，讓效能更好更高效！

2022-12-23 22:00:53
在開發管理後臺過程中，一定會遇到不少了增刪改查頁面，而這些頁面的邏輯大多都是相同的，這樣子會導致程式碼耦合度越來越高，下面，我們將這些可複用的資料抽離出來成hook，既解決耦合度的問題又提高工作效率。

在開發管理後臺過程中，一定會遇到不少了增刪改查頁面，而這些頁面的邏輯大多都是相同的，如獲取列表資料，分頁，篩選功能這些基本功能。而不同的是呈現出來的資料項。還有一些操作按鈕。【相關推薦：、】

20221203192923

對於剛開始只有 1，2 個頁面的時候大多數開發者可能會直接將之前的頁面程式碼再拷貝多一份出來，而隨著專案的推進類似頁面數量可能會越來越多，這直接導致專案程式碼耦合度越來越高。

這也是為什麼在專案中一些可複用的函數或元件要抽離出來的主要原因之一

下面，我們封裝一個通用的useList，適配大多數增刪改查的列表頁面，讓你更快更高效的完成任務，準點下班 ~

20221203195440

前置知識

  • Vue

封裝

我們需要將一些通用的引數和函數抽離出來，封裝成一個通用hook，後續在其他頁面複用相同功能更加簡單方便。

定義列表頁面必不可少的分頁資料

export default function useList() {
  // 載入態
  const loading = ref(false);
  // 當前頁
  const curPage = ref(1);
  // 總數量
  const total = ref(0);
  // 分頁大小
  const pageSize = ref(10);
}
登入後複製

如何獲取列表資料

思考一番，讓useList函數接收一個listRequestFn引數，用於請求列表中的資料。

定義一個list變數，用於存放網路請求回來的資料內容，由於在內部無法直接確定列表資料型別，通過泛型的方式讓外部提供列表資料型別。

export default function useList<ItemType extends Object>(
  listRequestFn: Function
) {
  // 忽略其他程式碼
  const list = ref<ItemType[]>([]);
}
登入後複製

在useList中建立一個loadData函數，用於呼叫獲取資料函數，該函數接收一個引數用於獲取指定頁數的資料（可選，預設為curPage的值）。

  • 執行流程
  1. 設定載入狀態
  2. 呼叫外部傳入的函數，將獲取到的資料賦值到list和total中
  3. 關閉載入態

這裡使用了 async/await 語法，假設請求出錯、解構出錯情況會走 catch 程式碼塊，再關閉載入態

這裡需要注意，傳入的 listRequestFn 函數接收的引數數量和型別是否正常對應上 請根據實際情況進行調整

export default function useList<ItemType extends Object>(
  listRequestFn: Function
) {
  // 忽略其他程式碼
  // 資料
  const list = ref<ItemType[]>([]);
  // 過濾資料
  // 獲取列表資料
  const loadData = async (page = curPage.value) => {
    // 設定載入中
    loading.value = true;
    try {
      const {
        data,
        meta: { total: count },
      } = await listRequestFn(pageSize.value, page);
      list.value = data;
      total.value = count;
    } catch (error) {
      console.log("請求出錯了", "error");
    } finally {
      // 關閉載入中
      loading.value = false;
    }
  };
}
登入後複製

別忘了，還有切換分頁要處理

使用 watch 函數監聽資料，當curPage，pageSize的值發生改變時呼叫loadData函數獲取新的資料。

export default function useList<ItemType extends Object>(
  listRequestFn: Function
) {
  // 忽略其他程式碼
  // 監聽分頁資料改變
  watch([curPage, pageSize], () => {
    loadData(curPage.value);
  });
}
登入後複製

現在實現了基本的列表資料獲取

實現資料篩選器

在龐大的資料列表中，資料篩選是必不可少的功能

通常，我會將篩選條件欄位定義在一個ref中，在請求時將ref丟到請求函數即可。

在 useList 函數中，第二個引數接收一個filterOption物件，對應列表中的篩選條件欄位。

調整一下loadData函數，在請求函數中傳入filterOption物件即可

注意，傳入的 listRequestFn 函數接收的引數數量和型別是否正常對應上 請根據實際情況進行調整

export default function useList<
  ItemType extends Object,
  FilterOption extends Object
>(listRequestFn: Function, filterOption: Ref<Object>) {
  const loadData = async (page = curPage.value) => {
    // 設定載入中
    loading.value = true;
    try {
      const {
        data,
        meta: { total: count },
      } = await listRequestFn(pageSize.value, page, filterOption.value);
      list.value = data;
      total.value = count;
    } catch (error) {
      console.log("請求出錯了", "error");
    } finally {
      // 關閉載入中
      loading.value = false;
    }
  };
}
登入後複製

注意，這裡 filterOption 引數型別需要的是 ref 型別，否則會丟失響應式 無法正常工作

清空篩選器欄位

在頁面中，有一個重置的按鈕，用於清空篩選條件。這個重複的動作可以交給 reset 函數處理。

通過使用 Reflect 將所有值設定為undefined，再重新請求一次資料。

什麼是 Reflect？看看這一篇文章

export default function useList<
  ItemType extends Object,
  FilterOption extends Object
>(listRequestFn: Function, filterOption: Ref<Object>) {
  const reset = () => {
    if (!filterOption.value) return;
    const keys = Reflect.ownKeys(filterOption.value);
    filterOption.value = {} as FilterOption;
    keys.forEach((key) => {
      Reflect.set(filterOption.value!, key, undefined);
    });
    loadData();
  };
}
登入後複製

匯出功能

除了對資料的檢視，有些介面還需要有匯出資料功能（例如匯出 csv，excel 檔案），我們也把匯出功能寫到useList裡

通常，匯出功能是呼叫後端提供的匯出Api獲取一個檔案下載地址，和loadData函數類似，從外部獲取exportRequestFn函數來呼叫Api

在函數中，新增一個exportFile函數呼叫它。

export default function useList<
  ItemType extends Object,
  FilterOption extends Object
>(
  listRequestFn: Function,
  filterOption: Ref<Object>,
  exportRequestFn?: Function
) {
  // 忽略其他程式碼
  const exportFile = async () => {
    if (!exportRequestFn) {
      throw new Error("當前沒有提供exportRequestFn函數");
    }
    if (typeof exportRequestFn !== "function") {
      throw new Error("exportRequestFn必須是一個函數");
    }
    try {
      const {
        data: { link },
      } = await exportRequestFn(filterOption.value);
      window.open(link);
    } catch (error) {
      console.log("匯出失敗", "error");
    }
  };
}
登入後複製

注意，傳入的 exportRequestFn 函數接收的引數數量和型別是否正常對應上 請根據實際情況進行調整

優化

現在，整個useList已經滿足了頁面上的需求了，擁有了獲取資料，篩選資料，匯出資料，分頁功能

還有一些細節方面，在上面所有程式碼中的try..catch中的catch程式碼片段並沒有做任何的處理，只是簡單的console.log一下

提供勾點

在useList新增一個 Options 物件引數，用於函數成功、失敗時執行指定勾點函數與輸出訊息內容。

定義 Options 型別

export interface MessageType {
  GET_DATA_IF_FAILED?: string;
  GET_DATA_IF_SUCCEED?: string;
  EXPORT_DATA_IF_FAILED?: string;
  EXPORT_DATA_IF_SUCCEED?: string;
}
export interface OptionsType {
  requestError?: () => void;
  requestSuccess?: () => void;
  message: MessageType;
}

export default function useList<
  ItemType extends Object,
  FilterOption extends Object
>(
  listRequestFn: Function,
  filterOption: Ref<Object>,
  exportRequestFn?: Function,
  options? :OptionsType
) {
  // ...
}
登入後複製

設定Options預設值

const DEFAULT_MESSAGE = {
  GET_DATA_IF_FAILED: "獲取列表資料失敗",
  EXPORT_DATA_IF_FAILED: "匯出資料失敗",
};

const DEFAULT_OPTIONS: OptionsType = {
  message: DEFAULT_MESSAGE,
};

export default function useList<
  ItemType extends Object,
  FilterOption extends Object
>(
  listRequestFn: Function,
  filterOption: Ref<Object>,
  exportRequestFn?: Function,
  options = DEFAULT_OPTIONS
) {
  // ...
}
登入後複製

在沒有傳遞勾點的情況霞，推薦設定預設的失敗時資訊顯示

優化loadData，exportFile函數

基於 elementui 封裝 message 方法

import { ElMessage, MessageOptions } from "element-plus";

export function message(message: string, option?: MessageOptions) {
  ElMessage({ message, ...option });
}
export function warningMessage(message: string, option?: MessageOptions) {
  ElMessage({ message, ...option, type: "warning" });
}
export function errorMessage(message: string, option?: MessageOptions) {
  ElMessage({ message, ...option, type: "error" });
}
export function infoMessage(message: string, option?: MessageOptions) {
  ElMessage({ message, ...option, type: "info" });
}
登入後複製

loadData 函數

const loadData = async (page = curPage.value) => {
  loading.value = true;
  try {
    const {
      data,
      meta: { total: count },
    } = await listRequestFn(pageSize.value, page, filterOption.value);
    list.value = data;
    total.value = count;
    // 執行成功勾點
    options?.message?.GET_DATA_IF_SUCCEED &&
      message(options.message.GET_DATA_IF_SUCCEED);
    options?.requestSuccess?.();
  } catch (error) {
    options?.message?.GET_DATA_IF_FAILED &&
      errorMessage(options.message.GET_DATA_IF_FAILED);
    // 執行失敗勾點
    options?.requestError?.();
  } finally {
    loading.value = false;
  }
};
登入後複製

exportFile 函數

const exportFile = async () => {
  if (!exportRequestFn) {
    throw new Error("當前沒有提供exportRequestFn函數");
  }
  if (typeof exportRequestFn !== "function") {
    throw new Error("exportRequestFn必須是一個函數");
  }
  try {
    const {
      data: { link },
    } = await exportRequestFn(filterOption.value);
    window.open(link);
    // 顯示資訊
    options?.message?.EXPORT_DATA_IF_SUCCEED &&
      message(options.message.EXPORT_DATA_IF_SUCCEED);
    // 執行成功勾點
    options?.exportSuccess?.();
  } catch (error) {
    // 顯示資訊
    options?.message?.EXPORT_DATA_IF_FAILED &&
      errorMessage(options.message.EXPORT_DATA_IF_FAILED);
    // 執行失敗勾點
    options?.exportError?.();
  }
};
登入後複製

useList 使用方法

<template>
  <el-collapse>
    <el-collapse-item title="篩選條件" name="1">
      <el-form label-position="left" label-width="90px" :model="filterOption">
        <el-row :gutter="20">
          <el-col :xs="24" :sm="12" :md="8" :lg="8" :xl="8">
            <el-form-item label="使用者名稱">
              <el-input
                v-model="filterOption.name"
                placeholder="篩選指定簽名名稱"
              />
            </el-form-item>
          </el-col>
          <el-col :xs="24" :sm="12" :md="8" :lg="8" :xl="8">
            <el-form-item label="註冊時間">
              <el-date-picker
                v-model="filterOption.timeRange"
                type="daterange"
                unlink-panels
                range-separator="到"
                start-placeholder="開始時間"
                end-placeholder="結束時間"
                format="YYYY-MM-DD HH:mm"
                value-format="YYYY-MM-DD HH:mm"
              />
            </el-form-item>
          </el-col>
          <el-col :xs="24" :sm="24" :md="24" :lg="24" :xl="24">
            <el-row class="flex mt-4">
              <el-button type="primary" @click="filter">篩選</el-button>
              <el-button type="primary" @click="reset">重置</el-button>
            </el-row>
          </el-col>
        </el-row>
      </el-form>
    </el-collapse-item>
  </el-collapse>
  <el-table v-loading="loading" :data="list" border style="width: 100%">
    <el-table-column label="使用者名稱" min-width="110px">
      <template #default="scope">
        {{ scope.row.name }}
      </template>
    </el-table-column>
    <el-table-column label="手機號碼" min-width="130px">
      <template #default="scope">
        {{ scope.row.mobile || "未繫結手機號碼" }}
      </template>
    </el-table-column>
    <el-table-column label="郵箱地址" min-width="130px">
      <template #default="scope">
        {{ scope.row.email || "未繫結郵箱地址" }}
      </template>
    </el-table-column>
    <el-table-column prop="createAt" label="註冊時間" min-width="220px" />
    <el-table-column width="200px" fixed="right" label="操作">
      <template #default="scope">
        <el-button type="primary" link @click="detail(scope.row)"
          >詳情</el-button
        >
      </template>
    </el-table-column>
  </el-table>
  <div v-if="total > 0" class="flex justify-end mt-4">
    <el-pagination
      v-model:current-page="curPage"
      v-model:page-size="pageSize"
      background
      layout="sizes, prev, pager, next"
      :total="total"
      :page-sizes="[10, 30, 50]"
    />
  </div>
</template>
<script setup>
import { UserInfoApi } from "@/network/api/User";
import useList from "@/lib/hooks/useList/index";
const filterOption = ref<UserInfoApi.FilterOptionType>({});
const {
  list,
  loading,
  reset,
  filter,
  curPage,
  pageSize,
  reload,
  total,
  loadData,
} = useList<UserInfoApi.UserInfo[], UserInfoApi.FilterOptionType>(
  UserInfoApi.list,
  filterOption
);
</script>
登入後複製

本文useList的完整程式碼在

（學習視訊分享：、）

以上就是Vue3這樣寫列表頁，讓效能更好更高效！的詳細內容，更多請關注TW511.COM其它相關文章！