Express拆分路由后req.params为undefined报错排查

问题原因 #

三个问题叠加导致报错：

1. 路由参数未继承：拆分到独立文件的Express Router默认不会继承挂载路径上的URL参数。单文件编写路由时不存在父子路由层级，:name参数可以直接通过req.params读取；拆分后子路由默认隔离父路由的params，因此req.params.name返回undefined。
2. 数组查找逻辑错误：即使参数能正常获取，现有envelopes.find(envelope => envelopeToChangeName)写法也无法正确匹配目标信封——判断条件仅判断envelopeToChangeName变量本身的真值，永远返回数组第一个元素，没有做信封名称和参数值的等值匹配。
3. 额外隐患：路由挂载顺序错误，/envelopes/transfer/:name路径会被优先级更高的/envelopes/:name提前匹配，把transfer识别为信封名称参数。

修复方法 #

1. 开启子路由的参数合并 #

在routes/Envelopes_name.js（以及其他需要读取父路由参数的路由文件，比如Envelopes_transfer.js）中，初始化Router时传入mergeParams: true配置，允许子路由合并父路由的URL参数：

const express = require('express')
// 开启参数合并
const router = express.Router({ mergeParams: true })

// 后续路由逻辑不变

2. 修复信封匹配逻辑 #

修正Array.find的判断条件，增加目标不存在的异常捕获，同时注意query参数默认是字符串类型，预算值需要做数字类型转换：

router.put("/", (req,res,next)=>{
    const envelopeToChangeName = req.params.name
    const envelopeName = req.query.name
    const envelopeBudget = req.query.budget
    // 按name字段匹配目标信封
    const reqEnvelope = envelopes.find(envelope => envelope.name === envelopeToChangeName)
    // 捕获信封不存在的场景
    if (!reqEnvelope) {
        return res.status(404).send({ error: `名称为${envelopeToChangeName}的信封不存在` })
    }
    if(envelopeBudget){
        reqEnvelope.budget = Number(envelopeBudget)
    }
    if(envelopeName){
        reqEnvelope.name = envelopeName
    }
    // 更新操作建议返回200状态码，201标准语义是资源创建成功
    res.status(200).send(reqEnvelope)
})

module.exports = router

3. 调整路由挂载顺序 #

把路径更具体的路由放在通用参数路由前面，避免被错误匹配：

// server.js中调整路由顺序
app.use("/envelopes", envelopeRoute)
// 路径更具体的transfer路由放在:name通用路由前面
app.use("/envelopes/transfer/:name", envelopeTransferRoute)
app.use("/envelopes/:name", envelopeNameRoute)
app.use("/budget", budgetRoute)

内容的提问来源于stack exchange，提问作者Wgoral