跨域訪問的解決方案(非HTML5的方法:JSONP)

餘二五發表於2017-11-14

跨域訪問一直是困擾很多開發者的問題之一。因為涉及到安全性問題,所以跨域訪問預設是不可以進行的,否則假設今天我寫了一段js去更改google的圖示,明天他寫了一段程式碼去吧google首頁的文字全部變成梵文,那還得了?

首先,講下什麼是相同的域。域是這樣定義的,協議名+host名+埠號,只有這3個都一樣,才能說是同樣的域,同樣的域裡面的訪問不受到同源策略限制,你可以用你的js程式碼任意的去操作資源,但是不同域你就不能這樣做了。

解決跨域訪問有很多方法,最常見的一種“單向”跨域訪問方式是用JSONP(Json with Padding),它解決思路就是如果域A (充當客戶端)上的js 要操作域B(充當伺服器端)上的資源,那麼只要吧域A上的js函式名傳遞給域B,然後在域B進行封裝,它解析來自域A的函式名,並且將域B上的資源轉為json物件,並且兩者進行組合,組合後的字串就是 域A函式名(域B json物件) 這種函式呼叫的形式,然後當域A上用script src=””的形式訪問時,它拿到的結果就是一段js程式碼,並且是域A函式名(域B json物件)的形式,於是就達到了域A函式處理域B資源的效果。

 

為了更有說服力,我們這裡做一個非常簡單的實驗,假定域A(客戶端)有個應用部署在http://localhost:8180上,域B(伺服器端)有個應用部署在http://localhost:8080上,顯然這2個域由於埠不同,所以域A如果要訪問域B必定是跨域訪問的。域A 有一段js函式,域B提供了一個json物件,我們想要域A的js函式操作域B的json物件。會怎樣呢?

 

服務端(我們部署在http://localhost:8080上):

先貼上域B(伺服器端的程式碼),它用一個java servlet,負責接收來自客戶端的帶回撥函式名引數的請求,並且與自己端提供的json物件包裝,包裝為一個jsonp後然後放入響應輸出流。


  1. package com.charles.jsonp; 
  2.  
  3. import java.io.IOException; 
  4. import java.io.PrintWriter; 
  5.  
  6. import javax.servlet.ServletException; 
  7. import javax.servlet.http.HttpServlet; 
  8. import javax.servlet.http.HttpServletRequest; 
  9. import javax.servlet.http.HttpServletResponse; 
  10.  
  11. import org.json.simple.JSONObject; 
  12.  
  13. /** 
  14.  * Servlet implementation class JSONPServlet 
  15.  */ 
  16. public class JSONPServlet extends HttpServlet { 
  17.     private static final long serialVersionUID = 1L; 
  18.         
  19.     /** 
  20.      * @see HttpServlet#HttpServlet() 
  21.      */ 
  22.     public JSONPServlet() { 
  23.         super(); 
  24.         // TODO Auto-generated constructor stub 
  25.     } 
  26.  
  27.     /** 
  28.      * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response) 
  29.      */ 
  30.     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
  31.         // TODO Auto-generated method stub 
  32.          
  33.         //get the callback function which comes from client 
  34.         String callbackFuncFromClient= request.getParameter(“callbackFunc”); 
  35.         //create a json object 
  36.         JSONObject jsonInfo = new JSONObject(); 
  37.         jsonInfo.put(“name”,“charles”); 
  38.         jsonInfo.put(“title”“technical lead”); 
  39.         jsonInfo.put(“info”,“talent man”); 
  40.         //create a string which stands for a javascript with the format func(jsonobject) 
  41.         StringBuffer jsonpString = new StringBuffer(); 
  42.         jsonpString.append(callbackFuncFromClient).append(“(“).append(jsonInfo.toJSONString()).append(“)”); 
  43.          
  44.          
  45.         //construct the output jsonp and output to the client 
  46.         response.setCharacterEncoding(“utf-8”); 
  47.         PrintWriter out = response.getWriter(); 
  48.         out.println(jsonpString); 
  49.         out.flush(); 
  50.     } 
  51.  
  52.     /** 
  53.      * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response) 
  54.      */ 
  55.     protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
  56.         // TODO Auto-generated method stub 
  57.     } 
  58.  

 

然後我們把這個servlet對映到某個url上,見web.xml:


  1. <servlet> 
  2.     <description>This servlet will create a jsonp object,it wraps the js function and the json object</description> 
  3.     <display-name>JSONPServlet</display-name> 
  4.     <servlet-name>JSONPServlet</servlet-name> 
  5.     <servlet-class>com.charles.jsonp.JSONPServlet</servlet-class> 
  6.   </servlet> 
  7.   <servlet-mapping> 
  8.     <servlet-name>JSONPServlet</servlet-name> 
  9.     <url-pattern>/JSONPServlet</url-pattern> 
  10.   </servlet-mapping> 

 

