迁移到 Express 4

概述

Express 4 相较于 Express 3 是一项重大变更。这意味着，如果您更新了现有 Express 3 应用中的 Express 版本，它将无法正常工作。

本文涵盖了

• Express 4 中的变更.
• 将 Express 3 应用迁移到 Express 4 的示例。
• 升级到 Express 4 应用生成器.

Express 4 中的变更

Express 4 中有几个重大变更

• Express 核心和中间件系统的变更。 Connect 和内置中间件的依赖已被移除，因此您必须自行添加中间件。
• 路由系统的变更。
• 其他各种变更。

另请参阅

• 4.x 中的新功能。
• 从 3.x 迁移到 4.x。

Express 核心和中间件系统的变更

Express 4 不再依赖于 Connect，并从其核心中移除了所有内置中间件，除了 express.static 函数。这意味着 Express 现在是一个独立的路由和中间件 Web 框架，Express 的版本控制和发布不受中间件更新的影响。

没有内置中间件，您必须明确添加运行您的应用程序所需的所有中间件。只需遵循以下步骤

1. 安装模块：npm install --save <module-name>
2. 在您的应用中，导入模块：require('module-name')
3. 根据其文档使用模块：app.use( ... )

下表列出了 Express 3 中间件及其在 Express 4 中的对应项。

这是 Express 4 中间件的完整列表。

在大多数情况下，您只需将旧的 v3 中间件替换为 Express 4 的对应项。有关详细信息，请参阅 GitHub 中的模块文档。

app.use 接受参数

在版本 4 中，您可以使用变量参数来定义加载中间件函数的路径，然后从路由处理程序中读取参数的值。例如

app.use('/book/:id', (req, res, next) => {
  console.log('ID:', req.params.id)
  next()
})

路由系统

应用现在隐式加载路由中间件，因此您不再需要担心中间件相对于 router 中间件的加载顺序。

定义路由的方式没有改变，但路由系统有两个新功能可以帮助组织您的路由

• 一个新方法，app.route()，用于为路由路径创建可链式调用的路由处理程序。
• 一个新类，express.Router，用于创建模块化可挂载的路由处理程序。

app.route() 方法

新的 app.route() 方法使您能够为路由路径创建可链式调用的路由处理程序。由于路径在单个位置指定，这有助于创建模块化路由，并减少冗余和拼写错误。有关路由的更多信息，请参阅Router() 文档。

这是一个使用 app.route() 函数定义的链式路由处理程序的示例。

app.route('/book')
  .get((req, res) => {
    res.send('Get a random book')
  })
  .post((req, res) => {
    res.send('Add a book')
  })
  .put((req, res) => {
    res.send('Update the book')
  })

express.Router 类

另一个有助于组织路由的特性是一个新类，express.Router，您可以使用它来创建模块化的可挂载路由处理程序。Router 实例是一个完整的中间件和路由系统；因此它通常被称为“迷你应用”。

以下示例将路由器创建为模块，在其中加载中间件，定义一些路由，并将其挂载到主应用程序的路径上。

例如，在应用目录中创建一个名为 birds.js 的路由文件，内容如下

var express = require('express')
var router = express.Router()

// middleware specific to this router
router.use((req, res, next) => {
  console.log('Time: ', Date.now())
  next()
})
// define the home page route
router.get('/', (req, res) => {
  res.send('Birds home page')
})
// define the about route
router.get('/about', (req, res) => {
  res.send('About birds')
})

module.exports = router

然后，在应用中加载路由器模块

var birds = require('./birds')

// ...

app.use('/birds', birds)

现在，该应用将能够处理对 /birds 和 /birds/about 路径的请求，并会调用特定于该路由的 timeLog 中间件。

其他变更

下表列出了 Express 4 中其他一些细小但重要的变更

示例应用迁移

这是一个将 Express 3 应用程序迁移到 Express 4 的示例。相关文件是 app.js 和 package.json。

版本 3 应用

app.js

考虑一个 Express v.3 应用程序，其 app.js 文件如下

var express = require('express')
var routes = require('./routes')
var user = require('./routes/user')
var http = require('http')
var path = require('path')

var app = express()

// all environments
app.set('port', process.env.PORT || 3000)
app.set('views', path.join(__dirname, 'views'))
app.set('view engine', 'pug')
app.use(express.favicon())
app.use(express.logger('dev'))
app.use(express.methodOverride())
app.use(express.session({ secret: 'your secret here' }))
app.use(express.bodyParser())
app.use(app.router)
app.use(express.static(path.join(__dirname, 'public')))

// development only
if (app.get('env') === 'development') {
  app.use(express.errorHandler())
}

app.get('/', routes.index)
app.get('/users', user.list)

http.createServer(app).listen(app.get('port'), () => {
  console.log('Express server listening on port ' + app.get('port'))
})

package.json

随附的版本 3 package.json 文件可能看起来像这样

{
  "name": "application-name",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "start": "node app.js"
  },
  "dependencies": {
    "express": "3.12.0",
    "pug": "*"
  }
}

过程

通过安装 Express 4 应用程序所需的中间件并使用以下命令将 Express 和 Pug 更新到各自的最新版本来开始迁移过程

$ npm install serve-favicon morgan method-override express-session body-parser multer errorhandler express@latest pug@latest --save

对 app.js 进行以下更改

