[TOC] > 中间件（Middleware） 是一个函数，它可以访问请求对象（request object (req)）, 响应对象（response object (res)）, 和 web 应用中处于请求-响应循环流程中的中间件，一般被命名为 next 的变量。 ## 中间件的功能 * 执行任何代码。 * 修改请求和响应对象。 * 终结请求-响应循环。 * 调用堆栈中的下一个中间件。 * 如果当前中间件没有终结请求-响应循环，则必须调用 next() 方法将控制权交给下一个中间件，否则请求就会挂起。 ## 中间件的类型 * 应用级中间件 * 路由级中间件 * 错误处理中间件 * 内置中间件 * 第三方中间件 ### 应用级中间件 应用级中间件绑定到 app 对象 使用 app.use() 和 app.METHOD()， 其中， METHOD 是需要处理的 HTTP 请求的方法，例如 GET, PUT, POST 等等，全部小写。 ~~~ var app = express(); // 没有挂载路径的中间件，应用的每个请求都会执行该中间件 app.use(function (req, res, next) { console.log('Time:', Date.now()); next(); }); // 挂载至 /user/:id 的中间件，任何指向 /user/:id 的请求都会执行它 app.use('/user/:id', function (req, res, next) { console.log('Request Type:', req.method); next(); }); // 路由和句柄函数(中间件系统)，处理指向 /user/:id 的 GET 请求 app.get('/user/:id', function (req, res, next) { res.send('USER'); }); ~~~ 作为中间件系统的路由句柄，使得为路径定义多个路由成为可能。在下面的例子中，为指向 /user/:id 的 GET 请求定义了两个路由。第二个路由虽然不会带来任何问题，但却永远不会被调用，因为第一个路由已经终止了请求-响应循环。 ~~~ // 一个中间件栈，处理指向 /user/:id 的 GET 请求 app.get('/user/:id', function (req, res, next) { console.log('ID:', req.params.id); next(); }, function (req, res, next) { res.send('User Info'); }); // 处理 /user/:id， 打印出用户 id app.get('/user/:id', function (req, res, next) { res.end(req.params.id); }); ~~~ 如果需要在中间件栈中跳过剩余中间件，调用 **next('route')** 方法将控制权交给下一个路由。 注意： next('route') 只对使用** app.VERB()** 或 **router.VERB()** 加载的中间件有效。 ~~~ // 一个中间件栈，处理指向 /user/:id 的 GET 请求 app.get('/user/:id', function (req, res, next) { // 如果 user id 为 0, 跳到下一个路由 if (req.params.id == 0) next('route'); // 否则将控制权交给栈中下一个中间件 else next(); // }, function (req, res, next) { // 渲染常规页面 res.render('regular'); }); // 处理 /user/:id， 渲染一个特殊页面 app.get('/user/:id', function (req, res, next) { res.render('special'); }); ~~~ ### 路由级中间件 路由级中间件和应用级中间件一样，只是它绑定的对象为 express.Router()。 路由级使用 router.use() 或 router.VERB() 加载。 ~~~ var app = express(); var router = express.Router(); // 没有挂载路径的中间件，通过该路由的每个请求都会执行该中间件 router.use(function (req, res, next) { console.log('Time:', Date.now()); next(); }); // 一个中间件栈，显示任何指向 /user/:id 的 HTTP 请求的信息 router.use('/user/:id', function(req, res, next) { console.log('Request URL:', req.originalUrl); next(); }, function (req, res, next) { console.log('Request Type:', req.method); next(); }); // 一个中间件栈，处理指向 /user/:id 的 GET 请求 router.get('/user/:id', function (req, res, next) { // 如果 user id 为 0, 跳到下一个路由 if (req.params.id == 0) next('route'); // 负责将控制权交给栈中下一个中间件 else next(); // }, function (req, res, next) { // 渲染常规页面 res.render('regular'); }); // 处理 /user/:id， 渲染一个特殊页面 router.get('/user/:id', function (req, res, next) { console.log(req.params.id); res.render('special'); }); // 将路由挂载至应用 app.use('/', router); ~~~ ### 错误处理中间件 > 错误处理中间件有 **4** 个参数，定义错误处理中间件时必须使用这 4 个参数。即使不需要 next 对象，也必须在签名中声明它，否则中间件会被识别为一个常规中间件，不能处理错误。 > 中间件返回的响应是随意的，可以响应一个 HTML 错误页面、一句简单的话、一个 JSON 字符串，或者其他任何您想要的东西。 为了便于组织（更高级的框架），您可能会像定义常规中间件一样，定义多个错误处理中间件。比如您想为使用 XHR 的请求定义一个，还想为没有使用的定义一个，那么： ~~~ var bodyParser = require('body-parser'); var methodOverride = require('method-override'); app.use(bodyParser()); app.use(methodOverride()); app.use(logErrors); app.use(clientErrorHandler); app.use(errorHandler); ~~~ logErrors 将请求和错误信息写入标准错误输出、日志或类似服务： ~~~ function logErrors(err, req, res, next) { console.error(err.stack); next(err); } ~~~ clientErrorHandler 的定义如下（注意这里将错误直接传给了 next）： ~~~ function clientErrorHandler(err, req, res, next) { if (req.xhr) { res.status(500).send({ error: 'Something blew up!' }); } else { next(err); } } ~~~ errorHandler 能捕获所有错误，其定义如下： ~~~ function errorHandler(err, req, res, next) { res.status(500); res.render('error', { error: err }); } ~~~ 如果**向 next() 传入参数（除了 ‘route’ 字符串）**，Express 会认为当前请求有错误的输出，因此跳过后续其他非错误处理和路由/中间件函数。如果需做特殊处理，需要创建新的错误处理路由。 如果路由句柄有多个回调函数，可使用 ‘route’ 参数跳到下一个路由句柄。比如： ~~~ app.get('/a_route_behind_paywall', function checkIfPaidSubscriber(req, res, next) { if(!req.user.hasPaid) { // 继续处理该请求 next('route'); } }, function getPaidContent(req, res, next) { PaidContent.find(function(err, doc) { if(err) return next(err); res.json(doc); }); }); app.get('/a_route_behind_paywall', function(err, req, res, next) { console.error(err.stack); res.status(500).send('Something broke!'); } ) ~~~ **缺省错误处理句柄** Express 内置了一个错误处理句柄，它可以捕获应用中可能出现的任意错误。这个缺省的错误处理中间件将被添加到中间件堆栈的底部。 如果你向 next() 传递了一个 error ，而你并没有在错误处理句柄中处理这个 error，Express 内置的缺省错误处理句柄就是最后兜底的。最后错误将被连同堆栈追踪信息一同反馈到客户端。堆栈追踪信息并不会在生产环境中反馈到客户端。 > 设置环境变量 NODE_ENV 为 “production” 就可以让应用运行在生产环境模式下。 如果你已经开始向 response 输出数据了，这时才调用 next() 并传递了一个 error，比如你在将向客户端输出数据流时遇到一个错误，Express 内置的缺省错误处理句柄将帮你关闭连接并告知 request 请求失败。 因此，当你添加了一个自定义的错误处理句柄后，如果已经向客户端发送包头信息了，你还可以将错误处理交给 Express 内置的错误处理机制。 ~~~ function errorHandler(err, req, res, next) { if (res.headersSent) { return next(err); } res.status(500); res.render('error', { error: err }); } ~~~ ## 内置中间件 express.static(root, [options]) express.static 是 Express 唯一内置的中间件。它基于 serve-static，负责在 Express 应用中提托管静态资源。 参数 root 指提供静态资源的根目录。 可选的 options 参数拥有如下属性。 属性 | 描述 | 类型 | 缺省值 | | --- | --- | --- | --- | dotfiles | 是否对外输出文件名以点（.）开头的文件。可选值为 “allow”、“deny” 和 “ignore” | String | “ignore” etag | 是否启用 etag 生成 | Boolean | true extensions | 设置文件扩展名备份选项 | Array | [] index | 发送目录索引文件，设置为 false 禁用目录索引。 | Mixed |“index.html” lastModified | 设置 Last-Modified 头为文件在操作系统上的最后修改日期。可能值为 true 或 false。 | Boolean | true maxAge | 以毫秒或者其字符串格式设置 Cache-Control 头的 max-age 属性。 | Number | 0 redirect | 当路径为目录时，重定向至 “/”。 | Boolean | true setHeaders | 设置 HTTP 头以提供文件的函数。 | Function | ~~~ var options = { dotfiles: 'ignore', etag: false, extensions: ['htm', 'html'], index: false, maxAge: '1d', redirect: false, setHeaders: function (res, path, stat) { res.set('x-timestamp', Date.now()); } } app.use(express.static('public', options)); ~~~ 每个应用可有多个静态目录。 ~~~ app.use(express.static('public')); app.use(express.static('uploads')); app.use(express.static('files')); ~~~ ## 第三方中间件 安装所需功能的 node 模块，并在应用中加载，可以在应用级加载，也可以在路由级加载。 ~~~ $ npm install cookie-parser var express = require('express'); var app = express(); var cookieParser = require('cookie-parser'); // 加载用于解析 cookie 的中间件 app.use(cookieParser()); ~~~