概述
接口的跨域问题:刚才编写的 GET 和 POST接口,存在一个很严重的问题:不支持跨域请求。解决接口跨域问题的方案主要有两种:
- CORS(主流的解决方案,推荐使用)
- JSONP(有缺陷的解决方案:只支持 GET 请求)
CORS跨域资源共享
CORS概述
-
使用 cors 中间件解决跨域问题:cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。使用步骤分为如下 3 步:
- 运行 npm install cors 安装中间件
- 使用 const cors = require(‘cors’) 导入中间件
- 在路由之前调用 app.use(cors()) 配置中间件
-
什么是 CORS:CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头组成,这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源。浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可以解除浏览器端的跨域访问限制。
-
CORS 的注意事项:
- CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。
- CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。
CORS响应头
-
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-A11ow-Headers', 'Content-Type,X-Custom-Header');
-
**CORS 响应头部 - Access-Control-Allow-Methods:**默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法。示例:
// 只允许4种请求方式 res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD'); // 允许所有的http请求方式 res.setHeader('Access-Control-Allow-Methods', '*');
CORS两类请求
**CORS请求的分类:**客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:简单请求、预检请求
- 简单请求:同时满足以下两大条件的请求,就属于简单请求:
- 请求方式: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)
- 预检请求:只要符合以下任何一个条件的请求,都需要进行预检请求:
- 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
- 请求头中包含自定义头部字段
- 向服务器发送了 application/json 格式的数据。在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
- 简单请求和预检请求的区别:
- 简单请求的特点:客户端与服务器之间只会发生一次请求。
- 预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求。
Jsonp接口
Jsonp概述
- 概念:浏览器端通过
<script>
标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP。 - 特点:
- JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
- JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求。
创建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) => {});
实现步骤
- 获取客户端发送过来的回调函数的名字
- 得到要通过 JSONP 形式发送给客户端的数据
- 根据前两步得到的数据,拼接出一个函数调用的字符串
- 把上一步拼接得到的字符串,响应给客户端的
app.get('/api/jsonp', (req, res) => {
// 获取客户端发来的回调函数的名字
const funcName = req.query.callback;
// 得到要通过jsonp发送给客户端的数据
const data = {name: 'meijun', age: 23};
// 拼接出一个函数调用字符串
const scriptStr = `${funcName}(${JSON.stringify()})`;
// 响应给客户端<script>标签进行解析
res.send(scriptStr);
});
jQuery发起Jsonp请求
在网页中使用 jQuery 发起 JSONP 请求:调用 $.ajax() 函数,提供 JSONP 的配置选项,从而发起 JSONP 请求:
$('#btn-jsonp').on('click', () => {
$.ajax({
method: 'GET',
url: 'http://localhost/api/jsonp',
dataType: 'jsonp', // 发送jsonp请求
success: (res) => {
console.log(res);
}
});
});