1. 内置的 Express 中间件函数 express.favicon、express.logger、express.methodOverride、express.session、express.bodyParser 和 express.errorHandler 不再在 express 对象上可用。您必须手动安装它们的替代品并在应用程序中加载它们。

2. 您不再需要加载 app.router 函数。它不是一个有效的 Express 4 应用对象，因此请删除 app.use(app.router); 代码。

3. 确保中间件函数按正确的顺序加载——在加载应用程序路由之后加载 errorHandler。

版本 4 应用

package.json

运行上述 npm 命令将如下更新 package.json

{
  "name": "application-name",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "start": "node app.js"
  },
  "dependencies": {
    "body-parser": "^1.5.2",
    "errorhandler": "^1.1.1",
    "express": "^4.8.0",
    "express-session": "^1.7.2",
    "pug": "^2.0.0",
    "method-override": "^2.1.2",
    "morgan": "^1.2.2",
    "multer": "^0.1.3",
    "serve-favicon": "^2.0.1"
  }
}

app.js

然后，删除无效代码，加载所需的中间件，并进行其他必要的更改。app.js 文件将如下所示

var http = require('http')
var express = require('express')
var routes = require('./routes')
var user = require('./routes/user')
var path = require('path')

var favicon = require('serve-favicon')
var logger = require('morgan')
var methodOverride = require('method-override')
var session = require('express-session')
var bodyParser = require('body-parser')
var multer = require('multer')
var errorHandler = require('errorhandler')

var app = express()

// all environments
app.set('port', process.env.PORT || 3000)
app.set('views', path.join(__dirname, 'views'))
app.set('view engine', 'pug')
app.use(favicon(path.join(__dirname, '/public/favicon.ico')))
app.use(logger('dev'))
app.use(methodOverride())
app.use(session({
  resave: true,
  saveUninitialized: true,
  secret: 'uwotm8'
}))
app.use(bodyParser.json())
app.use(bodyParser.urlencoded({ extended: true }))
app.use(multer())
app.use(express.static(path.join(__dirname, 'public')))

app.get('/', routes.index)
app.get('/users', user.list)

// error handling middleware should be loaded after the loading the routes
if (app.get('env') === 'development') {
  app.use(errorHandler())
}

var server = http.createServer(app)
server.listen(app.get('port'), () => {
  console.log('Express server listening on port ' + app.get('port'))
})

app.listen(app.get('port'), () => {
  console.log('Express server listening on port ' + app.get('port'))
})

运行应用

迁移过程已完成，该应用现在是 Express 4 应用。要确认，请使用以下命令启动该应用

$ node .

加载 http://localhost:3000，查看 Express 4 渲染的主页。

升级到 Express 4 应用生成器

用于生成 Express 应用的命令行工具仍然是 express，但要升级到新版本，您必须卸载 Express 3 应用生成器，然后安装新的 express-generator。

安装

如果您的系统上已经安装了 Express 3 应用生成器，您必须将其卸载

$ npm uninstall -g express

根据您的文件和目录权限配置方式，您可能需要使用 sudo 运行此命令。

现在安装新的生成器

$ npm install -g express-generator

根据您的文件和目录权限配置方式，您可能需要使用 sudo 运行此命令。

现在，您系统上的 express 命令已更新为 Express 4 生成器。

应用生成器的变更

命令选项和用法大体保持不变，但有以下例外情况

• 移除了 --sessions 选项。
• 移除了 --jshtml 选项。
• 添加了 --hogan 选项以支持 Hogan.js。

示例

执行以下命令以创建 Express 4 应用程序

$ express app4

如果您查看 app4/app.js 文件的内容，您会注意到应用程序所需的所有中间件函数（除了 express.static）都作为独立模块加载，并且 router 中间件不再在应用程序中显式加载。

您还会注意到，app.js 文件现在是一个 Node.js 模块，与旧生成器生成的独立应用形成对比。

安装依赖项后，使用以下命令启动应用程序

$ npm start

如果您查看 package.json 文件中的 npm start 脚本，您会注意到启动应用程序的实际命令是 node ./bin/www，而在 Express 3 中是 node app.js。

由于 Express 4 生成器生成的 app.js 文件现在是一个 Node.js 模块，它不能再作为应用程序独立启动（除非您修改代码）。该模块必须加载到 Node.js 文件中，并通过 Node.js 文件启动。在这种情况下，Node.js 文件是 ./bin/www。

bin 目录和无扩展名的 www 文件对于创建 Express 应用程序或启动应用程序都不是强制性的。它们只是生成器提出的建议，因此请随意修改以满足您的需求。

为了摆脱 www 目录并保持“Express 3 风格”，请删除 app.js 文件末尾的 module.exports = app; 行，然后粘贴以下代码代替它

app.set('port', process.env.PORT || 3000)

var server = app.listen(app.get('port'), () => {
  debug('Express server listening on port ' + server.address().port)
})

确保使用以下代码在 app.js 文件的顶部加载 debug 模块

var debug = require('debug')('app4')

接下来，将 package.json 文件中的 "start": "node ./bin/www" 更改为 "start": "node app.js"。

您现在已将 ./bin/www 的功能移回 app.js。不建议进行此更改，但此练习有助于您理解 ./bin/www 文件的工作原理，以及为什么 app.js 文件不再自行启动。