个人认为, 网上有很多关于jsonp的讲解, 但实在是讲得不够通俗, 所以我想写这篇文章能够让更多人接受这简单易懂的jsonp.
同源策略
在讲jsonp之前, 我们需要先了解什么是同源策略. 同源意思是指协议, 域名, 端口号相同. 而同源策略就是基于安全考虑, 当前源不能访问不同源的内容.
简单来说, A服务器想要通过直接请求访问B服务器的数据的时候, B服务器的协议, 域名, 端口必须与A服务器的相同, 才能正常获取. 例如. 我直接通过浏览器访问天气API来获取深圳的天气是可以成功获得json数据, 而在代码中使用ajax获取则因为同源策略获取失败.
直接通过浏览器输入网址访问:
通过代码去访问数据:
代码如下:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>ajax</title>
</head>
<body>
<div id="mydiv">
<button id="btn">点击发起ajax请求获取天气数据</button>
</div>
</body>
<script type="text/javascript">
window.onload = function() {
var oBtn = document.getElementById('btn');
oBtn.onclick = function() {
var xhr = new XMLHttpRequest();
xhr.onreadystatechange = function() {
if (xhr.readyState == 4 && xhr.status == 200) {
alert( xhr.responseText );
}
};
xhr.open('get', 'http://www.weather.com.cn/data/cityinfo/101280601.html', true);
xhr.send();
};
};
</script>
</html>
运行点击发送ajax请求后得到如下错误:
这就是同源策略产生的问题.
如何解决?
先说一个概念, 访问非同源的资源被称为跨域访问. 而跨域访问其实有这么几个特殊情况, 并不是所有的资源都无法跨域访问, 其实带src属性的<script>, <iframe>, <img>标签和带href的<link>标签都不受跨域限制.
那么知道了这一点, 我们不难想到, 既然js可以跨域引入, 那么我们可以用这个特性来将数据携带回来. 所以我们可以回归主题了, jsonp就是利用<script>来实现跨域获取数据的.
以下是一些不影响任何操作的更改, 可以略过, 直接查看jsonp部分
因为jsonp是需要后端配合的, 而且现在豆瓣开发API已经关闭使用, 我只能自己编写测试用的服务器. 和之前一样的结果, 直接进行ajax请求数据时还是一样受同源策略限制, 先贴图展示一下更改.(实际上只是更改了一下访问的地址, 希望大家不要觉得和之前有任何区别)
更改的代码:
将:
xhr.open('get', 'http://www.weather.com.cn/data/cityinfo/101280601.html', true);
改成了:
xhr.open('get', 'http://localhost:8080/weather', true);
效果:
只是更换了访问的地址, 效果并没有任何改变. 不会影响接下来的任何操作.
jsonp
jsonp是 json with padding ( 带填充的json ) 的简写. 现在一般前后端的数据传输格式都是json格式, 原因是可以简洁描述复杂数据, 主要还有一点是被js原生支持.
jsonp实现跨域请求的原理简单的说, 就是动态创建<script>标签, 然后利用<script>的src 不受同源策略约束来跨域获取数据.
jsonp由两部分组成: 回调函数和数据. 回调函数是当响应到来时应该在页面中调用的函数. 回调函数的名字一般是在请求中指定的. 而数据就是传入回调函数中的json数据。
这些概念是抄来的, 其实看不明白也没关系, 个人觉得实例已经讲得很清楚了, 可以把下面部分看完了再上来结合文字理解.
现在大家知道了以下两点:
- 什么是同源策略限制
- <script>标签可以无视跨域限制
那么我们可以进行接下来的讲解了, 或许大家还不清楚<script>标签可以无视跨域限制是什么意思, 或者是能做到什么, 那么我用代码来展示给大家看看.
我的服务器部分代码内容如下:
@RequestMapping(value = "/print")
public String getFunction(){
return "print()";
}
看不懂没关系, 你只要知道访问http://localhost:8080/print
会得到如下结果
然后我将运行如下代码:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>从服务器加载js进行方法的调用</title>
</head>
<body>
</body>
<script>
function print(){
console.log("我被调用了啊!!!");
}
</script>
<script src="http://localhost:8080/print"></script>
</html>
运行结果如下:
从如上展示中我们发现, 服务器中传过来的字符串如果使用<script>标签进行引入, 会被解析成js代码. 从而实现在客户端声明方法, 通过服务器传来的调用函数语句来调用.
大家可能猜到该怎么使用jsonp了.
那么我们开始说通过jsonp进行跨域获取localhost:8080/weather返回的数据的具体实现. 先理一下思路.
- 我们知道可以通过<script>标签引入js(就算是普通字符串也会被解析成js). 但是我们不可能直接写个:
<script src="http://localhost:8080/weather"></script>
因为这跟直接在代码中写
<script>{"weatherinfo":{"city":"深圳","cityid":"101280601","temp1":"24℃","temp2":"30℃","weather":"阵雨转大雨","img1":"n3.gif","img2":"d9.gif","ptime":"18:00"}}</script>
一样, 并没有任何意义. 我们需要的是对可以操作这些数据, 而不是那它作为js代码.
- 我们知道可以通过<script>标签从服务器加载js进行方法的调用, 这个远程的方法调用其实方法在客户端, 服务器只是传来了一个调用的js指令而已.
这段代码在客户端
<script>
function print(){
console.log("我被调用了啊!!!");
}
</script>
调用代码print()是通过<script>从服务器中加载.
- 还知道我们需要的数据产自服务器, 所以我们不妨让服务器携带着数据, 在进行方法调用的时候把数据穿给我们. 这样的话, 服务器需要知道我们已经写好在客户端的方法的方法名, 便于调用.
思路大概是这样了, 如果看不懂, 是我表述确实不太贴切了, 很抱歉, 但是大家一定还是能学会, 还是那句话, 看代码吧, 代码更容易懂. 所以具体实现如下:
先看服务端代码:
@RequestMapping(value = "/weather",method = RequestMethod.GET)
public String getWeatherByJsonp(@RequestParam("callback") String callback){
return callback + "({\"weatherinfo\":{\"city\":\"深圳\",\"cityid\":\"101280601\",\"temp1\":\"24℃\",\"temp2\":\"30℃\",\"weather\":\"阵雨转大雨\",\"img1\":\"n3.gif\",\"img2\":\"d9.gif\",\"ptime\":\"18:00\"}})";
}
客户端代码:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>jsonp的测试样例</title>
</head>
<body>
</body>
<script>
function printData(data){
var str = "城市:" + data.weatherinfo.city + "\r\n最低温度:" + data.weatherinfo.temp1 + "\r\n最高温度:" + data.weatherinfo.temp2;
console.log(str);
}
</script>
<script src="http://localhost:8080/weather?callback=printData"></script>
</html>
打开客户端页面效果展示:
看效果我们是成功跨域请求到了数据. 接下来我给大家解释一下代码.
- 客户端先自定义一个js函数printData, 这个函数接受一个参数data, 这个data就是我们想要通过请求获取的. 函数体中对data(也就是我们需要的数据)进行处理.
- 但是我们还没有这个数据, 需要调用函数, 并且传这个数据进来, 数据没有, 调用方法的语句也没有, 我们知道这两个都是可以通过<script>标签引入.
- 所以, 我们在服务器端, 不仅仅是返回一个数据这么简单, 我们需要把数据嵌入到一个调用函数的语句里面, 但是由于服务器端还不知道前端到底写了什么函数来处理这些数据, 也就是前端自定义的函数名我们还不清楚
- 所以需要前端通过请求时携带参数
callback=printData传一个函数名过来告诉服务器端, 服务器端就使用这个printData包裹住数据返回到客户端, 从而进行携带参数的调用了printData(data).
简而言之就是先假设有个能拿到数据的函数A, 然后我们通过<script>引入服务端的调用函数A的语句, 这个语句里包含了数据. 并执行了函数A.
这就是我总结的jsonp解决跨域问题的过程. 希望能对大家有哪怕一丝帮助.
