node.js学习笔记4 使用express写接口、接口跨域问题、CORS、JSONP接口

---

1. 使用expresss写接口

1.1 创建基本的服务器

// 导入express
const express = require('express')
// 创建服务器实例
const app = express()

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

1.2 创建api路由模块

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

// 在这里挂载对应的路由
// ...
module.exports = apiRouter

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

1.3 编写GET接口

apiRouter.get('/get',(req,res) => {
  // 获取客户端通过查询字符串发送到服务器的数据
  const query = req.query
  // 将数据响应给客户端
  res.send({
    status: 0,  // 0表示成功，1表示失败
    msg: 'GET请求成功',
    data: query // 需要响应给客户端的具体数据
  })
})

1.4 编写POST接口

apiRouter.post('/post',(req,res) => {
  // 获取客户端通过请求体 发送到服务器的URL-encoded数据
  const body = req.body
  // 将数据响应给客户端
  res.send({
    status: 0,  // 0表示成功，1表示失败
    msg: 'POST请求成功',
    data: body  // 需要响应给客户端的具体数据
  })
})

---

2. 接口的跨域问题

刚才编写的GET和POST接口，存在一个很严重的问题：不支持跨域请求
我们新建一个html页面，书写发送ajax请求的代码，在控制台会报如下错误：

因为我们是以file协议打开这个页面的，但是请求的接口是http协议的，协议不同导致了跨域问题
解决接口跨域问题的方案主要有两种：

• CORS（主流的解决方案）
• JSONP（有缺陷的解决方案：只支持GET请求）

---

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

cors是express的一个第三方中间件，通过安装和配置cors中间件，可以很方便地解决跨域问题
使用步骤：
1.npm install cors安装中间件
2.const cors = require('cors')导入中间件
3.在路由前调用app.use(cors())配置中间件

---

4. CORS

CORS(跨域资源共享)由一系列HTTP响应头组成，这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源
浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头，就可以解除浏览器端的跨域访问限制

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

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

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

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

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

其中origin参数的值指定了允许访问该资源的外域URL
例如，下面的字段值将只允许来自http://www.baidu.com的请求：

res.setHeader('Access-Control-Allow-Origin','http://www.baidu.com')

如果指定了Access-Control-Allow-Origin字段的值为通配符*，表示允许来自任何域的请求，代码如下：
下面这行代码跟上面配置cors中间件之后的效果是一样的

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

---

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

默认情况下，CORS仅支持客户端向服务器发送的如下的9个请求头：
Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type
如果客户端向服务器发送了额外的请求头信息，则需要在服务器端，通过Access-Control-Allow-Headers对额外的请求头进行声明，否则这次请求会失败！

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

---

4.3 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','*')

---

5. CORS请求的分类

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

• 简单请求
• 预检请求

5.1 简单请求

同时满足以下两大条件：

1. 请求方式：GET、POST、HEAD三者之一
2. HTTP头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type

5.2 预检请求

符合以下任何一个条件的请求，都属于预检请求

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

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

简单请求和预检请求的区别在于：
简单请求：客户端与服务器之间只会发生一次请求
预检请求：客户端与服务器之间会发生两次请求

---

6. JSONP 接口

6.1 JSONP的概念

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

6.2 JSONP的特点

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

6.3 创建JSONP接口的注意事项

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

// 优先创建 JSONP 接口（这个接口不会被处理成CORS接口）
app.get('/api/jsonp',(req,res) => {})

// 再配置CORS中间件（后续的所有接口都会被处理成CORS接口）
app.use(cors())

// 这是一个开启了CORS的接口
app.get('/api/get',(req,res) => {})

6.4 实现JSONP接口的步骤

1.获取客户端发送来的回调函数的名字
2.得到要通过JSONP形式发送给客户端的数据
3.根据前2步得到的数据，拼接出一个函数调用的字符串
4.把上一步拼接得到的字符串，响应给客户端的<script>标签进行解析执行

app.get('/api/jsonp',(req,res) => {
  // 1.获取客户端发送来的回调函数的名字
  const funcName = req.query.callback
  // 2.得到要通过JSONP形式发送给客户端的数据
  const data = { name: 'AIpoem', age: 20}
  // 3.拼接出一个函数调用的字符串
  const scriptStr = `${funcName}(${JSON.stringify(data)})`
  // 4.把上一步拼接得到的字符串，响应给客户端的<script>标签进行解析执行
  res.send(scriptStr)
})

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

$('#btnJSONP').on('click', function () {
  $.ajax({
    method: 'GET',
    url: 'http://127.0.0.1/api/jsonp',
    dataType: 'jsonp', // 表示要发起JSONP请求
    success: function (res) {
      console.log(res);
    }
  })
})

---

完