Express

官网传送门

基于 Node.js 平台，快速、开放、极简的 Web 开发框架

Express 的作用和Node.js内置的http模块类似，是用于快速创建Web服务器的第三方模块。

Express的作用：

对于前端程序员来说，最常见的两种服务器，分别是：

  • Web 网站服务器：专门对外提供 Web 网页资源的服务器。

  • API 接口服务器：专门对外提供 API 接口的服务器。

使用 Express，我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。

Express 初体验

基本使用

安装 Express：

1
npm install express

创建服务器，监听客户端请求，并返回内容：

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
const express = require('express')
// 创建 web 服务器
const app = express()

// 监听客户端的 GET 和 POST 请求，并向客户端响应具体的内容
app.get('/user', (req, res) => {
  res.send({ name: 'zs', age: 20, gender: '男' })
})
app.post('/user', (req, res) => {
  res.send('请求成功')
})

app.get('/', (req, res) => {
  // 通过 req.query 可以获取到客户端发送过来的查询参数，例如?name=zs&age=20
  console.log(req.query)
  res.send(req.query)
})

// 这里的 :id 是一个动态的参数
app.get('/user/:ids/:username', (req, res) => {
  // req.params 是动态匹配到的 URL 参数，默认是一个空对象
  console.log(req.params)
  res.send(req.params)
})

app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

托管静态资源

  • 通过 express.static() 方法可创建静态资源服务器，向外开放访问静态资源。
  • Express 在指定的静态目录中查找文件，并对外提供资源的访问路径，存放静态文件的目录名不会出现在 URL 中
  • 访问静态资源时，会根据托管顺序查找文件
  • 可为静态资源访问路径添加前缀
1
2
3
4
5
6
7
8
9
10
11
12
13
app.use(express.static('public')) // 现在，你就可以访问public目录下的所有文件了
app.use(express.static('files'))  // 托管多个静态资源目录，请多次调用
app.use('/bruce', express.static('bruce')) // 挂载路径前缀

/*
可直接访问 public, files 目录下的静态资源
http://localhost:3000/images/bg.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/login.js

通过带有 /bruce 前缀的地址访问 bruce 目录下的文件
http://localhost:8080/bruce/images/logo.png
*/

nodemon

为什么要使用nodemon？

在编写调试 Node.js 项目的时候，如果修改了项目的代码，则需要频繁的手动 close 掉，然后再重新启动，非常繁琐。现在，我们可以使用 nodemon这个工具，它能够监听项目文件的变动，当代码被修改后，nodemon 会自动帮我们重启项目，极大方便了开发和调试。

安装nodemon

1
npm install -g nodemon

使用nodemon

  • 当基于 Node.js 编写了一个网站应用的时候，传统的方式，是运行 node app.js 命令，来启动项目。这样做的坏处是：代码被修改之后，需要手动重启项目。

  • 现在，我们可以将 node 命令替换为 nodemon 命令，使用 nodemon app.js 来启动项目。这样做的好处是：代码被修改之后，会被 nodemon 监听到，从而实现自动重启项目的效果。

1
2
# node app.js
nodemon app.js

Express 路由

什么是路由

广义上来讲，路由就是映射关系。

Express中的路由

在 Express 中，路由指的是客户端的请求与服务器处理函数之间的映射关系。

Express 中的路由分 3 部分组成，分别是请求的类型、请求的 URL 地址、处理函数，格式如下：

image-20220906134425528

Express中的路由的例子

image-20220906134446465

路由的匹配过程

每当一个请求到达服务器之后，需要先经过路由的匹配，只有匹配成功之后，才会调用对应的处理函数。

在匹配时，会按照路由的顺序进行匹配，如果请求类型和请求的 URL 同时匹配成功，则 Express 会将这次请求，转交给对应的 function 函数进行处理。

image-20220906134540314

路由匹配的注意点：

① 按照定义的先后顺序进行匹配

