Express源码解析之next

Posted sanxiandoupi

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Express源码解析之next相关的知识，希望对你有一定的参考价值。

最近公司在使用node做前后端分离，采用的web框架是express，所以对express框架进行了深入的了解，前段时间写了篇关于express路由的文章，但是在那篇文章中貌似少了一个很重要的内容，就是express的next，所以今天单独来说说express的next。

关于next主要从三点来进行说明：

  1. next的作用是什么？
  2. 我们应该在何时使用next？
  3. next的内部实现机制是什么？

Next的作用

我们在定义express中间件函数的时候都会将第三个参数定义为next，这个next就是我们今天的主角，next函数主要负责将控制权交给下一个中间件，如果当前中间件没有终结请求，并且next没有被调用，那么请求将被挂起，后边定义的中间件将得不到被执行的机会。

何时使用Next

从上边的描述我们已经知道，next函数主要是用来确保所有注册的中间件被一个接一个的执行，那么我们就应该在所有的中间件中调用next函数，但有一个特例，如果我们定义的中间件终结了本次请求，那就不应该再调用next函数，否则就可能会出问题，我们来看段代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
app.get('/a', function(req, res, next) {
    res.send('sucess');
    next();
});

// catch 404 and forward to error handler
app.use(function(req, res, next) {
  console.log(404);
  var err = new Error('Not Found');
  err.status = 404;
  next(err);
});

app.use(function(err, req, res, next) {
  res.status(err.status || 500);
  res.render('error', {
    message: err.message,
    error: {}
  });
});

发送请求”/a”，控制台打印日志如下：

1
2
3
4
404
GET /a 500 6.837 ms - -
Error: Can't set headers after they are sent.
    at ServerResponse.OutgoingMessage.setHeader (_http_outgoing.js:345:11)

为什么代码会抛异常呢，就是因为我们在res.send之后调用了next函数，虽然我们本次的请求已经被终止，但后边的404中间件依旧会被执行，而后边的中间件试图去向res的headers中添加属性值，所以就会抛出上边的异常。

读到这你可能会有个疑问，如果我不在res.send后边调用next函数，那后边定义的404中间件是不是永远都不会被执行到。现在我们删除res.send后边next函数调用，发送请求”/xxx”，我们就会发现404中间件被执行了，(ㄒoㄒ)，这不是和我们之前说的矛盾了吗，我们的自定义中间件没有调用next，但后边定义的中间件仍旧被执行了，这究竟是为什么呢。看来只能求助源码了~~~

Next的内部机制

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
function next(err) {
    ... //此处源码省略
    // find next matching layer
    var layer;
    var match;
    var route;

    while (match !== true && idx < stack.length) {
      layer = stack[idx++];
      match = matchLayer(layer, path);
      route = layer.route;

      if (typeof match !== 'boolean') {
        // hold on to layerError
        layerError = layerError || match;
      }

      if (match !== true) {
        continue;
      }
      ... //此处源码省略
    }
	... //此处源码省略
    // this should be done for the layer
    if (err) {
        layer.handle_error(err, req, res, next);
    } else {
	    layer.handle_request(req, res, next);
    }
  }

上边就是express中next的源码，为了更容易说明问题，对代码进行了删减。从上边的源码可以发现，next函数内部有个while循环，每次循环都会从stack中拿出一个layer，这个layer中包含了路由和中间件信息，然后就会用layer和请求的path就行匹配，如果匹配成功就会执行layer.handle_request，调用中间件函数。但如果匹配失败，就会循环下一个layer（即中间件）。

现在我们就能解释上边提出的问题了，为什么我们的自定义中间件中没调用next函数，但后边的404中间件仍旧会被执行到，因为我们请求的”/xxx”匹配不到我们注册的”/a”路由中间件，所以while循环会继续往下执行，匹配404中间件成功，所以会执行404中间件。

注意：app.use注册的中间件，如果path参数为空，则默认为”/“，而path为”/“的中间件默认匹配所有的请求。

有一点需要特别指出，其实我们在定义路由中间件的时候函数的第三个参数next和我们定义非路由中间件的函数的第三个参数next不是同一个next，我们在上边看到的是非路由中间件的next，而路由中间件的next函数是这样的

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
function next(err) {
    if (err && err === 'route') {
      return done();
    }

    var layer = stack[idx++];
    if (!layer) {
      return done(err);
    }

    if (layer.method && layer.method !== method) {
      return next(err);
    }

    if (err) {
      layer.handle_error(err, req, res, next);
    } else {
      layer.handle_request(req, res, next);
    }
  }

这个next比上边的那个next要简单很多，它负责同一个路由的多个中间件的控制权的传递，并且它会接收一个参数”route”，如果调用next(“route”)，则会跳过当前路由的其它中间件，直接将控制权交给下一个路由。

最后有必要再说一说next(err)，next(err)是如何将控制权传递到错误处理中间件的，从前边的代码我们知道，当调用next(err)是，express内部会调用layer.handle_error，那我们来看看它的源码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Layer.prototype.handle_error = function handle_error(error, req, res, next) {
  var fn = this.handle;

  if (fn.length !== 4) {
    // not a standard error handler
    return next(error);
  }

  try {
    fn(error, req, res, next);
  } catch (err) {
    next(err);
  }
};

代码中的fn就是中间件函数，express会对fn的参数个数进行判断，如果参数个数不等于4则认为不是错误处理中间件，则继续调用next(err)，这样就会进入到下一个中间件函数，继续进行参数个数判断，如此方式一直到某个中间件函数的参数个数是4，就认为找到了错误处理中间件，然后执行此中间件函数。

原文:大专栏  Express源码解析之next


以上是关于Express源码解析之next的主要内容，如果未能解决你的问题，请参考以下文章

Vue3源码解析之createApp方法

redux教程之源码解析3applyMiddleware（分析在注释中）

express源码分析之Router

Express实战 - 应用案例- realworld-API - 路由设计 - mongoose - 数据验证 - 密码加密 - 登录接口 - 身份认证 - token - 增删改查API(代码片段

node.js系列 9 express框架核心用法以及源码

koa-connect源码解析