DIV CSS 佈局教程網

不靠任何框架,自己動手寫一個 Ajax(含 jsonp 與 script 處理)
編輯:AJAX基礎知識     

平常發請求,我們幾乎都直接 $.ajax() 了事。但仔細想想,很多時候專案裡加載整個 jQuery,實際上只用到它的 Ajax 那一小块而已。自己刻一個有兩個好處:一是把 XHR 的底層細節真正搞懂,二是某些場景真的不需要背這麼大的包袱。

先看 jQuery 是怎麼呼叫的

 $.ajax({ url: 'test.php', //發送請求的 URL 字串 type: 'GET', //發送方式 dataType: 'json', //預期伺服器返回的資料類型 xml, html, text, json, jsonp, script data: 'k=v&k=v', //發送的資料 async: true, //非同步請求 cache: false, //緩存 timeout: 5000, //逾時時間 毫秒 beforeSend: function(){}, //請求之前 error: function(){}, //請求出錯時 success: function(){}, //請求成功時 complete: function(){} //請求完成之後(不論成功或失敗) });

這樣寫起來確實舒適。那我們自己刻的時候,就把參數設計成這個樣子,不必更複雜,够用就好。

基礎知識回顧

XMLHttpRequest 是 Ajax 的核心。所有現代瀏覽器(IE7+、Firefox、Chrome、Safari、Opera)都支援它,IE5/IE6 則要用 ActiveXObject。建立一個相容物件:

var xhr = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject('Microsoft.XMLHTTP');

送出請求:

xhr.open(method, url, async);
xhr.send(string);

GET 比 POST 簡單也更快,多數情況都够用;但如果是更新伺服器上的檔案或資料、要送大量資料、或資料含未知字元時,就該改用 POST。

取回應:如果是 XML 且需要當 XML 物件解析,用 responseXML;否則用 responseText 拿到字串。

onreadystatechange 會在 readyState 改變時觸發,狀態從 0 走到 4;配合 status 為 200,就代表回應已就緒:

 xhr.onreadystatechange = function(){ if( xhr.readyState == 4 && xhr.status == 200 ){ //準備就緒,可處理 xhr.responseText 或 xhr.responseXML } };

兩個實務小技巧:GET 請求可能被瀏覽器快取,可在網址後附加時間戳破壞快取;POST 模擬表單送出時,記得先 setRequestHeader('Content-type', 'application/x-www-form-urlencoded')。

 url += (url.indexOf('?') < 0 ? '?' : '&') + '_='+ (+new Date()); xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded');

開始刻我們自己的版本

 var $ = (function(){ //輔助函式 序列化參數 function param(data){ //.. } function ajax(opts){ var _opts = { url : '/', type : 'GET', dataType : '', data : null, async : true, cache : true, timeout : 5, load : function(){}, error : function(){}, success : function(){}, complete : function(){} }, aborted = false, key, xhr = window.XMLHttpRequest ? new XMLHttpRequest() : new ActiveXObject('Microsoft.XMLHTTP'); for(key in opts) _opts[key] = opts[key]; if(_opts.type.toUpperCase() === 'GET'){ if(param(_opts.data) !== ''){ _opts.url += (_opts.url.indexOf('?') < 0 ? '?' : '&') + param(_opts.data); } !_opts.cache && ( _opts.url += (_opts.url.indexOf('?') < 0 ? '?' : '&') + '_='+(+new Date()) ); } function checkTimeout(){ if(xhr.readyState !== 4){ aborted = true; xhr.abort(); } } setTimeout(checkTimeout, _opts.timeout*1000); xhr.onreadystatechange = function(){ if( xhr.readyState !== 4 ) _opts.load && _opts.load(xhr); if( xhr.readyState === 4 ){ var s = xhr.status, xhrdata; if( !aborted && ((s >= 200 && s < 300) || s === 304) ){ switch(_opts.dataType.toLowerCase()){ case 'xml': xhrdata = xhr.responseXML; break; case 'json': xhrdata = window.JSON && window.JSON.parse ? JSON.parse(xhr.responseText) : eval('(' + xhr.responseText + ')'); break; default: xhrdata = xhr.responseText; } _opts.success && _opts.success(xhrdata,xhr); }else{ _opts.error && _opts.error(xhr); } _opts.complete && _opts.complete(xhr); } }; xhr.open(_opts.type,_opts.url,_opts.async); if(_opts.type.toUpperCase() === 'POST'){ xhr.setRequestHeader('Content-type', 'application/x-www-form-urlencoded'); } xhr.send(_opts.type.toUpperCase() === 'GET' ? null : param(_opts.data)); } return { ajax: ajax } })();

拆解 dataType:複雜度都在這裡

dataType 是整個實作的重心,程式碼是簡潔還是臃腫,全看要支援到哪一步。

  1. xml:用 responseXML 取資料。
  2. html / text / json:用 responseText 取資料。其中 html 若要處理片段中的 script 標籤,複雜度立刻上升;json 則要兼顧安全、便捷與相容。
  3. jsonp:跨域時才用,不能走原本的 XHR,得改用動態建立 script 標籤。
  4. script:跨域時同樣走 script 標籤;不跨域則可用 responseText 取得後設法執行。

其中 html 片段內的 script、jsonp、script 這三種,都繞不開動態建立 script 標籤。

處理 json

xhrdata = window.JSON && window.JSON.parse ? JSON.parse(xhr.responseText) : eval('(' + xhr.responseText + ')');

這是最簡的寫法,若要兼顧舊瀏覽器,可以引入 json2.js。注意:能用 JSON.parse 就别用 eval,後者會執行任意程式碼。

處理 jsonp

流程是這樣的:客戶端先定義好回呼函式,把函式名稱當作參數送給伺服器;伺服器產生 JSON 資料後,用「函式名(資料)」的字串形式輸出;客戶端的 script 標籤解析並執行這段 JavaScript,資料就作為參數傳進回呼函式裡。

上圖中 a.html 請求 https://www.b.com/b.php?callback=add,b.php 讀到 callback=add 後,組出 add({...}) 這樣一段 JavaScript 回傳,a.html 執行它就完成了資料傳遞。

實務上通常用一個通用的動態載入函式來做這件事:

 function loadJS(url, callback) { var doc = document, script = doc.createElement('script'), body = doc.getElementsByTagName('body')[0]; script.type = 'text/javascript'; if (script.readyState) { script.onreadystatechange = function() { if (script.readyState == 'loaded' || script.readyState == 'complete') { script.onreadystatechange = null; callback && callback(); } }; } else { script.onload = function() { callback && callback(); }; } script.src = url; body.appendChild(script); }
loadJS('https://www.b.com/b.php?callback=add');

但要注意一個先天限制:因為是動態建立 script,請求成功時程式碼立刻執行,失敗時卻完全沒有任何提示。所以在自製的參數設計裡,_opts.success 有機會被觸發,_opts.error 則永遠不會被呼叫。實務上通常靠逾時計時器來模擬錯誤處理。

jsonp 也有兩種風格:一是伺服器直接執行你在網址裡指定的函式名;二是回傳後不執行,把參數拆出來交給 _opts.success 處理(相當於把 'add({"a":8,"b":2})' 去掉外層的 add( 與 ))。

處理 html

若不處理 script 標籤,直接把 responseText 塞進 DOM 就好。要處理的話,得先把片段中的 script 取出來逐一執行,並區分它是內嵌程式碼還是透過 src 載入。

處理 script

跨域時走動態 script 標籤,做法與 jsonp 類似;不跨域時可用 eval,但更推薦建立 script 節點來執行:

 function addJS(text) { var doc = document, script = doc.createElement('script'), body = doc.getElementsByTagName('body')[0]; script.type = 'text/javascript'; script.text = text; body.appendChild(script); }

結語

刻過一次就會發現,我們平常享受的「一行 $.ajax()」,背後其實是跨瀏覽器判斷、狀態機管理、逾時控制、資料序列化、快取破壞等一大堆細節。理解這些之後,無論你最後選擇用 jQuery、fetch、axios 還是自製版本,心裡都會踏實很多。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved