Express学习笔记（三）——使用 Express 写接口

目录

1. 创建基本的服务器

2. 创建 API 路由模块

3. 编写 GET 接口

4. 编写 POST 接口

5. CORS 跨域资源共享

5.1 接口的跨域问题

5.2 使用 cors 中间件解决跨域问题

5.3 什么是 CORS

5.4 CORS 的注意事项

5.5 CORS 响应头部 - Access-Control-Allow-Origin

5.6 CORS 响应头部 - Access-Control-Allow-Headers

5.7 CORS 响应头部 - Access-Control-Allow-Methods

5.8 CORS请求的分类

5.9 简单请求

5.10 预检请求

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

6. JSONP 接口

6.1 回顾 JSONP 的概念与特点

6.2 创建 JSONP 接口的注意事项

6.3 实现 JSONP 接口的步骤

6.4 实现 JSONP 接口的具体代码

6.5 在网页中使用 jQuery 发起 JSONP 请求

---

1. 创建基本的服务器

2. 创建 API 路由模块

3. 编写 GET 接口

4. 编写 POST 接口

注意：

• 如果要获取 URL-encoded 格式的请求体数据，必须配置中间件 app.use(express.urlencoded({ extended: false }))

5. CORS 跨域资源共享

5.1 接口的跨域问题

刚才编写的 GET 和 POST接口，存在一个很严重的问题： 不支持跨域请求 。

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

• ① CORS（主流的解决方案，推荐使用）
• ② JSONP（有缺陷的解决方案：只支持 GET 请求）

5.2 使用 cors 中间件解决跨域问题

cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件，可以很方便地解决跨域问题。

使用步骤分为如下 3 步：

• ① 运行 npm install cors 安装中间件
• ② 使用 const cors = require('cors') 导入中间件
• ③ 在路由之前调用 app.use(cors()) 配置中间件

router.js模块：

// 路由模块
const express = require('express')
const apiRouter = express.Router()// 在这里挂载对应的路由
// 定义 get 接口
apiRouter.get('/get', (req, res) => {// 通过 req.query 获取客户端通过查询字符串，发送到服务器的数据const query = req.query// 调用 res.send() 方法，向客户端响应处理的结果res.send({status: 0, // 0 表示处理成功，1 表示处理失败msg: 'GET请求成功', //状态的描述data: query // 需要响应给客户端的数据})
})// 定义 post 接口
apiRouter.post('/post', (req, res) => {// 1. 通过 req.body 获取请求体中包含的 url-encoded 格式的数据const body = req.body// 2. 调用 res.send() 方法，向客户端响应结果res.send({status: 0,msg: 'POST请求成功',data: body})
})// 定义 DELETE 接口
apiRouter.delete('/delete', (req, res) => {res.send({status: 0,msg: 'DELETE请求成功'})
})// 导出路由
module.exports = apiRouter

app.js模块：

// 导入 express 模块
const express = require('express')
// 导入路由
const apiRouter = require('./21-router.js')// 创建 express 服务器实例
const app = express()// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))// 一定要在路由之前，配置 cors 这个中间件，从而解决接口跨域问题
const cors = require('cors')
app.use(cors())// 注册路由
app.use('/api', apiRouter)// 调用 app.listen() 方法，指定端口号并且启动服务器
app.listen(80, () => {console.log('express server is running at http://127.0.0.1')
})

5.3 什么是 CORS

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

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

5.4 CORS 的注意事项

• ① CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。
• ② CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。

5.5 CORS 响应头部 - Access-Control-Allow-Origin

响应头部中可以携带一个 Access-Control-Allow-Origin 字段，其语法如下:

其中，origin 参数的值指定了 允许访问该资源的外域 URL 。

例如，下面的字段值将 只允许 来自 http://itcast.cn 的请求：

如果指定了 Access-Control-Allow-Origin 字段的值为 通配符 * ，表示允许来自任何域的请求，示例代码如下：

5.6 CORS 响应头部 - 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 对额外的请求头进行声明 ，否则这次请求会失败！

5.7 CORS 响应头部 - Access-Control-Allow-Methods

默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD 请求。

如果客户端希望通过 PUT 、 DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Alow-Methods 来 指明实际请求所允许使用的 HTTP 方法 。

示例代码如下：

5.8 CORS请求的分类

客户端在请求 CORS 接口时，根据 请求方式 和 请求头 的不同，可以将 CORS 的请求分为 两大类 ，分别是：

• ① 简单请求
• ② 预检请求

5.9 简单请求

同时满足以下两大条件的请求，就属于简单请求：

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

5.10 预检请求

只要符合以下任何一个条件的请求，都需要进行预检请求：

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

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

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

简单请求的特点 ：

• 客户端与服务器之间只会发生一次请求。

预检请求的特点 ：

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

6. JSONP 接口

6.1 回顾 JSONP 的概念与特点

概念 ：

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

特点 ：

• ① JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象。
• ② JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求。

6.2 创建 JSONP 接口的注意事项

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

6.3 实现 JSONP 接口的步骤

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

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

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

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

6.4 实现 JSONP 接口的具体代码

6.5 在网页中使用 jQuery 发起 JSONP 请求

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