一、跨域问题
1. 接口的跨域问题
平常调用接口,会出现跨域问题,解决接口跨域的方案主要有两种:
CORS(主流的解决方案,推荐使用)JSONP(有缺陷的解决方案,只支持 GET 请求)
二、CORS
1. 什么是 CORS
CORS(Cross-Origin Resource Sharing,跨域资源)由一系列 HTTP 响应头 组成。这些 HTTP 响应头 决定浏览器是否阻止前端 JS 代码以跨域获取资源。
浏览器的 同源安全策略 默认会阻止网页'跨域'获取资源。但如果接口服务器配置了 CORS 相关 HTTP 响应头,就可以解决 浏览端的跨域访问限制。
2. CORS 跨域使用步骤
cors 是 Express 的一个第三方中间件。通过安装 和 配置 cors 中间件,可以很方便地解决跨域问题。
使用步骤分为如下 3 步:
- 运行 npm i cors
安装中间件 - 使用 const cors = require('cors')
导入中间件 - 在路由之前 调用 app.use(cors())
配置中间件
3. CORS 跨域使用
api 路由模块 router.js:
# router.js
const express = require('express');
const router = express.Router();
module.exports = router;
创建服务器 serve.js
# serve.js
const express = require('express');
const app = express();
// 引入路由模块
const router = require('./router')
// 在注册路由之前注册 cors 跨域配置
const cors = require('cors');
app.use(cors())
// 注册解析表单数据的中间件, 这一步要在注册路由前进行注册
app.use(express.urlencoded({extended:false}))
// 注册路由
app.use('/api', router)
// get 方法
router.get('/get', (req, res) => {
res.send({
code: 200,
message: 'get 方法请求成功',
data: req.query
})
})
app.listen(80, ()=> {
console.log('running http://127.0.0.1')
})
html
# html
<body>
<button id="btnGET">Get 请求</button>
<script>
$(()=>{
// get 请求
$('#btnGET').on('click', ()=>{
$.ajax({
url: 'http://127.0.0.1/api/get',
type: 'GET',
data:{name: 'xl', age: 18},
success:(res) =>{
console.log(res, 'get 请求')
}
})
})
})
</script>
</body>
4. CORS 的注意事项
- CORS 主要在
服务器端进行配置。客户浏览器无需做任何额外的配置,即可请求开启了 CORS 的接口。 - CORS 在浏览器中
有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。
5. CORS 相关的三个响应头
a. Access-Control-Allow-Origin
响应头部中可以携带一个 Access-Control-Allow-Origin 字段,语法如下:
Access-Control-Allow-Origin: <origin> | *
其中,orgin 参数的值指定了 允许访问该资源的外域 URL。
例如:下面的字段将 只允许 来自 itcast.cn 的请求:
res.setHeader('Access-Control-Allow-Origin', 'http://itcast.cn')
如果指定了 Access-Control-Allow-Origin 字段的值为 通配符 * , 表示允许来自任何域的请求,示例代码如下:
res.setHeader('Access-Control-Allow-Origin', '*')
b. Access-Control-Allow-Headers
默认情况下,CORS 仅 支持 客户端向服务器 发送如下的 9 个 请求头:
Accept、Accept-Language、Content-Language、DPR、Dowlink、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-Header', 'Content-Type, X-Custom-Header')
c、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', '*')
6. CORS 请求的分类
客户端在请求 CORS 接口时,根据 请求方式 和 请求头 的 不同,可以将 CORS 的请求分为 两大类:分别是:
- 简单请求
- 预检请求
7. 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)
8. 预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:
- 请求方式为 GET、POST、HEAD 之外 的请求 Method 类型
- 请求头中 包含自定义头部字段
- 向服务器发送 了 application/json 格式的数据
在浏览器与服务器正式通信之前,浏览器 会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为“预检请求”。 服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
9. 简单请求和预检请求的区别
简单请求的特点: 客户端与服务器之间 只会发生一次请求
预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后 ,才会发起真正的请求。
三、JSONP 接口
1. JSONP 概念与特点
概念:浏览器通过 <script> 标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做 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 形式发送给客户端的数据- 根据前两步得到的数据,
拼接出一个函数调用的字符串 - 把上一步拼接得到的字符串,响应给客户端的
<script>标签进行解析执行
完整代码如下:
# serve.js
// 配置 jsonp 接口需在 cors 中间件前配置
// 这里url 前要加个 api, 因为路由这里还没注册
app.get('/api/jsonp', (req, res) =>{
// 1. 得到函数的名称
console.log(req.query, '-----')
const funName = req.query.callback;
// 2. 定义要发送给客户端的数据对象
const data = { name: 'kp', age: 20};
// 3. 拼接出一个函数的调用
const scriptStr = `${funName}(${JSON.stringify(data)})`
// 4. 把拼接的字符串,响应给客户端
res.send(scriptStr)
})
#index.html
// jsonp 请求
$('#btnJsonp').on('click', ()=>{
$.ajax({
url: 'http://127.0.0.1/api/jsonp2',
type: 'get',
dataType: 'jsonp',
success:(res) =>{
console.log(res, 'jsonp 请求')
}
})
})