現在我們測試伺服器端是否已經正確部署:

我們開啟瀏覽器,輸入訪問伺服器端這個servlet的url,注意帶上請求引數,引數名為callbackFunc,引數值為任意函式名:則我們可以看到封裝後的JSONP效果,的確是“函式名(json物件)”的字串形式。比如我們例子中,我們傳入的函式名是 someFunc ,而伺服器端自身提供的json物件是{“title”:”technical lead”,”name”:”charles”,”info”:”talent man”},則最後伺服器端返回的JSONP 字串是someFunc{json}

 

客戶端:

伺服器端部署正確後,我們讓客戶端部署在另外一個域:http://localhost:8180上,要實現跨域訪問,客戶端必須有2部分,1是定義一個回撥函式(這個函式用於將來處理伺服器json資料),二是一個頁面,這個頁面要用<script src來指向伺服器端能 提供JSONP的url),我們一步步來:

先定義一個回撥函式:

這個回撥函式能在控制檯和alert視窗列印出伺服器端的json物件提供的資訊


  1. //這段程式碼用於定義回撥函式 
  2. function clientMethodWhichOperateServerResource(result){ 
  3.      
  4.     console.log(“Begin to execute the call function named clientMethodWhichOperateServerResource(result)”); 
  5.      
  6.     //獲取伺服器端傳遞過來的json字串,轉為json物件 
  7.     var jsonObject=result; 
  8.     //從json物件中分離出一些相關資訊 
  9.     var name=jsonObject.name; 
  10.     var title=jsonObject.title; 
  11.     var info=jsonObject.info; 
  12.     console.log(“name: “+name); 
  13.     console.log(“title: “+title); 
  14.     console.log(“info: “+info); 
  15.      
  16.  
  17.     var serverInfoString=“姓名: “+name+“,”
  18.     serverInfoString+=“頭銜: “+title+“,”
  19.     serverInfoString+=“資訊: “+info; 
  20.     alert(serverInfoString); 
  21.      
  22.      

然後我們定義一個頁面:

這個頁面的關鍵之處在於兩段<script>,第一段是引入了客戶端的回撥函式(上面我們定義的那段),從而這個函式被頁面可視,精華在於第二段,它用src標籤指向了伺服器端(http://localhost:8080域上)能提供JSONP 字串物件的url(對應上面我們寫的那個servlet),而且吧回撥函式的名字當做引數傳遞過去(就像我們用於測試伺服器端的訪問示例一樣):


  1. <%@ page language=“java” contentType=“text/html; charset=UTF-8” 
  2.     pageEncoding=“UTF-8”%> 
  3. <!DOCTYPE html PUBLIC “-//W3C//DTD HTML 4.01 Transitional//EN” “http://www.w3.org/TR/html4/loose.dtd”> 
  4. <html> 
  5. <head> 
  6. <meta http-equiv=“Content-Type” content=“text/html; charset=UTF-8”> 
  7. <title>這個頁面用於演示JSONP</title><base> 
  8.  
  9. <!–這裡引入了javascript檔案,js函式有2個,一個是回撥函式,它的函式名將作為引數傳遞給伺服器端, 
  10. 另外一個是負責向服務端用src的方式請求jsonp  —> 
  11.  
  12. <!– 這裡引入的js檔案中定義了回撥函式,這個函式的函式名將作為引數傳遞到伺服器端,它最終會操作伺服器端的資源 –> 
  13. <script type=“text/javascript” src=“js/callbackFuncDef.js”></script> 
  14.  
  15. <!– 這裡就是jsonp的使用,它以src的方式向伺服器端傳送一個jsonp請求,並且把這邊定義好的處理函式的函式名以引數形式傳遞 –> 
  16. <script type=“text/javascript” src=“http://localhost:8080/JSONPServerSide/JSONPServlet?callbackFunc=clientMethodWhichOperateServerResource”></script> 
  17. </head> 
  18. <body> 
  19.  
  20.  
  21. <p>這個JSONP的例子的要點是,它用定義在客戶端的一段js程式碼,去處理伺服器上的json資源</p> 
  22.  
  23.  
  24. </body> 
  25. </html> 

所以,當我們開啟瀏覽器訪問客戶端的頁面時候,它就可以顯示結果了,我們可以看到,它的確取到了伺服器端的資料(json物件)並且顯示在客戶端了:

所以,非常順利成章,跨域訪問得到實現。

本文轉自 charles_wang888 51CTO部落格,原文連結:http://blog.51cto.com/supercharles888/856886,如需轉載請自行聯絡原作者


相關文章