② 请求类型和请求的URL同时匹配成功，才会调用对应的处理函数

路由的使用

**最简单的用法：**在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上。

1
app.get('/',(req,res) => {res.send('Hello World.')})
模块化路由

为了方便对路由进行模块化的管理，Express 不建议将路由直接挂载到 app 上，而是推荐将路由抽离为单独的模块。

将路由抽离为单独模块的步骤如下：

① 创建路由模块对应的 .js 文件

② 调用 express.Router() 函数创建路由对象

③ 向路由对象上挂载具体的路由

④ 使用 module.exports 向外共享路由对象

⑤ 使用 app.use() 函数注册路由模块

创建路由模块：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// 导入router.js
const express = require('express')
// 创建路由对象
const router = express.Router()

// 挂载获取用户列表的路由
router.get('/user/list', (req, res) => {
  res.send('Get user list.')
})
// 挂载添加用户的路由
router.post('/user/add', (req, res) => {
  res.send('Add new user.')
})

// 向外导出路由对象
module.exports = router

注册路由模块：

1
2
3
4
5
6
7
8
9
10
11
const express = require('express')
const router = require('./router')

const app = express()

// 注册路由模块，添加访问前缀 // app.use() 函数的作用，就是来注册全局中间件
app.use('/api', router)

app.listen(80, () => {
  console.log('http://127.0.0.1')
})

Express 中间件

  • 中间件（Middleware）是指业务流程的中间处理环节
  • 当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理。

image-20220906135857522

  • 中间件本质是一个funciton处理函数，Express中间件的格式如下：

image-20220906135933713

注意：中间件函数的形参列表中，必须包含 next 参数。而路由处理函数中只包含 req 和 res。

  • next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由。

image-20220906140849659

中间件注意事项；

① 一定要在路由之前注册中间件

② 客户端发送过来的请求，可以连续调用多个中间件进行处理

③ 执行完中间件的业务代码之后，不要忘记调用 next() 函数

④ 为了防止代码逻辑混乱，调用 next() 函数后不要再写额外的代码

连续调用多个中间件时，多个中间件之间，共享 req 和 res 对象

中间件的作用

多个中间件之间，共享同一份 req 和 res。基于这样的特性，我们可以在上游的中间件中，统一为 req 或 res 对象添加自定义的属性或方法，供下游的中间件或路由进行使用。

image-20220906141435373

定义中间件函数

image-20220906141051034

全局中间件

  • 客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件。
  • 通过调用 app.use()(中间件函数)，即可定义一个全局生效的中间件。
  • 可以使用 app.use() 连续定义多个全局中间件。客户端请求到达服务器之后，会按照中间件定义的先后顺序依次进行调用。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
const express = require('express')
const app = express()

// 定义第一个全局中间件
app.use((req, res, next) => {
  console.log('调用了第1个全局中间件')
  next()
})
// 定义第二个全局中间件
app.use((req, res, next) => {
  console.log('调用了第2个全局中间件')
  next()
})

app.get('/user', (req, res) => {
  res.send('User page.')
})

app.listen(80, () => {
  console.log('http://127.0.0.1')
})

局部中间件

  • 不使用 app.use() 定义的中间件，叫做局部生效的中间件。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
const express = require('express')
const app = express()

// 定义中间件函数
const mw1 = (req, res, next) => {
  console.log('调用了第一个局部生效的中间件')
  next()
}

const mw2 = (req, res, next) => {
  console.log('调用了第二个局部生效的中间件')
  next()
}

// 两种定义多个局部中间件的方式
// mw1,mw2只在“当前路由中生效”，这种用法属于“局部生效的中间件”
app.get('/hello', mw2, mw1, (req, res) => res.send('hello page.'))
app.get('/about', [mw1, mw2], (req, res) => res.send('about page.'))
// mw1,mw2不会影响下面这个路由
app.get('/user', (req, res) => res.send('User page.'))

app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})

中间件分类

Express 官方把常见的中间件用法，分成了 5 大类，分别是：

