Express.js 基础

安装
路由
- app.method()
- Router
构建 URL
- 模式匹配的路由
中间件
模板
- 安装
- 给模板传递数值
静态文件
- 多个静态目录
- 虚拟路径前缀
表单数据
数据库
Cookie
Session
认证
RESTful API
脚手架
错误处理
调试
最佳实践
REF

Fast, unopinionated, minimalist web framework for node.

最简代码如下：

var express = require('express')
var app = express()

app.get('/', function(req, res) {
    res.send('Hello world!')
})

app.listen(3000)

截止到 2018 年 5 月 7 日，最新版本是 v4.16.0。

安装

$ npm install express --save

还可以安装 nodemon，它能自动监听源文件，一旦改动就可以重启服务器，特别适合开发阶段。

$ node install -g nodemon

然后，使用 nodemon 代替 node 启动应用即可。

路由

以下方法用来在 Express 中定义路由。

app.method()

函数签名如下：

app.method(path, handler)

其中的 METHOD 可以是任意一个 HTTP 动词，比如 get, set, put, delete 等。

可以在一个路由上定义多个不同的动词，比如：

var express = require('express')
var app = express()

app.get('/hello', function(req, res){
   res.send("Hello World!")
})

app.post('/hello', function(req, res){
   res.send("You just called the post method at '/hello'!\n")
})

app.listen(3000)

可以使用如下命令监测 POST 请求的返回值：

# 注意 POST 必须大写
$ curl -X POST "http://localhost:3000/hello"

除此之外，还有特殊方法 all()，将所有 HTTP 动作映射到同一个 handler 函数。比如：

app.all('/test', function(req, res){
   res.send("HTTP method doesn't have any effect on this route!")
})

该方法通常用于定义中间件。

Router

上面方法定义的路由难以维护。为了将路由配置从主文件分离，可以使用 Express.Router。创建新文件 things.js，输入代码：

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

router.get('/', function(req, res){
   res.send('GET route on things.')
})

router.post('/', function(req, res){
   res.send('POST route on things.')
})

// export this router to use in our index.js
module.exports = router

然后在主文件 index.js 引用，在 app.listen() 之前使用路由：

var express = require('Express')
var app = express()

var things = require('./things.js')

// both index.js and things.js should be in same directory
app.use('/things', things)

app.listen(3000)

app.use() 方法会把 /things/ 的路由处理逻辑转交给 things.js。things.js 定义的根路由 / 其实相当于 /things 的子路由。

可以验证一下输出：

$ curl http://localhost:3000/things
$ curl -X POST http://localhost:3000/things

Router 可以有效分离关注点，将相关实体的接口放置到一起。

构建 URL

我们可以使用动态路由传递参数。只需要在参数名称之前增加 : 即可。

var express = require('express')
var app = express()

app.get('/:id', function(req, res){
   res.send('The id you specified is ' + req.params.id)
})
app.listen(3000)

下面是一个更复杂的例子：

var express = require('express')
var app = express()

app.get('/things/:name/:id', function(req, res) {
   res.send('id: ' + req.params.id + ' and name: ' + req.params.name)
})
app.listen(3000)

使用 req.params 可以从 URL 中获取所有的动态参数。

模式匹配的路由

可以使用正则表达式限制 URL 参数范围。比如，id 需要设定为 5 个长度的数字。可以如此定义：

var express = require('express')
var app = express()

app.get('/things/:id([0-9]{5})', function(req, res){
   res.send('id: ' + req.params.id)
})

app.listen(3000)

如果路由没有匹配，会得到响应信息 "Cannot GET <your-request-route>"。这个报错信息可以使用 * 通配符路由代替：

var express = require('express')
var app = express()

// Other routes here
app.get('*', function(req, res){
   res.send('Sorry, this is an invalid URL.')
})

app.listen(3000)

⚠️ 注意，通配符 * 路由需要放置在其他所有路由之后，因为 Express 匹配路由的顺序是从前往后，如果将其放在前面，会拦截其后的路由。

中间件

中间件函数指的是可以访问请求对象（req）、响应对象（res）和下一个中间件函数（常用 next 表示）的一类函数。

中间件函数可以执行任务：

运行任意代码
修改请求和响应对象
结束请求-响应循环
调用函数栈的下一个中间件函数

如果当前中间件函数没有终结请求-响应循环，它必须调用 next() 将控制权移交下一个中间件函数。否则，请求将被闲置。

Express 应用可以使用如下类型的中间件函数：

应用级别中间件
路由级别中间件
错误处理中间件
内置中间件
第三方中间件

应用级别中间件

可以通过 app.use() 或 app.METHOD() 函数，将应用级别中间件绑定至某一 app 实例，其中的 METHOD 指的是 HTTP 请求方法（比如 GET、PUT 或 POST）的小写形式。

比如，如下中间件函数会在每个请求到来时执行：

var app = express()

app.use(function (req, res, next) {
  console.log('Time:', Date.now())
  next()
})

以下的中间件函数绑定在 /user/:id 路径上。任意请求方法都可以触发该中间件函数：

