解决 Express.js 中路由权重匹配的问题-JavaScript中文网-JavaScript教程资源分享门户

在使用 Express.js 进行开发时，我们会经常遇到路由权重匹配的问题。这个问题是指当我们定义多个路由时，可能存在不同的路由将会匹配到同一个 URL 上，而由于 Express.js 路由处理的优先级是按照定义的顺序来决定的，所以就无法确定哪一个路由会被执行。

在本文中，我们将探讨这个问题，并介绍如何通过调整路由的定义来解决这个问题。

案例分析

假设我们有以下路由定义：

app.get('/cats/:id', function (req, res) {
  res.send('This is a cat!');
});

app.get('/animals/:id', function (req, res) {
  res.send('This is an animal!');
});

app.get('/:id', function (req, res) {
  res.send('This is something else!');
});

如果请求的 URL 是 /cats/42，那么根据定义的路由规则，会匹配到第一个路由 /cats/:id，返回的响应消息是 This is a cat!。但是，如果我们请求的 URL 是 /animals/42，那么由于也符合第二个路由 /animals/:id 的定义，按照路由的优先级，Express.js 将会匹配到第二个路由，返回的响应消息是 This is an animal!，这显然并不是我们期望的结果。

解决方案

1. 调整路由顺序

解决这个问题的第一种方案是调整路由的顺序。我们可以将定义较为具体的路由放在前面，定义较为抽象的路由放在后面。

在上面的案例中，我们可以将第一个路由 /cats/:id 放在第二个路由 /animals/:id 的前面：

app.get('/cats/:id', function (req, res) {
  res.send('This is a cat!');
});

app.get('/animals/:id', function (req, res) {
  res.send('This is an animal!');
});

app.get('/:id', function (req, res) {
  res.send('This is something else!');
});

这样，当请求的 URL 是 /cats/42 时，第一个路由 /cats/:id 会被匹配到，返回的响应消息是 This is a cat!；而当请求的 URL 是 /animals/42 时，第二个路由 /animals/:id 会被匹配到，返回的响应消息是 This is an animal!，符合我们的期望结果。

2. 使用正则表达式

另外一个解决这个问题的方案是使用正则表达式来定义路由。正则表达式可以非常灵活地匹配 URL，而且可以通过分组来获取 URL 中的参数。

在上面的案例中，我们可以将路由定义如下：

app.get(/^\/cats\/(\d+)$/, function (req, res) {
  res.send('This is a cat!');
});

app.get(/^\/animals\/(\d+)$/, function (req, res) {
  res.send('This is an animal!');
});

app.get(/^\/(\d+)$/, function (req, res) {
  res.send('This is something else!');
});

这样，当请求的 URL 是 /cats/42 时，第一个路由 /^\/cats\/(\d+)$/ 会被匹配到，返回的响应消息是 This is a cat!；当请求的 URL 是 /animals/42 时，第二个路由 /^\/animals\/(\d+)$/ 会被匹配到，返回的响应消息是 This is an animal!，符合我们的期望结果。

3. 使用中间件

还有一个解决这个问题的方案是使用中间件。我们可以在每个路由的处理函数之前添加一个中间件，来判断当前 URL 是否应该被处理。

在上面的案例中，我们可以将路由和中间件定义如下：

function catMiddleware(req, res, next) {
  if (req.url.match(/^\/cats\/\d+$/)) {
    res.send('This is a cat!');
  } else {
    next();
  }
}

function animalMiddleware(req, res, next) {
  if (req.url.match(/^\/animals\/\d+$/)) {
    res.send('This is an animal!');
  } else {
    next();
  }
}

function defaultMiddleware(req, res) {
  res.send('This is something else!');
}

app.use(catMiddleware);
app.use(animalMiddleware);
app.use(defaultMiddleware);

这样，当请求的 URL 是 /cats/42 时，catMiddleware 中间件会将请求处理掉，返回的响应消息是 This is a cat!；当请求的 URL 是 /animals/42 时，animalMiddleware 中间件会将请求处理掉，返回的响应消息是 This is an animal!，符合我们的期望结果。

总结

在 Express.js 中，定义多个路由的时候，可能会出现路由权重匹配的问题，导致无法确定哪一个路由会被执行。我们可以通过调整路由的顺序、使用正则表达式、或者使用中间件来解决这个问题。以上三种方案都有其优缺点，开发者需要根据具体场景来选择最合适的方案。

示例代码

const express = require('express');

const app = express();

// 路由定义
app.get('/cats/:id', function (req, res) {
  res.send('This is a cat!');
});

app.get('/animals/:id', function (req, res) {
  res.send('This is an animal!');
});

app.get('/:id', function (req, res) {
  res.send('This is something else!');
});


// 服务器启动
const server = app.listen(3000, function () {
  console.log(`Server is running at http://localhost:${server.address().port}`);
});

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/65a214ddadd4f0e0ffa25ba7

解决 Express.js 中路由权重匹配的问题