Node.js基础---使用Express写接口

1. 创建基本的服务器

2. 创建 API 路由模块

// aoiRouter.js 路由模块
const express = require('express')
const apiRouter = express.Router()


module.exports = apiRouter

// ------------------------------------------

// app.js 导入并注册路由模块
const apiRouter = require('./apiRouter.js')
app.use('/api', apiRouter)

3. 编写 GET 接口

apiRouter.get('/get', (req, res) => {
    // 获取客户端通过查询字符串发送到服务器的数据
    const query = req.query
    //  调用 res.send() 方法 把数据响应给客户端
    res.send({
        status: 0, //  0成功 1失败
        message: 'success',
        data: query    // 响应的具体数据
    })
})

4. 编写 POST 请求

apiRouter.post('/post', (req, res) => {
    // 获取客户端通过查询字符串发送到服务器的数据
    const body= req.body
    //  调用 res.send() 方法 把数据响应给客户端
    res.send({
        status: 0, //  0成功 1失败
        message: 'success',
        data: body// 响应的具体数据
    })
})

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

5. CORS 跨域资源共享

1. 接口的跨域问题

上面的 get 和 post 请求都不支持跨域请求

解决方法两种：

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

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

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

cors 是 Express 的第三方中间件

使用步骤：

① 运行 npm i cors 安装中间件

② 使用 const cors = require(‘cors’)导入中间件

③ 在路由前调用 app.use(cors())

3. 什么是 cors

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

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

4. CORS 的注意事项

① CORS 主要在服务端进行配置。客户端浏览器无需额外配置即可请求开启CORS的接口

② CORS 在浏览器有兼容性，只有支持 XML HttpRequest Level2 的浏览器才能正常访问开启了 CORS 的服务端接口(例如：IE10+、Chrome4+、FireFox3.5+)

5. CORS 响应头部 - Access-Control-Allow-Origin

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

Access-Control-Allow-Origin: <origon> | *

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

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

res.setHeader('Access-Control-Allow-Origin', 'http://abcde.cn')

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

res.setHeader('Access-Control-Allow-Origin', '*')

6. CORS 响应头部 - Access-Control-Allow-Headers

默认情况下、CORS 仅支持客户端向服务器发送如下的9个请求头

Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-type

Content-type（值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一）

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

// 允许客户端额外向服务器发送 Content-Type 请求头和 X-Custom-Header 请求头
// 注意: 多个请求头之间用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers','Content-Type, X-Custom-Header')

7. CORS 响应头部 - Access-Control-Allow-Methods

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

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

// 只允许 POST、GET、DELETE、HEAD 请求方式
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')
// 允许所有的 HTTP 请求方式
res.setHeader('Access-Control-Allow-Methods', '*')

8. CORS 请求的分类

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

① 简单请求

② 预检请求

9. 简单请求

同时满足以下两大条件的就是简单请求

① 请求方式：GET、POST、HEAD 三者之一

② HTTP头部信息不超过一下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-type（值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一）

10. 预检请求

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

① 请求方式为GET、POST、HEAD 之外的请求 Method 类型

② 请求头中包含自定义头部字段

③ 向服务器发送了 application/json 格式的数据

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

11. 简单请求与预检请求的区别

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

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

秒客网