深入浅出Express.Router

发布时间：2023-05-17

Express.Router详解

Express是Node.js最流行的Web开发框架之一。在Express中，Express.Router是一个中间件容器，用于把路由处理器组织成一组相关的路由。在本文中，会从多个方面对Express.Router进行详细的阐述。

一、基本用法

1. 创建路由容器

在Express中，通过express.Router()方法来创建路由容器。下面是一个简单的示例代码：

const express = require('express');
const router = express.Router();

这里我们创建了一个名为router的路由容器。

2. 向路由容器添加路由处理器

在创建了路由容器之后，我们需要向容器中添加路由处理器，具体的方法有get()、post()、put()等，示例如下：

router.get('/', function(req, res) {
  res.send('Hello Router');
});

上面的代码表示访问根路径时，路由会返回字符串'Hello Router'。

3. 将路由容器挂载到主应用程序中

在添加了路由处理器后，我们需要将路由容器挂载到主应用程序中，代码如下:

app.use('/', router);

其中，仅有一个参数'/'表示所有的请求都会被转发到router，如果想要在请求中添加其他前缀，可以在第一个参数中指定。

二、动态路由

1. 基本用法

动态路由是指路由中包含参数，这些参数可以是在路由中指定的，也可以是通过查询字符串传递的。下面是一个简单的动态路由示例：

router.get('/user/:name', function(req, res) {
  res.send('Hello, ' + req.params.name);
});

在这里，我们通过冒号来指定了路由中的参数，然后在处理函数中通过req.params.name获取了请求传递的参数。

2. 占位符规则

在路由中可以指定多个参数，这些参数遵循以下占位符规则：

  • : 基本占位符，用于匹配任意字符串，但不能匹配路径分隔符
  • *: 匹配任何内容，包括路径分隔符
  • (*) 匹配以指定字符结尾的路径
  • (?:) 非捕获匹配，匹配不再捕获分组中的内容
  • +、?、{}：匹配长度，+ 表示必须有一个或多个，? 表示可选，{} 表示指定长度

三、路由匹配顺序

在使用多个路由处理器时，路由的匹配顺序将决定哪一个处理器会被执行。

1. 路由的添加顺序

Express.Router的路由匹配顺序是按照它们被添加的顺序进行的。因此，如果你先添加一个无参数的路由处理器，然后再添加一个与之匹配但却包含了参数的处理器，那么前一个处理器将始终被执行。例如：

router.get('/', function(req, res) {
  res.send('Root');
});
router.get('/:name', function(req, res) {
  res.send('Hello, ' + req.params.name);
});

在这里，如果访问根路径，那么将执行第一个路由处理器；如果访问/user，那么将执行第二个处理器。

2. 静态路由优先

匹配静态路由要优先于动态路由。例如：

router.get('/user/:id', function(req, res) {
  res.send('User ID: ' + req.params.id);
});
router.get('/user/profile', function(req, res) {
  res.send('User Profile');
});

在这里，如果访问/user/profile路径，将会匹配到第二个静态路由处理器，而不是第一个动态路由处理器。

四、路由处理器中间件

除了可以通过use()方法来添加中间件之外，我们还可以通过分别挂载中间件到路由处理器上来对特定路由进行处理。

1. 基本用法

通过在路由处理器上挂载中间件，这个中间件将仅应用于该路由。下面是一个简单的示例：

router.get('/user/:id', function(req, res, next) {
  const UserType = getUserType(req.params.id);
  req.userType = UserType;
  next();
}, function(req, res) {
  res.send('User Type: ' + req.userType);
});

在这里，我们在第一个处理器的函数中设置了req.userType的值，并将请求转到下一个处理器。

2. 使用多个中间件

我们还可以使用多个中间件，类似于在主应用程序中使用多个中间件。下面是一个示例：

router.get('/user/:id',function(req,res,next){
  const UserType = getUserType(req.params.id);
  req.userType = UserType;
  next();
},
function(req,res,next){
  const token = getToken(req);
  if(token){
    req.token = token;
    next();
  } else {
    res.status(401).send('Unauthorized');
  }
},
function(req,res){
  res.send('User Type: ' + req.userType + ' Token: ' + req.token);
});

在这里，我们使用了3个中间件，第一个中间件将req.userType设置为一个值，第二个中间件将req.token设置为值或抛出错误，第三个中间件将数据发送回客户端。

五、总结

Express.Router是一个非常便利的中间件容器，可以将路由处理器分组，更加优雅、灵活地处理路由。在本文中，我们介绍了基本的使用方法，动态路由，路由匹配顺序和路由处理器中间件。希望这篇文章对你了解Express.Router提供了帮助。

推荐文章