jQuery jsonp跨域請求

時間 2019-12-07

標籤 jquery jsonp 請求欄目 JQuery 简体版

原文原文鏈接

跨域的安全限制都是對瀏覽器端來講的，服務器端是不存在跨域安全限制的。html

瀏覽器的同源策略限制從一個源加載的文檔或腳本與來自另外一個源的資源進行交互。前端

若是協議，端口和主機對於兩個頁面是相同的，則兩個頁面具備相同的源，不然就是不一樣源的。java

若是要在js裏發起跨域請求，則要進行一些特殊處理了。或者，你能夠把請求發到本身的服務端，再經過後臺代碼發起請求，再將數據返回前端。jquery

這裏講下使用jquery的jsonp如何發起跨域請求及其原理。ajax

先看下準備環境：兩個端口不同，構成跨域請求的條件。json

獲取數據：獲取數據的端口爲9090後端

請求數據：請求數據的端口爲8080跨域

一、先看下直接發起ajax請求會怎麼樣瀏覽器

下面是發起請求端的代碼：安全

 1 <%@ page pageEncoding="utf-8" contentType="text/html;charset=UTF-8"  language="java" %>
 2 <html>
 3 <head>
 4     <title>跨域測試</title>
 5     <script src="js/jquery-1.7.2.js"></script>
 6     <script>
 7         $(document).ready(function () {
 8             
 9             $("#btn").click(function () {
10                 $.ajax({
11                     url: 'http://localhost:9090/student',
12                     type: 'GET',
13                     success: function (data) {
14                         $(text).val(data);
15                     }
16                 });
17 
18             });
19             
20         });
21     </script>
22 </head>
23 <body>
24     <input id="btn" type="button" value="跨域獲取數據" />
25     <textarea id="text" style="width: 400px; height: 100px;"></textarea>
26 </body>
27 </html>

請求的結果以下圖：能夠看到跨域請求由於瀏覽器的同源策略被攔截了。

二、接下來看如何發起跨域請求。解決跨域請求的方式有不少，這裏只說一下jquery的jsop方式及其原理。

首先咱們須要明白，在頁面上直接發起一個跨域的ajax請求是不能夠的，可是，在頁面上引入不一樣域上的js腳本倒是能夠的，就像你能夠在本身的頁面上使用<img src=""> 標籤來隨意顯示某個域上的圖片同樣。

好比我在8080端口的頁面上請求一個9090端口的圖片：能夠看到直接經過src跨域請求是能夠的。

三、那麼看下如何使用<script src="">來完成一個跨域請求：

　　當點擊"跨域獲取數據"的按鈕時，添加一個<script>標籤，用於發起跨域請求；注意看請求地址後面帶了一個callback=showData的參數；

　　showData便是回調函數名稱，傳到後臺，用於包裹數據。數據返回到前端後，就是showData(result)的形式，由於是script腳本，因此自動調用showData函數，而result就是showData的參數。

　　至此，咱們算是跨域把數據請求回來了，可是比較麻煩，須要本身寫腳本發起請求，而後寫個回調函數處理數據，不是很方便。

 1 <%@ page pageEncoding="utf-8" contentType="text/html;charset=UTF-8"  language="java" %>
 2 <html>
 3 <head>
 4     <title>跨域測試</title>
 5     <script src="js/jquery-1.7.2.js"></script>
 6     <script>
 7         //回調函數
 8         function showData (result) {
 9             var data = JSON.stringify(result); //json對象轉成字符串
10             $("#text").val(data);
11         }
12 
13         $(document).ready(function () {
14 
15             $("#btn").click(function () {
16                 //向頭部輸入一個腳本，該腳本發起一個跨域請求
17                 $("head").append("<script src='http://localhost:9090/student?callback=showData'><\/script>");
18             });
19 
20         });
21     </script>
22 </head>
23 <body>
24     <input id="btn" type="button" value="跨域獲取數據" />
25     <textarea id="text" style="width: 400px; height: 100px;"></textarea>
26 
27 </body>
28 </html>

服務端：

 1 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 2     response.setCharacterEncoding("UTF-8");
 3     response.setContentType("text/html;charset=UTF-8");
 4 
 5     //數據
 6     List<Student> studentList = getStudentList();
 7 
 8 
 9     JSONArray jsonArray = JSONArray.fromObject(studentList);
