這篇記錄一個完整的歷程:從「遇到問題不知道是跨域」,到「知道是跨域但不會解」,再到「解出來並找到兩種方案」。
起因是為了複用、減少重複開發,單獨做了一個用戶權限管理系統(暫稱 A 系統),供其他系統獲取認證與授權資訊;調用方以 B 系統為例。在 B 中用 Ajax 調 A 的接口(數據格式為 JSON),當時特別困惑:直接在 A 系統裡訪問那個 URL 能正常返回 JSON,可 B 用 Ajax 請求同一個 URL 卻一點反應都沒有,彷彿什麼都沒發生。反反覆覆改了很久也沒解決,直到同事提醒——可能是跨域問題。
原因明確後就是找方案。搜了半天,在同事指點下知道 jQuery 的 Ajax 有 jsonp 這個屬性可用來解決跨域。
頁面端寫法很簡單:
$(document).ready(function(){ var url='https://localhost:8080/WorkGroupManagment/open/getGroupById?id=1&callback=?'; $.ajax({ url:url, dataType:'jsonp', processData: false, type:'get', success:function(data){ alert(data.name); }, error:function(XMLHttpRequest, textStatus, errorThrown) { alert(XMLHttpRequest.status); alert(XMLHttpRequest.readyState); alert(textStatus); }}); });
但真正實作時還是踩了坑:一開始 error 裡只 alert 了「error」,看不出所以然;把狀態都打印出來後發現 textStatus 是 parsererror。百思不解,最後在 Stack Overflow 找到答案——JSON 與 JSONP 的格式有細微差別。
對比一下:
JSON 格式:
{ "message":"獲取成功", "state":"1", "result":{"name":"工作組1","id":1,"description":"11"} }
JSONP 格式:
callback({ "message":"獲取成功", "state":"1", "result":{"name":"工作組1","id":1,"description":"11"} })
區別一目了然:JSONP 比 JSON 外面多包了一層 callback(),而 URL 裡 callback 傳過去的是什麼名字,外面就套什麼名字。後端代碼相應調整:
@RequestMapping(value = "/getGroupById") public String getGroupById(@RequestParam("id") Long id, HttpServletRequest request, HttpServletResponse response) throws IOException { String callback = request.getParameter("callback"); ReturnObject result = null; Group group = null; try { group = groupService.getGroupById(id); result = new ReturnObject(group, "獲取成功", Constants.RESULT_SUCCESS); } catch (BusinessException e) { e.printStackTrace(); result = new ReturnObject(group, "獲取失敗", Constants.RESULT_FAILED); } String json = JsonConverter.bean2Json(result); response.setContentType("text/html"); response.setCharacterEncoding("utf-8"); PrintWriter out = response.getWriter(); out.print(callback + "(" + json + ")"); return null; }
也就是:先把結果序列化成 JSON,再用 callback 參數在內層外面套一層,就變成了 JSONP。
回頭看 parsererror 的成因其實很樸素——把 JSON 格式的數據當成 JSONP 讓 Ajax 解析,前端等著執行 callback(...),服務端卻只回了裸 JSON,自然解析失敗。當時的錯誤代碼長這樣:
@RequestMapping(value = "/getGroupById") @ResponseBody public ReturnObject getGroupById(@RequestParam("id") Long id, HttpServletRequest request, HttpServletResponse response){ String callback = request.getParameter("callback"); ReturnObject result = null; Group group = null; try { group = groupService.getGroupById(id); result = new ReturnObject(group, "獲取成功", Constants.RESULT_SUCCESS); } catch (BusinessException e) { e.printStackTrace(); result = new ReturnObject(group, "獲取失敗", Constants.RESULT_FAILED); } return result; }
搜索過程中還發現了專門解決跨域的 jQuery 插件 jquery-jsonp。有了前面的基礎,用它非常省事,服務端代碼一行都不用改:
var url="https://localhost:8080/WorkGroupManagment/open/getGroupById?id=1&callback=?"; $.jsonp({ "url": url, "success": function(data) { $("#current-group").text("當前工作組:"+data.result.name); }, "error": function(d,msg) { alert("Could not find user "+msg); } });
1. 中間過渡層
(1)用 Web 代理服務器(如 Apache、Nginx)把不同域的應用統一收攏到同一個域名下,瀏覽器眼中就只有同域請求。
(2)跨域限制只存在於瀏覽器端,服務端沒有這個束縛。所以可以在本機服務端用類似 HttpClient 的方式代為「跨域訪問」,再把結果轉給前端。
2. 利用 script 標簽
凡帶 src 屬性的標簽天生具備跨域能力,比如 script、img、iframe。
前台腳本:
<script type="text/javascript"> var flightHandler = function(data){ alert('你查詢的航班結果是:票價 ' + data.price + ' 元,' + '余票 ' + data.tickets + ' 張。'); }; var url = "https://abc.com:8080/AjaxCrossDomain/data/data.jsp?code=CA1998&callback=flightHandler"; var script = document.createElement('script'); script.setAttribute('src', url); document.getElementsByTagName('head')[0].appendChild(script); </script>
後台 data.jsp:
<%@ page language="java" pageEncoding="UTF-8"%> <% String callback = request.getParameter("callback"); StringBuilder builder = new StringBuilder(); builder.append(callback).append("({").append("\"code\": \"CA1998\",").append("\"price\": 1780,").append("\"tickets\": 5").append("});"); out.println(builder.toString()); %>
用 jQuery 的 jsonp 實現同樣的效果:
<script type="text/javascript"> $(function(){ $.ajax({ type: "get", async: false, url: "https://abc.com:8080/AjaxCrossDomain/jsonp/data.jsp", dataType: "jsonp", jsonp: "callback", jsonpCallback:"flightHandler", success: function(json){ alert('您查詢到航班信息:票價: ' + json.price + ' 元,余票: ' + json.tickets + ' 張。'); }, error: function(){ alert('fail'); } }); }); </script>
3. 服務端 CORS 響應頭
由服務端輸出 Access-Control-Allow-Origin 等標頭,是現代瀏覽器上最規範的做法,語義清晰、支援完整的 HTTP 方法與錯誤處理。
三類思路各有適用場合:JSONP 簡單但只支援 GET 且無錯誤處理;代理方案通用但需要額外一層服務;CORS 最標準,只是要求服務端配合且照顧老瀏覽器的成本較高。