调整Express.js端点顺序后请求/me接口出现CastError求助

原因分析 #

• Express的路由匹配规则是从上到下依次匹配，谁先匹配到就会执行对应的处理逻辑。
• 当你把/:userId动态路由放在/me固定路由前面时，请求/users/me会被/:userId路由优先捕获，此时req.params.userId的值是字符串"me"。
• 你的findUserById方法会把这个"me"当作MongoDB的ObjectId去查询，但"me"完全不符合ObjectId的格式要求（必须是12字节字符串、24位十六进制字符串或整数），因此触发了CastError。
• 原代码中/me路由在/:userId前面，请求/users/me会先匹配到固定路径的/me，所以能正常执行。

解决方案 #

有两种可行的解决方式：

方式一：调整路由顺序（推荐） #

把固定路径的路由（如/me）放在动态参数路由（如/:userId）的前面，让Express优先匹配固定路径，也就是你最初能正常运行的代码顺序：

router.get("/me", sessionChecker, async (req, res, next) => {
  const { userId } = req.session.payload;

  const user = await UserService.findUserById(userId);

  return res.json(user);
});

router.get("/:userId", sessionChecker, async (req, res, next) => {
  const { userId } = req.params;

  const user = await UserService.findUserById(userId);
  return res.json(user);
});

方式二：给动态路由添加参数验证 #

在/:userId路由前添加一个中间件，验证参数是否符合ObjectId格式，不符合则跳过当前路由，让后续路由继续匹配：

const mongoose = require('mongoose');

// 新增ObjectId验证中间件
const validateObjectId = (req, res, next) => {
  if (!mongoose.Types.ObjectId.isValid(req.params.userId)) {
    // 跳过当前路由，交给后面的路由处理
    return next();
  }
  next();
};

router.get("/:userId", validateObjectId, sessionChecker, async (req, res, next) => {
  const { userId } = req.params;

  const user = await UserService.findUserById(userId);
  return res.json(user);
});

router.get("/me", sessionChecker, async (req, res, next) => {
  const { userId } = req.session.payload;

  const user = await UserService.findUserById(userId);

  return res.json(user);
});

这样当请求/users/me时，因为"me"不是合法的ObjectId，会跳过/:userId路由，继续匹配后面的/me路由。

内容的提问来源于stack exchange，提问作者Ertan Özdemir