10     String result = jsonArray.toString();
11 
12     //前端傳過來的回調函數名稱
13     String callback = request.getParameter("callback");
14     //用回調函數名稱包裹返回數據，這樣，返回數據就做爲回調函數的參數傳回去了
15     result = callback + "(" + result + ")";
16 
17     response.getWriter().write(result);
18 }

結果：

四、再來看jquery的jsonp方式跨域請求：

服務端代碼不變，js代碼以下：最簡單的方式，只需配置一個dataType:'jsonp'，就能夠發起一個跨域請求。jsonp指定服務器返回的數據類型爲jsonp格式，能夠看發起的請求路徑，自動帶了一個callback=xxx，xxx是jquery隨機生成的一個回調函數名稱。

這裏的success就跟上面的showData同樣，若是有success函數則默認success()做爲回調函數。

 1 <%@ page pageEncoding="utf-8" contentType="text/html;charset=UTF-8"  language="java" %>
 2 <html>
 3 <head>
 4     <title>跨域測試</title>
 5     <script src="js/jquery-1.7.2.js"></script>
 6     <script>
 7 
 8         $(document).ready(function () {
 9 
10             $("#btn").click(function () {
11 
12                 $.ajax({
13                     url: "http://localhost:9090/student",
14                     type: "GET",
15                     dataType: "jsonp", //指定服務器返回的數據類型
16                     success: function (data) {
17                         var result = JSON.stringify(data); //json對象轉成字符串
18                         $("#text").val(result);
19                     }
20                 });
21 
22             });
23 
24         });
25     </script>
26 </head>
27 <body>
28     <input id="btn" type="button" value="跨域獲取數據" />
29     <textarea id="text" style="width: 400px; height: 100px;"></textarea>
30 
31 </body>
32 </html>

效果：

再看看如何指定特定的回調函數：第30行代碼

　　回調函數你能夠寫到<script>下(默認屬於window對象)，或者指明寫到window對象裏，看jquery源碼，能夠看到jsonp調用回調函數時，是調用的window.callback。

　　而後看調用結果，發現，請求時帶的參數是：callback=showData；調用回調函數的時候，先調用了指定的showData，而後再調用了success。因此，success是返回成功後一定會調用的函數，就看你怎麼寫了。

 1 <%@ page pageEncoding="utf-8" contentType="text/html;charset=UTF-8"  language="java" %>
 2 <html>
 3 <head>
 4     <title>跨域測試</title>
 5     <script src="js/jquery-1.7.2.js"></script>
 6     <script>
 7 
 8         function showData (data) {
 9             console.info("調用showData");
10 
11             var result = JSON.stringify(data);
12             $("#text").val(result);
13         }
14 
15         $(document).ready(function () {
16 
17 //            window.showData = function  (data) {
18 //                console.info("調用showData");
19 //
20 //                var result = JSON.stringify(data);
21 //                $("#text").val(result);
22 //            }
23 
24             $("#btn").click(function () {
25 
26                 $.ajax({
27                     url: "http://localhost:9090/student",
28                     type: "GET",
29                     dataType: "jsonp",  //指定服務器返回的數據類型
30                     jsonpCallback: "showData",  //指定回調函數名稱
31                     success: function (data) {
32                         console.info("調用success");
33                     }
34                 });
35             });
36 
37         });
38     </script>
39 </head>
40 <body>
41     <input id="btn" type="button" value="跨域獲取數據" />
42     <textarea id="text" style="width: 400px; height: 100px;"></textarea>
43 
44 </body>
45 </html>

效果圖：

再看看如何改變callback這個名稱：第23行代碼

　　指定callback這個名稱後，後臺也須要跟着更改。

 1 <%@ page pageEncoding="utf-8" contentType="text/html;charset=UTF-8"  language="java" %>
 2 <html>
 3 <head>
 4     <title>跨域測試</title>
 5     <script src="js/jquery-1.7.2.js"></script>
 6     <script>
 7 
 8         function showData (data) {
 9             console.info("調用showData");
10 
11             var result = JSON.stringify(data);
12             $("#text").val(result);
13         }
14 
15         $(document).ready(function () {
16 
17             $("#btn").click(function () {
18 
19                 $.ajax({
20                     url: "http://localhost:9090/student",
21                     type: "GET",
22                     dataType: "jsonp",  //指定服務器返回的數據類型
23                     jsonp: "theFunction",   //指定參數名稱
24                     jsonpCallback: "showData",  //指定回調函數名稱
25                     success: function (data) {
26                         console.info("調用success");
27                     }
28                 });
29             });
30 
31         });
32     </script>
33 </head>
34 <body>
35     <input id="btn" type="button" value="跨域獲取數據" />
36     <textarea id="text" style="width: 400px; height: 100px;"></textarea>
37 
38 </body>
39 </html>