① 应用级别的中间件

② 路由级别的中间件

③ 错误级别的中间件

④ Express 内置的中间件

⑤ 第三方的中间件

详细信息：

  1. 应用级别的中间件：通过 app.use() 或 app.get() 或 app.post() ，绑定到 app 实例上的中间件。

    image-20220906142716941

  2. 路由级别的中间件：绑定到 express.Router() 实例上的中间件，叫做路由级别的中间件。用法和应用级别中间件没有区别，应用级别中间件是绑定到 app 实例上，路由级别中间件绑定到 router 实例上。

1
2
3
4
5
6
7
8
9
const app = express()
const router = express.Router()

router.use(function (req, res, next) {
  console.log(1)
  next()
})

app.use('/', router)
  1. 错误级别的中间件
  • 作用：用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。
  • 格式：错误级别中间件的处理函数中，必须有 4 个形参，形参顺序从前到后分别是 (err, req, res, next) 。
  • 注意：错误级别的中间件必须注册在所有路由之后。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
const express = require('express')
const app = express()

app.get('/', (req, res) => {
  throw new Error('服务器内部发生了错误！')
  res.send('Home page.')
})

// 定义错误级别的中间件，捕获整个项目的异常错误，从而防止程序的崩溃
app.use((err, req, res, next) => {
  console.log('发生了错误！' + err.message)
  res.send('Error：' + err.message)
})

app.listen(80, function () {
  console.log('Express server running at http://127.0.0.1')
})
  1. Express 内置中间件

自 Express 4.16.0 版本开始，Express 内置了 3 个常用的中间件，极大的提高了 Express 项目的开发效率和体验：

  • express.static 快速托管静态资源的内置中间件，例如： HTML 文件、图片、CSS 样式等（无兼容性）
  • express.json 解析 JSON 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
  • express.urlencoded 解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
1
2
3
4
// 配置解析application/json格式数据的内置中间件
app.use(express.json())
// 配置解析application/x-www-form-urlencoded格式数据的内置中间件
app.use(express.urlencoded({ extended: false }))
  1. 第三方中间件

非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。

例如：在 express@4.16.0 之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。

使用步骤如下：

① 运行 npm install body-parser 安装中间件

② 使用 require 导入中间件

③ 调用 app.use() 注册并使用中间件

注意：

Express 内置的 express.urlencoded 中间件，就是基于 body-parser 这个第三方中间件进一步封装出来的。

自定义中间件

  1. 需求描述与实现步骤

    手动模拟一个类似于 express.urlencoded 这样的中间件，来解析 POST 提交到服务器的表单数据。

    实现步骤：

    ① 定义中间件

    ② 监听 req 的 data 事件

    ③ 监听 req 的 end 事件

    ④ 使用 querystring 模块解析请求体数据

    ⑤ 将解析出来的数据对象挂载为 req.body

    ⑥ 将自定义中间件封装为模块

  2. 定义中间件

    使用 app.use() 来定义全局生效的中间件，代码如下：

image-20220906150421909

  1. 监听 req 的 data 事件

    在中间件中，需要监听 req 对象的 data 事件，来获取客户端发送到服务器的数据。

    如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以 data 事件可能会触发多次，每一次触发 data 事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。

    image-20220906150519601

  2. 监听req的end事件

    当请求体数据接收完毕之后，会自动触发 req 的 end 事件。

    因此，我们可以在 req 的 end 事件中，拿到并处理完整的请求体数据。示例代码如下：

    image-20220906150650805

  3. 使用querystring模块解析请求体数据

    Node.js 内置了一个 querystring 模块，专门用来处理查询字符串。通过这个模块提供的 parse() 函数，可以轻松把查询字符串，解析成对象的格式。示例代码如下：

    image-20220906150744982

  4. 将解析出来的数据对象挂载为 req.body

    上游的中间件和下游的中间件及路由之间，共享同一份 req 和 res。因此，我们可以将解析出来的数据，挂载为 req 的自定义属性，命名为 req.body，供下游使用。示例代码如下：

    image-20220906151130422

  5. 将自定义中间件封装为模块

    为了优化代码的结构，我们可以把自定义的中间件函数，封装为独立的模块，示例代码如下：

    image-20220906151206420

