Node.js / 系统课时
读取路径与查询参数
读取路径与查询参数
Express 会把 URL 中的动态路由片段与问号后的查询条件分开处理。本课用商品查询接口读取 req.params 和 req.query,完成整数、布尔值转换及非法输入校验,示例适用于 Express 5.x。
学习目标
- 能从
req.params读取动态路径参数,并把字符串安全转换为整数。 - 能从
req.query读取分页和布尔查询参数,并处理缺省值。 - 能区分路径参数与查询参数的职责,避免直接信任用户输入。
路径参数由路由模板决定
路由 /products/:productId 中的 :productId 是命名路径参数。请求 /products/42 命中后,req.params.productId 的值是字符串 "42",不是数字。资源标识通常适合放在路径中,因为它决定“访问哪一个资源”。
不要直接写 Number.parseInt(req.params.productId, 10) 后就继续业务逻辑。Number.parseInt("42abc", 10) 会得到 42,容易把非法输入误当成合法 ID。更稳妥的做法是先检查完整字符串,再转换并验证安全整数范围。
function parsePositiveInt(value) {
// 先校验完整字符串,避免把 "42abc" 误解析成 42。
if (typeof value !== 'string' || !/^\d+$/.test(value)) {
return null;
}
const number = Number(value);
return Number.isSafeInteger(number) && number > 0 ? number : null;
}这是片段示例,依赖后面的 Express 路由处理函数调用。对于 "42" 返回 42,对于 "42abc"、"0" 或超出安全整数范围的值返回 null。
查询参数适合筛选和分页
请求 /products/42?page=2&limit=5&includeDrafts=true 中,page、limit 和 includeDrafts 都来自 req.query。查询参数通常是可选条件,因此应明确默认值,例如页码默认 1、每页数量默认 20,并给出上限避免一次返回过多数据。
Express 5.x 默认使用 simple 查询解析器,req.query 还是外部输入,并且该属性是 getter,不应通过 req.query.page = 1 这类写法修改。需要标准化时,把结果写入局部变量或新的过滤对象。
| 参数 | 读取位置 | 本例规则 |
|---|---|---|
productId |
req.params.productId |
正整数,必须大于 0 |
page |
req.query.page |
默认 1,最小 1 |
limit |
req.query.limit |
默认 20,范围 1~100 |
includeDrafts |
req.query.includeDrafts |
只有字符串 true 表示真 |
完成一个可运行的读取接口
以下示例适用于 Node.js 18+ 与 Express 5.x。若项目尚未安装 Express,在项目目录执行:
npm install express@5预期结果
命令以退出码 0 结束,package.json 的 dependencies 中记录 express 5.x。创建 app.js,保存后运行 node app.js:
const express = require('express');
const app = express();
function parsePositiveInt(value, fallback = null) {
// 先检查完整字符串,再做数值转换。
if (value === undefined && fallback !== null) return fallback;
if (typeof value !== 'string' || !/^\d+$/.test(value)) return null;
const number = Number(value);
return Number.isSafeInteger(number) && number > 0 ? number : null;
}
app.get('/products/:productId', (req, res) => {
// Express 输入先转成局部变量,不直接修改 req.query。
const productId = parsePositiveInt(req.params.productId);
const page = parsePositiveInt(req.query.page, 1);
const limit = parsePositiveInt(req.query.limit, 20);
if (productId === null || page === null || limit === null || limit > 100) {
return res.status(400).json({ error: 'invalid parameters' });
}
// 布尔查询参数只接受明确的 true 或 false。
const includeDraftsRaw = req.query.includeDrafts;
if (includeDraftsRaw !== undefined && includeDraftsRaw !== 'true' && includeDraftsRaw !== 'false') {
return res.status(400).json({ error: 'includeDrafts must be true or false' });
}
const includeDrafts = includeDraftsRaw === 'true';
return res.json({ productId, page, limit, includeDrafts });
});
app.listen(3000, () => {
console.log('http://localhost:3000');
});预期输出
http://localhost:3000保持服务运行,在另一个终端请求接口:
curl "http://localhost:3000/products/42?page=2&limit=5&includeDrafts=true"预期输出
{"productId":42,"page":2,"limit":5,"includeDrafts":true}这里的转换发生在进入业务逻辑之前:路径参数先验证完整格式,查询参数再补默认值和范围限制。这样数据库层拿到的是已经明确类型和边界的值,而不是原始字符串。
处理重复值与非法输入
查询字符串允许重复键,例如 ?tag=node&tag=express。在 Express 5.x 默认的 simple 解析器下,重复键可能得到字符串数组,因此不要假设每个 req.query 成员一定是字符串。只接受单值时,应先检查 typeof value === 'string';需要多值筛选时,再显式接受数组并逐项校验。
对于数值参数,也不要依赖 JavaScript 的隐式类型转换。page=0、limit=500、productId=abc 都应该在接口边界返回 400,而不是让异常值继续进入数据库查询。路径参数确定资源身份,查询参数描述可选条件,这个划分能让路由语义和校验规则保持清晰。