app.use('/user/:id', function (req, res, next) {
  console.log('Request Type:', req.method)
  next()
})

以下代码显示了路由和相应的处理函数（中间件系统）：

app.get('/user/:id', function (req, res, next) {
  res.send('USER')
})

以下代码显示了在某一个路由上加载一系列中间件函数。

app.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 请求。第二个路由不会触发任何错误，但永远不会被执行，因为第一个路由中断了请求-响应循环。

app.get('/user/:id', function (req, res, next) {
  console.log('ID:', req.params.id)
  next()
}, function (req, res, next) {
  res.send('User Info')
})

// handler for the /user/:id path, which prints the user ID
app.get('/user/:id', function (req, res, next) {
  res.end(req.params.id)
})

为了跳过中间件栈剩余的中间件函数，可以调用 next('route') 将控制权转交给下一个路由。⚠️ 注意，next('route') 只适用于 app.METHOD() 或 router.METHOD() 加载的中间件函数。

app.get('/user/:id', function (req, res, next) {
  // if the user ID is 0, skip to the next route
  if (req.params.id === '0') next('route')
  // otherwise pass the control to the next middleware function in this stack
  else next()
}, function (req, res, next) {
  // render a regular page
  res.render('regular')
})

// handler for the /user/:id path, which renders a special page
app.get('/user/:id', function (req, res, next) {
  res.render('special')
})

路由级别中间件

路由级别中间件同应用级别类似，所不同的是，它绑定到 express.Router() 实例上。

var router = express.Router()

通过 router.use() 和 router.METHOD() 函数加载路由级别中间件。

以下代码复制了应用级别中间件的中间件系统，使用了路由中间件：

var app = express()
var router = express.Router()

// a middleware function with no mount path. This code is executed for every request to the router
router.use(function (req, res, next) {
  console.log('Time:', Date.now())
  next()
})

// a middleware sub-stack shows request info for any type of HTTP request to the /user/:id path
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()
})

// a middleware sub-stack that handles GET requests to the /user/:id path
router.get('/user/:id', function (req, res, next) {
  // if the user ID is 0, skip to the next router
  if (req.params.id === '0') next('route')
  // otherwise pass control to the next middleware function in this stack
  else next()
}, function (req, res, next) {
  // render a regular page
  res.render('regular')
})

// handler for the /user/:id path, which renders a special page
router.get('/user/:id', function (req, res, next) {
  console.log(req.params.id)
  res.render('special')
})

// mount the router on the app
app.use('/', router)

如果要跳过 router 实例的所有剩余中间件函数，可以通过调用 next('router') 将控制权移出 router。

下面例子展示了可以处理 /user/:id 路径 GET 请求的中间件子栈（sub-stack）。

var app = express()
var router = express.Router()

// predicate the router with a check and bail out when needed
router.use(function (req, res, next) {
  if (!req.headers['x-auth']) return next('router')
  next()
})

router.get('/', function (req, res) {
  res.send('hello, user!')
})

// use the router and 401 anything falling through
app.use('/admin', router, function (req, res) {
  res.sendStatus(401)
})

错误处理中间件

错误处理中间件总是会包含 4 个参数。你必须提供 4 个参数，才可以被认定为错误处理中间件。即使你不需要 next 对象，也必须提供以便维持正确的函数签名。否则，next 对象将被当作普通中间件函数对待，从而无法成功处理错误。

定义错误处理中间件函数和其他中间件函数类似，只是变成了 4 个形参。比如：

app.use(function (err, req, res, next) {
  console.error(err.stack)
  res.status(500).send('Something broke!')
})

内置中间件

从 4.x 版本开始，Express 不再依赖 Connect。之前包含在 Express 内的中间件函数现在抽离为独立模块。

Express 目前拥有如下内置中间件函数：

express.static 产生 HTML 文件，图像等静态文件
express.json 解析带有 JSON 负载的请求。注意，4.16.0+ 有效
express.urlencoded 解析带有 URL 编码的负载请求。注意：4.16.0+ 有效

第三方中间件

使用第三方中间件可以为 Express 应用扩展功能。常用的中间件列表见此。

以下代码演示如何安装和加载 cookie-parser：

$ npm install cookie-parser

var express = require('express')
var app = express()
var cookieParser = require('cookie-parser')

// load the cookie-parsing middleware
app.use(cookieParser())

body-parser 使用方法如下：

var bodyParser = require('body-parser')

// To parse URL encoded data
app.use(bodyParser.urlencoded({ extended: false }))

// To parse json data
app.use(bodyParser.json())

中间件执行顺序

中间件的执行顺序很重要，它和代码书写位置以及路由匹配情况相关。

比如，下面的例子展示了如何在路由前和路由后使用中间件。同时，路由处理函数本身也可以作为中间件：

var express = require('express')
var app = express()

// First middleware before response is sent
app.use(function(req, res, next){
   console.log("Start")
   next()
})

// Route handler
app.get('/', function(req, res, next){
   res.send("Middle")
   next()
})

