Node入门系列-Express 框架的使用 — 编写接口（6）

1. 创建 API 路由模块

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

// 在这里挂载对应的路由

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

2. 创建基本的服务器，并导入、注册路由

// 1. 导入 express
const express = require('express')

// 2. 创建 express 服务器实例
const app = express()

// 配置解析表单数据的中间件
app.use(express.urlencoded({extended: false}))

// 导入路由模块
const router = require('./apiRouter.js')
// 把路由模块，注册到 app 上，并添加访问前缀 /api
app.use('/api', router)

// 3. 启动服务器，调用 app.listen(端口号，启动成功后的回调函数)
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1');
})

3. 编写 GET 接口

说明：访问路径为 /api/get，返回的数据为用户的查询参数

// apiRouter.js【路由模块】
router.get('/get', (req, res) => {
  // 通过 req.query 获取客户端通过查询字符串，发送到服务器的数据
  const query = req.query
  // 调用 res.send() 方法，向客户端响应处理的结果
  res.send({
    status: 201,            // 201代表处理成功，404代表处理失败
    msg: 'GET 请求成功！',   // 状态的描述
    data: query             // 需要响应给客户端的数据
  })
})

4. 编写 POST 接口

说明：访问路径为 /api/post，返回的数据为用户的请求体数据

// apiRouter.js【路由模块】
router.post('/post', (req, res) => {
  // 通过 req.body 获取请求体重包含的 url-encoded 格式的数据
  const body = req.body
  // 调用 res.send() 方法，像客户端响应结果
  res.send({
    status: 201,
    msg: 'POST 请求成功！',
    data: body
  })
})

4. 接口的跨域问题

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

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

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

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

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

使用步骤分为如下 3 步：

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

const express = require('express')
const app = express()

// 配置解析表单数据的中间件
app.use(express.urlencoded({extended: false}))

/*** 配置 cors 这个中间件，从而解决接口跨域的问题 ***/
const cors = require('cors')
app.use(cors())

// 导入路由模块
const router = require('./18.apiRouter.js')
// 把路由模块，注册到 app 上
app.use('/api', router)

// 启动服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1');
})

6. 什么是 CORS

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

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

什么是cors.jpg

7. CORS 的注意事项

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

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

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

'Access-Control-Allow-Origin': <origin> | *

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

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

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

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

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

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

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

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

示例代码如下：

// 只允许 POST、GET、DELETE、HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET,   DELETE, HEAD')

// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods', '*')

10. CORS 请求的分类

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

简单请求
预检请求

10.1 简单请求

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

请求方式：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）

10.2 预检请求

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

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

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

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

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

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

每文一句：情况是在不断的变化，要使自己的思想适应新的情况，就得学习。