使用 Express 写接口

1. 使用 Express 写接口

1.实例

// express.js
const express = require('express')
const app = express()
const port = 80;
// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }));

const apiRouter = require('./14apiRouter');
// 把路由模块,注册到 app 上
app.use('/api', apiRouter);


app.listen(port, () => console.log(`Example app listening on port port!`))
// apiRouter.js

const express = require('express')
const router = express.Router();

// 这里挂载对应的路由
router.get('/get', (req, res) => {
    // 通过 req.query 获取客户端通过查询字符串,发送到服务器的数据
    const query = req.query;
    // 调用 res.send() 方法,向客户端响应处理的结果
    res.send({
        status: 0, // 0 表示处理成功。 1 表示处理失败
        msg: 'GET 请求成功!', // 状态的描述
        data: query, // 需要响应给客户端的数据
    });
});

// 定义 post 接口
router.post('/post', (req, res) => {
    // 通过 req.body() 获取请求体中的 url-encoded 格式的数据
    const body = req.body;
    // 调用 res.send() 方法,向客户端响应结果
    res.send({
        status: 0,
        msg: 'POST 请求成功!',
        data: body,
    });
});

module.exports = router;

1.2 CORS 跨域资源共享

1. 接口的跨域问题

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

在这里插入图片描述

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

① CORS(主流的解决方案,推荐使用)

② JSONP(有缺陷的解决方案:只支持 GET 请求)

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

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

使用步骤分为如下 3 步:

①运行 npm install cors 安装中间件

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

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

// 13express.js
const express = require('express')
const app = express()
const port = 80;
// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }));

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

const apiRouter = require('./14apiRouter');
// 把路由模块,注册到 app 上
app.use('/api', apiRouter);


app.listen(port, () => console.log(`Example app listening on port port!`))

在这里插入图片描述

3. 什么是 CORS

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

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

在这里插入图片描述

4. CORS 的注意事项

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

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

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

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

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

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

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

res.setHeader('Access-Control-Allow-Origin','http://duanxiaoxiao.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 (值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一)
如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 Access-Control-Allow-Headers额外的请求头进行声明,否则这次请求会失败!

// 注意:多个请求头之间使用英文逗号进行分割
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-Alow-Methods来指明实际请求所允许使用的 HTTP 方法

示例代码如下:

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

8. CORS请求的分类

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

①简单请求

②预检请求

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)

10. 预检请求

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

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

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

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

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

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

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

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

1.6 JSONP 接口

1. 回顾 JSONP 的概念与特点

概念:浏览器端通过

特点

①JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。

②JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求。

2. 创建 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)=>{
	
});

3. 实现 JSONP 接口的步骤

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

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

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

④把上一步拼接得到的字符串,响应给客户端的

4. 实现 JSONP 接口的具体代码

// 配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {
    // TODO:定义 JSONP 接口具体实现的过程
    // 1.得到函数的名称
    const funcName = req.query.callback;
    // 2.定义要发送到客户端的数据对象
    const data = { name: '段小小', age: 18 };
    // 3.拼接出一个函数调用
    const scriptStr = `${funcName}(${JSON.stringify(data)})`;
    // 4.把拼接的字符串,想要给客户端
    res.send(scriptStr);
});

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

$('#btnJSONP').on('click', function() {
    $.ajax({
        type: "get",
        url: "http://127.0.0.1/api/jsonp",
        dataType: 'jsonp',
        success: function(res) {
            console.log(res);
        }
    });
});
©️2020 CSDN 皮肤主题: 鲸 设计师:meimeiellie 返回首页