app.use('/', function(req, res){
   console.log('End')
})

app.listen(3000)

模板

Pug 是 Express 的一个模版引擎。它的功能强大，特性包括过滤器、包含、继承、插值等。

安装

$ npm install --save pug

Pug 安装完成，就可以将它设定为应用的模板引擎。无需 require 它，只需将如下代码加入到 index.js 文件：

app.set('view engine', 'pug')
app.set('views','./views')

创建文件夹 views/，在其中创建文件 first_view.pug，输入如下数据：

doctype html
html
    head
        title = "Hello Pug"
    body
        p.greetings#people Hello World!

为了运行该页面，需要增加如下路由：

app.get('/first_template', function(req, res){
   res.render('first_view')
})

如上代码会转换为：

<!DOCTYPE html>
<html>
  <head>
    <title>Hello Pug</title>
  </head>
  
  <body>
    <p class="greetings" id="people">Hello World!</p>
  </body>
</html>

给模板传递数值

当渲染 pug 模板时，可以从路由处理函数中向模板传递数值。比如：

var express = require('express')
var app = express()

app.get('/dynamic_view', function(req, res){
  res.render('dynamic', {
    name: "TutorialsPoint", 
    url:"http://www.tutorialspoint.com"
  })
})

app.listen(3000)

然后在 views/ 目录创建文件 dynamic.pug。代码如下：

html
  head
    title = name
  body
    h1=name
    a(href = url) URL

静态文件

创建 public/ 目录。Express 默认不支持静态文件，需要使用如下代码开启：

app.use(express.static('public'))

多个静态目录

使用如下代码可以开启多个静态资源目录。

var express = require('express')
var app = express()

app.use(express.static('public'))
app.use(express.static('images'))

app.listen(3000)

虚拟路径前缀

可以为静态文件增加路径前缀。假如你要提供一个类似 /static 的路径前缀，需要在 index.js 中包含如下代码：

var express = require('express')
var app = express()

app.use('/static', express.static('public'))

app.listen(3000)

现在，如果你要访问 public/ 目录下的 main.js 文件，可以使用如下标签：

<script src = "/static/main.js" />

表单数据

表单是网络的重要组成部分。为了使用表单，需要安装 body-parser（用于解析 JSON 和 url-encoded 数据）和 multer（用于解析 multipart/form 数据）中间件。

首先安装 body-parser 和 multer：

$ npm install --save body-parser multer

将 index.js 替换为如下代码：

var express = require('express')
var bodyParser = require('body-parser')
var multer = require('multer')

var upload = multer()
var app = express()

app.get('/', function(req, res){
  res.render('form')
})

app.set('view engine', 'pug')
app.set('views', './views')

// for parsing application/json
app.use(bodyParser.json()) 
// for parsing application/x-www-form-urlencoded
app.use(bodyParser.urlencoded({ extended: true }))
// for parsing multipart/form-data
app.use(upload.array())

app.use(express.static('public'))

app.post('/', function(req, res){
  console.log(req.body)
  res.send('recieved your request!')
})

app.listen(3000)

创建文件 form.pug：

doctype html
html
  head
    title Form Tester
  body
    form(action = "/", method = "POST")
      div
        label(for = "say") Say:
        input(name = "say" value = "Hi")
      br
      div
        label(for = "to") To:
        input(name = "to" value = "Express forms")
      br
      button(type = "submit") Send my greetings

req.body 包含所有的请求数据。

数据库

服务端接收到数据，下一步是用数据库将其持久保存。在此我们使用一种 NoSQL 数据库 MongoDB。

TODO：MongoDB 详细操作

Cookie 是一种服务端设置的小型数据文件，可以储存到客户端。它可以用来保持状态管理、个性化设置和跟踪用户等。

为了在 Express 中使用 cookie，我们需要安装 cookie-parser 中间件。使用如下代码安装：

$ npm install --save cookie-parser

然后，就可以在 index.js 中引入：

var cookieParser = require('cookie-parser')
app.use(cookieParser())

cookie-parser 可以解析请求头中的 Cookie 字段，并将其作为 req.cookies 属性储存。

为了设置新的 cookie，我们可以定义一个新路由：

var express = require('express')
var app = express()

app.get('/', function(req, res){
  res.cookie('name', 'express').send('cookie set')
})

app.listen(3000)

为了验证 cookie 是否设置成功，可以打开浏览器，然后在开发者工具中输入：

document.cookie

TODO

Session

TODO

认证

TODO

RESTful API

TODO

脚手架

TODO

错误处理

TODO

调试

TODO

最佳实践

TODO

Express.js 基础

安装

路由

app.method()

Router

构建 URL

模式匹配的路由

中间件

应用级别中间件

路由级别中间件

错误处理中间件

内置中间件

第三方中间件

中间件执行顺序

模板

安装

给模板传递数值

静态文件

多个静态目录

虚拟路径前缀

表单数据

数据库

Cookie

Session

认证

RESTful API

脚手架

错误处理

调试

最佳实践

REF