使用Express写接口

  1. 创建基本的服务器

    image-20220906153054509

  2. 创建API路由模块

    image-20220906153128520

  3. 编写GET接口

    image-20220906153215106

  4. 编写POST接口

    **注意：**如果要获取 URL-encoded 格式的请求体数据，必须配置中间件

    app.use(express.urlencoded({ extended: false }))

    image-20220906153244806

CORS 跨域资源共享

接口的跨域问题

解决接口跨域问题的方案主要有两种：

① CORS（主流的解决方案，推荐使用）

② JSONP（有缺陷的解决方案：只支持 GET 请求）

cors 中间件解决跨域

  • 安装中间件：npm install cors
  • 导入中间件：const cors = require('cors')
  • 配置中间件：app.use(cors())

CORS

  • CORS（Cross-Origin Resource Sharing，跨域资源共享）由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源。

  • 浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头，就可解除浏览器端的跨域访问限制。

    image-20220906154410181image-20220906154426471

    注意事项：

  • CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。

  • CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。

CORS 常见响应头

  1. Access-Control-Allow-Origin：制定了允许访问资源的外域 URL。

    1
    2
    3
    4
    //只允许来自 http://itcast.cn 的请求
    res.setHeader('Access-Control-Allow-Origin', 'http://bruceblog.io') 
    // 允许来自任何域的请求
    res.setHeader('Access-Control-Allow-Origin', '*')

  2. Access-Control-Allow-Headers

  • 默认情况下，CORS 仅支持客户端向服务器发送如下的 9 个请求头：Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type （值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一）

  • 如果客户端向服务器发送了额外的请求头信息，则需要在服务器端，通过 Access-Control-Allow-Headers 对额外的请求头进行声明，否则这次请求会失败！

    1
    res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')
  1. Access-Control-Allow-Methods

  • 默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求。如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Alow-Methods 来指明实际请求所允许使用的 HTTP 方法。

    1
    2
    res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')
    res.setHEader('Access-Control-Allow-Methods', '*')

CORS 请求分类

简单请求

  • 请求方式：GET、POST、HEAD 三者之一
  • HTTP 头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type（只有三个值 application/x-www-formurlencoded、multipart/form-data、text/plain）

预检请求

  • 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
  • 请求头中包含自定义头部字段
  • 向服务器发送了 application/json 格式的数据

在浏览器与服务器正式通信之前，浏览器会先发送 OPTION 请求进行预检，以获知服务器是否允许该实际请求，所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后，才会发送真正的请求，并且携带真实数据。

简单请求和预检请求的区别

简单请求的特点：客户端与服务器之间只会发生一次请求。

预检请求的特点：客户端与服务器之间会发生两次请求，OPTION 预检请求成功之后，才会发起真正的请求。

JSONP接口

概念：浏览器端通过 <script> 标签的 src 属性，请求服务器上的数据，同时，服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP。

特点：

① JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象。

② JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求。

创建JSONP接口的注意事项

如果项目中已经配置了 CORS 跨域资源共享，为了防止冲突，必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下：

image-20220906160915000

实现JSONP接口

步骤：

① 获取客户端发送过来的回调函数的名字

② 得到要通过 JSONP 形式发送给客户端的数据

③ 根据前两步得到的数据，拼接出一个函数调用的字符串

④ 把上一步拼接得到的字符串，响应给客户端的 <script> 标签进行解析执行

具体代码：

image-20220906162211835

在网页中使用jQuary发起JSONP请求

调用 $.ajax() 函数，提供 JSONP 的配置选项，从而发起 JSONP 请求，示例代码如下：

image-20220906162322481