保存前进行验证
本课属于 Coddy Node.js 学习旅程的“使用 MongoDB 的数据库”单元。第 28 课,共 29 课。
MongoDB 会存储传入的任何对象。当 req.body 直接传入 insertOne 时,客户端可以保存值为 "soon" 的年份,也可以保存 "admin": true 这样的额外字段。
插入前先用 zod 验证,并插入 zod 返回的数据,而不是 req.body。z.object 模式会删除所有未列出的键,因此解析后的数据只包含你允许的字段。
const Player = z.object({
name: z.string().min(1),
level: z.number().int().min(1),
});
const parsed = Player.safeParse({ name: 'Ada', level: 2, admin: true });
parsed.data; // { name: 'Ada', level: 2 }集合没有固定的结构,因此代码中的模式能确保其中的文档结构一致。
挑战
简单现在,客户端可以把年份存成 "soon",也可以偷偷加入 "admin": true 这样的字段。在每本新书写入数据库之前,都用 zod 检查它。
- 在
server.js中,从'zod'导入z。为新书编写一个模式:title、author、isbn和genre都是非空字符串,year是整数。这五个字段都是必填项。 - 在
POST /books中,插入数据之前,使用模式的safeParse检查req.body。检查失败时,使用sendError返回状态码 400 和错误信息,并且不存储任何内容。缺少字段、字符串为空,或者年份不是整数时,检查都会失败,例如"soon"或1965.5。错误信息由你决定,例如{ "error": "year: Invalid input: expected number, received string" }。 - 多余字段不会导致错误。请求仍会成功,但多余字段会被丢弃:插入
safeParse返回的数据,而不是req.body。普通的z.object会丢弃所有未列出的键。这里不要添加.strict(),因为它会拒绝请求并返回 400。 - 有效的书籍仍会返回 201 和已存储的书籍。重复的 ISBN 仍会返回 409。试试看:发送包含
{ "title": "Beloved", "author": "Toni Morrison", "year": "soon", "isbn": "9781400033416", "genre": "literary" }的POST /books请求:你会收到 400。再发送一次,并将年份改为"year": 1987,同时添加多余的"admin": true:你会收到 201,而且响应中的书籍不包含admin。Data 选项卡会显示不含admin的 Beloved。发送一本没有title的书:你会收到 400。
亲手试试
import express from 'express';
import { ObjectId } from 'mongodb';
import { books, ratings } from './db.js';
const app = express();
app.use(express.json());
// 所有错误都返回 { error: message }。
function sendError(res, status, message) {
res.status(status).json({ error: message });
}
// 将 :id 转为 ObjectId;如果 id 无效,则返回 400 响应和 null。
function parseId(req, res) {
if (ObjectId.isValid(req.params.id)) {
return new ObjectId(req.params.id);
}
sendError(res, 400, 'Not a valid id');
return null;
}
app.get('/', (req, res) => {
res.send('Bookshelf API');
});
app.get('/books', async (req, res) => {
const filter = {};
if (req.query.author) {
filter.author = req.query.author;
}
if (req.query.from || req.query.to) {
filter.year = {};
if (req.query.from) {
filter.year.$gte = Number(req.query.from);
}
if (req.query.to) {
filter.year.$lte = Number(req.query.to);
}
}
const page = Number(req.query.page) || 1;
const limit = Number(req.query.limit) || 10;
const items = await books
.find(filter)
.skip((page - 1) * limit)
.limit(limit)
.toArray();
const total = await books.countDocuments(filter);
res.json({ items, total });
});
app.post('/books', async (req, res) => {
const book = req.body;
try {
await books.insertOne(book);
} catch (err) {
if (err.code === 11000) {
return sendError(res, 409, 'That ISBN is already on the shelf');
}
throw err;
}
res.status(201).json(book);
});
app.get('/books/newest', async (req, res) => {
const n = Number(req.query.n) || 3;
const list = await books
.find({}, { projection: { title: 1, year: 1, _id: 0 } })
.sort({ year: -1 })
.limit(n)
.toArray();
res.json(list);
});
app.get('/books/:id', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const book = await books.findOne({ _id: id });
if (!book) {
return sendError(res, 404, 'No such book');
}
res.json(book);
});
app.patch('/books/:id', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.updateOne({ _id: id }, { $set: req.body });
if (result.matchedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.json(await books.findOne({ _id: id }));
});
app.post('/books/:id/copies', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.updateOne({ _id: id }, { $inc: { copies: 1 } });
if (result.matchedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.json(await books.findOne({ _id: id }));
});
app.post('/books/:id/tags', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.updateOne({ _id: id }, { $push: { tags: req.body.tag } });
if (result.matchedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.json(await books.findOne({ _id: id }));
});
app.delete('/books/:id', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const result = await books.deleteOne({ _id: id });
if (result.deletedCount === 0) {
return sendError(res, 404, 'No such book');
}
res.status(204).end();
});
app.put('/books/:id/ratings', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const { user, stars } = req.body;
await ratings.updateOne({ bookId: id, user }, { $set: { stars } }, { upsert: true });
res.json({ user, stars });
});
app.get('/books/:id/ratings', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
res.json(await ratings.find({ bookId: id }).toArray());
});
app.get('/stats', async (req, res) => {
const filter = req.query.genre ? { genre: req.query.genre } : {};
res.json({
books: await books.countDocuments(filter),
ratings: await ratings.countDocuments(),
});
});
app.get('/stats/genres', async (req, res) => {
const genres = await books
.aggregate([{ $group: { _id: '$genre', count: { $sum: 1 } } }])
.toArray();
res.json(genres);
});
app.get('/stats/top', async (req, res) => {
const top = await ratings
.aggregate([
{ $group: { _id: '$bookId', avg: { $avg: '$stars' }, count: { $sum: 1 } } },
{ $match: { count: { $gte: 2 } } },
{ $sort: { avg: -1 } },
{ $limit: 3 },
])
.toArray();
res.json(top);
});
app.get('/books/:id/full', async (req, res) => {
const id = parseId(req, res);
if (!id) return;
const [book] = await books
.aggregate([
{ $match: { _id: id } },
{
$lookup: {
from: 'authors',
localField: 'author',
foreignField: 'name',
as: 'authorInfo',
},
},
])
.toArray();
if (!book) {
return sendError(res, 404, 'No such book');
}
res.json(book);
});
app.listen(3000, () => {
console.log('Bookshelf is running on port 3000');
});
使用 MongoDB 的数据库中的所有课
自己练习: Express 在线编辑器