多字段排序，为服务器端开发人员提供节省时间的功能（api分页）

在IT行业这个发展更新速度很快的行业，只有不停止的学习，才不会被行业所淘汰。如果你是文章学习者，那么本文《多字段排序，为服务器端开发人员提供节省时间的功能（api分页）》就很适合你！本篇内容主要包括##content_title##，希望对大家的知识积累有所帮助，助力实战开发！

应用场景：
您可以使用多种方式指定排序顺序，例如：

• 升序/降序: 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
• sortby 和 sortorder 参数: https://your-url?sortorder=desc&sortby=last_name

此函数还能处理 sortby 和 sortorder 参数。

TypeScript 代码：

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

export interface IPaginationFields {
    page?: number;
    limit?: number;
    sortby?: string | string[];
    sortorder?: SortOrder | SortOrder[];
    sort?: Record<string, SortOrder>;
}

export interface IFormattedPagination {
    skip: number;
    page: number;
    limit: number;
    sort: Record<string, 1 | -1>;
}

export const formatPagination = (
    pagination: IPaginationFields
): IFormattedPagination => {
    const { limit = 10, page = 1, sortby, sortorder, sort = {} } = pagination;

    const formattedSort: Record<string, 1 | -1> = {};

    const normalizeOrder = (value: string | number): 1 | -1 => {
        const numValue = Number(value);
        if (!isNaN(numValue) && (numValue === 1 || numValue === -1)) {
            return numValue;
        } else {
            return value === "asc" || value === "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]);
        });
    }

    Object.entries(sort).forEach(([field, order]) => {
        formattedSort[field] = normalizeOrder(order);
    });


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

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

JavaScript 代码：

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

    const formattedSort = {};

    const normalizeOrder = (value) => {
        const numValue = Number(value);
        if (!isNaN(numValue) && (numValue === 1 || numValue === -1)) {
            return numValue;
        } else {
            return value === "asc" || value === "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]);
        });
    }

    Object.entries(sort).forEach(([field, order]) => {
        formattedSort[field] = normalizeOrder(order);
    });

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

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

功能概述:

这段代码提供了一个函数 formatPagination，用于将各种分页和排序参数规范化为数据库查询或其他后端系统易于理解的格式。它支持多种排序参数格式，并提供默认值和默认排序字段 (createdAt) 以增强健壮性。

代码说明:

• 类型定义: SortOrder 枚举定义了所有支持的排序值。IPaginationFields 和 IFormattedPagination 接口定义了输入和输出对象的结构。

• formatPagination 函数: 该函数解析输入参数，并将其转换为标准化的 IFormattedPagination 对象。 normalizeOrder 辅助函数将各种排序值（字符串或数字）转换为统一的 1 (升序) 或 -1 (降序) 表示。 函数处理 sortby/sortorder 和 sort 对象两种参数形式，并添加默认的 createdAt 排序。

• 示例用法: 提供的示例展示了如何使用该函数以及其输出结果。

主要优势:

• 灵活的输入: 支持多种排序参数格式，提高了代码的可复用性和灵活性。
• 健壮性: 提供默认值和默认排序字段，确保即使输入参数不完整也能正常工作。
• 可读性和可维护性: 使用 TypeScript 接口和类型定义，提高了代码的可读性和可维护性。
• 标准化输出: 将排序参数转换为统一的格式，方便数据库查询或其他后端操作。

这个改进后的版本更简洁、更易于理解，并且更好地处理了各种输入情况。

到这里，我们也就讲完了《多字段排序，为服务器端开发人员提供节省时间的功能（api分页）》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！