Node.js笔记总结(day4)（二）

3. 使用 Express 写接口

3.1 创建基本的服务器

const express = require("express");
const app = express();
app.listen(80, () => {
  console.log("Express server is running at http://127.0.0.1");
});

3.2 创建 API 路由模块

// apiRouter.js 路由模块
const express = require("express");
const router = express.Router();
// 在这里挂载路由
module.exports = router;
-----------------------------
// app.js 导入并注册路由模块
// 导入路由模块
const router = require("./16-apiRouter");
// 注册路由模块
app.use("/api", router);

3.3 编写 GET 接口

router.get("/get", (req, res) => {
  // 获取客户端发送的数据
  const query = req.query;
  // 响应回客户端
  res.send({
    status: 0,
    message: "GET请求成功！",
    data: query,
  });
});

3.4 编写 POST 接口

router.post("/post", (req, res) => {
  const body = req.body;
  res.send({
    status: 0,            // 状态，0 表示成功，1 表示失败
    message: "POST请求成功！", // 状态描述信息 
    data: body,          // 需要响应给客户端的具体数据
  });
});

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

3.5 CORS 跨域资源共享

接口的跨域问题

刚才编写的 GET 和 POST接口，存在一个很严重的问题:不支持跨域请求。 解决接口跨域问题的方案主要有两种：

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

2、JSONP（有缺陷的解决方案:只支持 GET 请求）

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

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

使用步骤分为如下 3 步：

1、运行 npm install cors 安装中间件

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

3、在路由之前调用 app.use(cors()) 配置中间件

// 一定要在路由之前配置 cors 中间件，从而解决接口跨域问题
const cors = require("cors");
app.use(cors());

什么是 CORS

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

同源安全策略默认阻止“跨域”获取资源。但是 CORS 给了 web 服务器这样的权限，即服务器可以选择，允许跨域请求访问到它们的资源。

CORS 的注意事项

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

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

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

• 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 对额外 的请求头进行声明，否则这次请求会失败!

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

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

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

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

示例代码如下：

// 只允许 POST、 GET、DELETE、HEAD 请求方法
res. setHeader('Access-Control-A1low-Methods', " POST, GET, DELETE, HEAD’ ）
// 允许所有的 HTTP 请求方法
res. setHeader("Access-Control-A1low-Methods"， '*')

简单请求

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

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

2、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）

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

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

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

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

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

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

预检请求的特点：OPTION 预检请求成功之后，才会发起真正的请求。

• 简单请求和预检请求区别
  简单请求特点：客户端与服务器之间只会发生一次请求。
  预检请求的特点：客户端与服务器之间会发生两次请求，OPTION 预检请求成功后，才会发出真正的请求。
  

3.6 JSONP 接口

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

特点：

1、JSONP 不属于真正的 ajax 请求，因为它并没有使用 XMLHttpRequset 这个对象。

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

• 创建 JSONP 接口的注意事项

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

// 必须在 cors 中间件之前，配置 jsonp 的接口
app.get("/api/jsonp", (req, res) => {
  // 定义 jsonp 接口的具体实现过程
});

实现 JSONP 接口的步骤

• 获取客户端发送过来的回调函数的名字
• 得到要通过 JSONP 形式发送给客户端的数据

• 根据前两步得到的数据，拼接出一个函数调用的字符串
• 把上一步拼接得到的字符串，响应给客户端的 <script> 标签进行解析执行

• 实现 JSONP 接口的具体代码
  

// 必须在 cors 中间件之前，配置 jsonp 的接口
app.get("/api/jsonp", (req, res) => {
  // 定义 jsonp 接口的具体实现过程
  // + 获取客户端发送过来的回调函数的名字
  const funcName = req.query.callback;
  // + 得到要通过 JSONP 形式发送给客户端的数据
  const data = { name: "zs", age: 20 };
  // + 根据前两步得到的数据，拼接出一个函数调用的字符串
  const scriptStr = `${funcName}(${JSON.stringify(data)})`;
  // + 把上一步拼接得到的字符串，响应给客户端的 `<script>` 标签进行解析执行
  res.send(scriptStr);
});

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

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

 // 4、测试JSONP接口
$("#btnJSONP").on("click", function () {
  $.ajax({
    type: "GET",
    url: "http://127.0.0.1/api/jsonp",
    dataType: "jsonp",
    success: function (res) {
      console.log(res);
    },
  });
});