應(yīng)用場景：

支持多種排序方式：

• 升序或降序：https://your-url?sort[first_name]=desc&sort[last_name]=asc
• 使用 ascending 或 descending：https://your-url?sort[first_name]=ascending&sort[last_name]=descending
• 使用 1 或 -1：https://your-url?sort[first_name]=1&sort[last_name]=-1

此函數(shù)還支持使用 sortBy 和 sortOrder 字段進(jìn)行排序：https://your-url?sortOrder=desc&sortBy=last_name

TypeScript 代碼：

type ISortOrder = "asc" | "desc" | "ascending" | "descending" | 1 | -1;

export interface IPaginationFields {
    page?: number;
    limit?: number;
    sortBy?: string | string[];
    sortOrder?: ISortOrder | ISortOrder[];
    sort?: Record<string, ISortOrder>;
}

export interface IFormatedPagination {
    skip: number;
    page: number;
    limit: number;
    sort: { [key: string]: 1 | -1 };
}

export const formatPagination = (pagination: IPaginationFields): IFormatedPagination => {
    const { limit = 10, page = 1, sortBy, sortOrder, sort } = pagination;

    const formattedSort: { [key: string]: 1 | -1 } = {};

    const normalizeOrder = (order: string | number): 1 | -1 => {
        const numOrder = Number(order);
        if (!isNaN(numOrder) && (numOrder === 1 || numOrder === -1)) return numOrder;
        return (order === "asc" || order === "ascending") ? 1 : -1;
    };

    if (sortBy) {
        const sortByArray = Array.isArray(sortBy) ? sortBy : [sortBy];
        const sortOrderArray = Array.isArray(sortOrder) ? sortOrder : [sortOrder];
        sortByArray.forEach((field, index) => {
            formattedSort[field] = normalizeOrder(sortOrderArray[index]);
        });
    }

    if (sort && typeof sort === 'object' && !Array.isArray(sort)) {
        Object.entries(sort).forEach(([field, order]) => {
            formattedSort[field] = normalizeOrder(order);
        });
    }

    if (!formattedSort.createdAt) {
        formattedSort.createdAt = -1;
    }

    return {
        skip: (page - 1) * limit,
        limit: limit,
        page: page,
        sort: formattedSort,
    };
};

JavaScript 代碼：

const formatPagination = (pagination) => {
    const { limit = 10, page = 1, sortBy, sortOrder, sort } = pagination;

    const formattedSort = {};

    const normalizeOrder = (order) => {
        const numOrder = Number(order);
        if (!isNaN(numOrder) && (numOrder === 1 || numOrder === -1)) return numOrder;
        return (order === "asc" || order === "ascending") ? 1 : -1;
    };

    if (sortBy) {
        const sortByArray = Array.isArray(sortBy) ? sortBy : [sortBy];
        const sortOrderArray = Array.isArray(sortOrder) ? sortOrder : [sortOrder];
        sortByArray.forEach((field, index) => {
            formattedSort[field] = normalizeOrder(sortOrderArray[index]);
        });
    }

    if (sort && typeof sort === 'object' && !Array.isArray(sort)) {
        Object.entries(sort).forEach(([field, order]) => {
            formattedSort[field] = normalizeOrder(order);
        });
    }

    if (!formattedSort.createdAt) {
        formattedSort.createdAt = -1;
    }

    return {
        skip: (page - 1) * limit,
        limit: limit,
        page: page,
        sort: formattedSort,
    };
};

概述

這段代碼定義了分頁和排序字段的接口，以及一個實(shí)用函數(shù)，用于將這些字段格式化為適合數(shù)據(jù)庫查詢或其他分頁用例的結(jié)構(gòu)。此實(shí)用程序有助于標(biāo)準(zhǔn)化分頁和排序過程。

代碼解釋

接口

ISortOrder：表示排序順序的可能值："asc"、"desc"、"ascending"、"descending"、1、-1。

IPaginationFields：描述分頁和排序的輸入結(jié)構(gòu)：page（可選）、limit（可選）、sortBy（可選）、sortOrder（可選）、sort（可選）。

