Menu
CoddyTech

排序

本课属于 Coddy Node.js 学习旅程的“REST API”单元。第 16 课,共 25 课。

客户端可能希望最新的任务排在最前面,或者列表按 A 到 Z 排序。常见的约定是使用 ?sort=field,在前面加上 - 表示反向排序:

// GET /api/books?sort=-year
const field = sort.startsWith('-') ? sort.slice(1) : sort;   // 'year'
const direction = sort.startsWith('-') ? -1 : 1;
list = list.toSorted((a, b) => (a[field] - b[field]) * direction);

先检查 field 是否在允许的字段中,如果不是,就返回 400,因为使用 books 中不存在的字段无法得到有用的排序结果。toSorted 会返回一个排好序的副本。sort 会直接重新排列数组本身;如果之前没有筛选操作创建副本,那么这个数组就是存储的数据,之后的每个请求都会看到新的顺序。这个示例使用减法进行比较,因此只适用于数字。要比较两个字符串,请使用 a.localeCompare(b):和减法一样,它会返回负数、0 或正数。ISO 日期是字符串,按时间顺序排序。

challenge icon

挑战

简单

把你在“按文本排序”中编写的仅按 title 排序的代码,替换为下面处理字段和方向的代码。

客户端希望最新的任务排在前面,或者列表按 A 到 Z 排序。让列表通过 ?sort= 自行排序。

  1. 在 routes/tasks.js 的列表路由中,从 req.query 读取 sort。如果没有这个参数,列表会保持存储时的顺序。
  2. ?sort=title 会按 title 从 A 到 Z 排序。?sort=createdAt 会按创建时间排序,最早的排在前面。在前面加上 - 会反转顺序:?sort=-title 会按 Z 到 A 排序,而 ?sort=-createdAt 会让最新的排在前面。
  3. 这两个字段都是文本。createdAt 是 ISO 日期,例如 "2026-03-03T10:30:00.000Z",按文本排序也能得到正确结果。因此要用 localeCompare 进行比较,而不是相减。
  4. 如果使用其他字段,例如 ?sort=color,则会返回状态码 400:
    { "error": { "code": "invalid_query", "message": "sort must be title or createdAt, with - in front to reverse" } }
  5. 要在应用筛选条件后再排序,这样 ?done=false&sort=-title 会按 Z 到 A 的顺序返回未完成的任务。
  6. 用 toSorted 对副本排序。sort 会直接改变存储的数组顺序,之后的每个请求都会看到新的顺序。

试试看:GET /api/tasks?sort=title 会返回任务 2、3、1("Book..."、"Send..."、"Write...")。GET /api/tasks?sort=-createdAt 会返回 3、2、1。然后,普通的 GET /api/tasks 会再次返回 1、2、3。GET /api/tasks?sort=color 会返回状态码 400,错误代码为 invalid_query。

亲手试试

import { Router } from 'express';
import { z } from 'zod';
import { sendError, sendInvalid } from '../errors.js';
import { nextId, tasks } from '../store.js';

const router = Router();

// 完整的任务,格式与 PUT 发送的一致。.strict() 会拒绝未列出的字段。
const Task = z
    .object({
        title: z.string().trim().min(1).max(100),
        done: z.boolean(),
    })
    .strict();
const NewTask = Task.partial({ done: true });
const TaskChanges = Task.partial();

// 如果其他任务已有这个标题,无论大小写,结果都为 true。
const titleTaken = (title, exceptId) =>
    tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());

router.get('/', (req, res) => {
    const { done, q } = req.query;
    let list = tasks;
    if (done !== undefined) {
        if (done !== 'true' && done !== 'false') {
            return sendError(res, 400, 'invalid_query', 'done must be true or false');
        }
        list = list.filter((t) => t.done === (done === 'true'));
    }
    if (q !== undefined) {
        const words = String(q).toLowerCase();
        list = list.filter((t) => t.title.toLowerCase().includes(words));
    }
    if (req.query.sort === 'title') {
        list = list.toSorted((a, b) => a.title.localeCompare(b.title));
    }
    res.json(list);
});

router.get('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    res.json(task);
});

router.post('/', (req, res) => {
    const result = NewTask.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { title, done = false } = result.data;
    if (titleTaken(title)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    const task = { id: nextId(), title, done, createdAt: new Date().toISOString() };
    tasks.push(task);
    res.status(201).location(`/api/tasks/${task.id}`).json(task);
});

router.patch('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = TaskChanges.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    if (result.data.title !== undefined && titleTaken(result.data.title, task.id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    Object.assign(task, result.data);
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = Task.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { id, createdAt } = tasks[index];
    if (titleTaken(result.data.title, id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    tasks[index] = { id, ...result.data, createdAt };
    res.json(tasks[index]);
});

router.delete('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;

REST API中的所有课

自己练习: Express 在线编辑器