後臺代碼：

 1 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 2     response.setCharacterEncoding("UTF-8");
 3     response.setContentType("text/html;charset=UTF-8");
 4 
 5     //數據
 6     List<Student> studentList = getStudentList();
 7 
 8 
 9     JSONArray jsonArray = JSONArray.fromObject(studentList);
10     String result = jsonArray.toString();
11 
12     //前端傳過來的回調函數名稱
13     String callback = request.getParameter("theFunction");
14     //用回調函數名稱包裹返回數據，這樣，返回數據就做爲回調函數的參數傳回去了
15     result = callback + "(" + result + ")";
16 
17     response.getWriter().write(result);
18 }

效果圖：

最後看看jsonp是否支持POST方式：ajax請求指定POST方式

　　能夠看到，jsonp方式不支持POST方式跨域請求，就算指定成POST方式，會自動轉爲GET方式；然後端若是設置成POST方式了，那就請求不了了。

　　jsonp的實現方式其實就是<script>腳本請求地址的方式同樣，只是ajax的jsonp對其作了封裝，因此可想而知，jsonp是不支持POST方式的。

 1 <%@ page pageEncoding="utf-8" contentType="text/html;charset=UTF-8"  language="java" %>
 2 <html>
 3 <head>
 4     <title>跨域測試</title>
 5     <script src="js/jquery-1.7.2.js"></script>
 6     <script>
 7 
 8         $(document).ready(function () {
 9 
10             $("#btn").click(function () {
11 
12                 $.ajax({
13                     url: "http://localhost:9090/student",
14                     type: "POST",   //post請求方式
15                     dataType: "jsonp",
16                     jsonp: "callback",
17                     success: function (data) {
18                         var result = JSON.stringify(data);
19                         $("#text").val(result);
20                     }
21                 });
22             });
23 
24         });
25     </script>
26 </head>
27 <body>
28     <input id="btn" type="button" value="跨域獲取數據" />
29     <textarea id="text" style="width: 400px; height: 100px;"></textarea>
30 </body>
31 </html>

效果圖：

再補充一點，回到第一條：CORS頭缺乏「Access-Control-Allow-Origin」。

　　有時候你會發現其它都沒問題，出現這個錯誤：這個錯誤表明服務端拒絕跨域訪問。若是出現這個錯誤，就須要在服務端設置容許跨域請求。

　　response.setHeader("Access-Control-Allow-Origin", "*"); 設置容許任何域名跨域訪問

設置能夠跨域訪問：第6行代碼或第8行代碼，設置其中一個便可。

 1 protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 2     response.setCharacterEncoding("UTF-8");
 3     response.setContentType("text/html;charset=UTF-8");
 4 
 5     // * 表示容許任何域名跨域訪問
 6     response.setHeader("Access-Control-Allow-Origin", "*");
 7     // 指定特定域名能夠訪問
 8     response.setHeader("Access-Control-Allow-Origin", "http:localhost:8080/");
 9 
10     //數據
11     List<Student> studentList = getStudentList();
12 
13     JSONArray jsonArray = JSONArray.fromObject(studentList);
14     String result = jsonArray.toString();
15 
16     //前端傳過來的回調函數名稱
17     String callback = request.getParameter("callback");
18     //用回調函數名稱包裹返回數據，這樣，返回數據就做爲回調函數的參數傳回去了
19     result = callback + "(" + result + ")";
20 
21     response.getWriter().write(result);
22 }

總結：jQuery ajax方式以jsonp類型發起跨域請求，其原理跟<script>腳本請求同樣，所以使用jsonp時也只能使用GET方式發起跨域請求。跨域請求須要服務端配合，設置callback，才能完成跨域請求。

支持原版，尊重原創，做者： bojiangzhou 出處： http://www.cnblogs.com/chiangchou/