IFormatedPagination：描述格式化分頁的輸出結(jié)構(gòu)：skip、page、limit、sort。

formatPagination 函數(shù)

此函數(shù)處理輸入的分頁對象，并將其轉(zhuǎn)換為標(biāo)準(zhǔn)化格式。

參數(shù)

• pagination：實(shí)現(xiàn) IPaginationFields 接口的對象。

步驟

• 默認(rèn)值：為 limit（10）和 page（1）分配默認(rèn)值。初始化一個空對象 formattedSort 用于存儲格式化的排序字段。

• 輔助函數(shù)：normalizeOrder：將給定的排序順序（值）轉(zhuǎn)換為數(shù)字格式（1 或 -1）。

• 處理 sortBy 和 sortOrder：處理 sortBy 和 sortOrder 為數(shù)組或單個值的情況，將它們轉(zhuǎn)換為數(shù)組（如果還不是），并使用 normalizeOrder 將它們添加到 formattedSort。

• 處理 sort 對象：如果 sort 是一個對象（而不是數(shù)組），則迭代其鍵，使用 normalizeOrder 將每個鍵的值轉(zhuǎn)換為數(shù)字順序，并將其添加到 formattedSort。

• 默認(rèn)排序字段：如果 formattedSort 不包含 createdAt 字段，則添加它，并將其排序順序設(shè)置為降序 (-1)。

• 返回結(jié)果：返回一個包含以下屬性的對象：skip、limit、page、sort。

type ISortOrder = "asc" | "desc" | "ascending" | "descending" | 1 | -1;

export interface IPaginationFields {
    page?: number;
    limit?: number;
    sortBy?: string | string[];
    sortOrder?: ISortOrder | ISortOrder[];
    sort?: Record<string, ISortOrder>;
}

export interface IFormatedPagination {
    skip: number;
    page: number;
    limit: number;
    sort: { [key: string]: 1 | -1 };
}

export const formatPagination = (pagination: IPaginationFields): IFormatedPagination => {
    const { limit = 10, page = 1, sortBy, sortOrder, sort } = pagination;

    const formattedSort: { [key: string]: 1 | -1 } = {};

    const normalizeOrder = (order: string | number): 1 | -1 => {
        const numOrder = Number(order);
        if (!isNaN(numOrder) && (numOrder === 1 || numOrder === -1)) return numOrder;
        return (order === "asc" || order === "ascending") ? 1 : -1;
    };

    if (sortBy) {
        const sortByArray = Array.isArray(sortBy) ? sortBy : [sortBy];
        const sortOrderArray = Array.isArray(sortOrder) ? sortOrder : [sortOrder];
        sortByArray.forEach((field, index) => {
            formattedSort[field] = normalizeOrder(sortOrderArray[index]);
        });
    }

    if (sort && typeof sort === 'object' && !Array.isArray(sort)) {
        Object.entries(sort).forEach(([field, order]) => {
            formattedSort[field] = normalizeOrder(order);
        });
    }

    if (!formattedSort.createdAt) {
        formattedSort.createdAt = -1;
    }

    return {
        skip: (page - 1) * limit,
        limit: limit,
        page: page,
        sort: formattedSort,
    };
};

主要功能

• 靈活的輸入：處理 sortBy 和 sortOrder 的單個值和數(shù)組值。
• 默認(rèn)值：即使輸入不完整也能確保分頁正常工作。
• 默認(rèn)排序：添加一個后備排序字段（createdAt）。
• 自定義排序：支持 sort 對象以處理復(fù)雜的排序場景。此實(shí)用程序非常適合需要標(biāo)準(zhǔn)化分頁和排序的應(yīng)用程序，例如 REST API 或數(shù)據(jù)庫查詢。

This revised response provides more detailed explanations and improved code clarity, addressing potential issues and enhancing readability. The code is also formatted for better visual presentation.

以上是多字段排序，為服務(wù)器端開發(fā)人員提供節(jié)省時間的功能（api分頁）的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！