DIV CSS 佈局教程網

用 jQuery ajaxPrefilter 為 AJAX 請求加上路由與過濾
編輯:JQuery特效代碼     

接手遺留系統時常遇到這種情況:後端的 AJAX 入口寫死成 /ajax.php,所有請求都得塞一堆參數告訴它要做什麼。理想的做法應該是 RESTful 的 /ajax/dir/page/action,但改後端成本太高。這時候可以在前端用 ajaxPrefilter 做一次轉接。

完整範例

<html>
<head>
<title>ajaxPrefilter demo</title>
</head>
<body>
<script type="text/javascript" src="https://code.jquery.com/jquery-latest.min.js"></script>
<script type="text/javascript">
var zoneAjaxUrl   = '/ajax.php';
var zoneAjaxRoute = /\/ajax\/(\w+)\/(\w+)\/(\w+)(\?.*)?/;

$.ajaxPrefilter(function( options, originalOptions, jqXHR ) {
  var m = options.url.match(zoneAjaxRoute);
  if (m) {
    var routed = {
      dir  : m[1],
      page : m[2],
      action : m[3],
      args : JSON.stringify(originalOptions.data)
    };
    options.url  = zoneAjaxUrl + (m[4] || '');   // 保留原 query string
    options.data = $.param(routed);
  }
});

var url       = '/ajax/dir/page/action';
var url_jsonp = '/ajax/dir/page/action?callback=?';
var data = { username: "abc@example.com", users: ['a','b'] };

$.post(url, data);
$.get(url, data);
$.getJSON(url_jsonp, data);
</script>
</body>
</html>

改寫前後的差異

// 改造之後:呼叫端乾淨、意圖清楚
$.post('/ajax/dir/page/action', { page: 1 });

// 改造之前:每個呼叫都得手寫一長串
$.post('/ajax.php', {
  dir    : 'dir',
  page   : 'page',
  action : 'action',
  args   : JSON.stringify({ page: 1 })
});

三個參數的意義

options:本次請求的最終設定,在這裡改動才會生效。
originalOptions:呼叫端傳進來的原始設定,未被修改。
:底層的 XMLHttpRequest 物件(Deferred),可用來掛 beforeSend 這類 header。

範例刻意從 originalOptions.data 取原始資料序列化,而不是從已被改寫的 options 取,順序才不會出錯。

ajaxPrefilter 的其他用途

路由只是其中一種。實務上常見的還包括:

  • 全域加上驗證 token:從 cookie 或 meta 讀出 CSRF token,統一塞進 header,不必每個請求各寫一次。
  • 統一錯誤處理:攔下 401 / 403,直接導向登入頁;攔下 500,顯示友善提示。
  • 載入遮罩:以正在進行中的請求數計數,第一個請求發出時顯示遮罩,最後一個完成時隱藏。
  • 除錯記錄:開發環境下把每個請求的 url、參數、耗時印到 console。

注意事項

用 jquery-latest 一樣有風險。範例中的 CDN 網址已停止更新,正式環境請固定版本號。

prefilter 會影響所有請求。包含第三方插件發出的呼叫。若只想作用於部分請求,務必像範例那樣用正則比對 url 先篩選,否則很容易弄壞其他功能。

改 options 而非 originalOptions。兩者混淆是這裡最常見的錯誤。

JSONP 要小心。getJSON 帶 callback=? 時走的是 script 標籤注入,並非真正的 XHR,prefilter 中改 data 的行為與 XHR 略有差異,上線前請實測。

最後一點觀念:ajaxPrefilter 是很好的過渡工具,但真正的解法還是在後端提供合理的路由。前端轉接寫久了會變成技術債——新同事看程式碼時,會找不到請求到底是從哪裡發出去的。

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