談起 Ajax,做過 Web 開發的人都不陌生——它靠 XMLHttpRequest 與伺服器溝通,避免整頁刷新。網上解讀各 JS 檔作用、XMLHttpRequest 原理的文章很多,但 Ajax 究竟「如何呼叫伺服器端的 C# 程式碼」、「怎麼讓後台方法執行並把結果回傳給 XMLHttpRequest」,深入探討的文章卻少之又少。本文就來一探究竟。
使用 AjaxPro 大致要做四件事:
1)在專案中引用 AjaxPro.dll(本文用 AjaxPro.2.dll,6.6.13.2 版),並在 web.config 的 httpHandlers 中加入:
<add verb="POST,GET" path="ajaxpro/*.ashx" type="AjaxPro.AjaxHandlerFactory, AjaxPro.2" />
2)在要使用 Ajax 的頁面 .cs 檔中註冊:
protected void Page_Load(object sender, EventArgs e)
{
AjaxPro.Utility.RegisterTypeForAjax(typeof(Default));
}
3)宣告可被 Ajax 呼叫的函式:
[AjaxPro.AjaxMethod]
public string GetChild(string parentId)
{
return "return value from .cs file";
}
4)在 .aspx 中用 JavaScript 呼叫:
<script language="Javascript">
var items = DynLoadTree.Default.GetChild("aa").value;
alert(items);
</script>
完成這四步,基本就實現了 Ajax 無刷新。那它是怎麼透過 XMLHttpRequest 與伺服器通訊的?執行後檢視原始碼,會多出幾行 .ashx 參照:
<script type="text/javascript" src="/Ajaxpro/prototype.ashx"></script> <script type="text/javascript" src="/Ajaxpro/core.ashx"></script> <script type="text/javascript" src="/Ajaxpro/converter.ashx"></script> <script type="text/javascript" src="/Ajaxpro/DynLoadTree.Default,DynLoadTree.ashx"></script>
這些 .ashx 其實是在第 2 步 RegisterTypeForAjax 註冊時,自動加進 HTML 輸出的。而第 1 步在 httpHandlers 中的設定告訴系統:凡是 ajaxpro 路徑下、以 ashx 為後綴的請求,全部交由 AjaxPro.AjaxHandlerFactory 處理,經處理後回傳的就是一些 JavaScript 檔,和一般的 JS 參照沒有本質差別。
先看看 DynLoadTree.Default,DynLoadTree.ashx 的內容:
if(typeof DynLoadTree == "undefined") DynLoadTree={};
DynLoadTree.Default_class = function() {};
Object.extend(DynLoadTree.Default_class.prototype, Object.extend(new AjaxPro.AjaxClass(), {
GetChild: function(parentId) {
return this.invoke("GetChild", {"parentId":parentId}, this.GetChild.getArguments().slice(1));
},
url: '/Ajaxpro/DynLoadTree.Default,DynLoadTree.ashx'
}));
DynLoadTree.Default = new DynLoadTree.Default_class();
原來 DynLoadTree.Default 就在這裡定義,而 GetChild 最終呼叫的是 this.invoke(...),invoke 方法則定義在 core.ashx 中。core.ashx 裡有許多 Ajax 核心 JS 方法,例如用 Object.extend 實作簡單的繼承。在 invoke 方法中,先 new 一個 XMLHttp 物件,接著做了幾件關鍵的事:
this.XMLHttp.open("POST", this.url, async);
this.XMLHttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
this.XMLHttp.setRequestHeader("X-" + AjaxPro.ID + "-Method", method);
this.XMLHttp.send(JSon);
open 指定向哪個伺服器 url 發送請求、是同步還是異步;接著設定 Content-Type,再把 method 放進 http header 讓伺服器知道要呼叫什麼方法,最後連同含參數的 JSon 一起 send 出去。至此,請求已送出,就等伺服器回傳結果了。
但為什麼這樣一個請求就能讓伺服器自動呼叫指定的 method?關鍵在 open 裡的 this.url——它的值是 /Ajaxpro/DynLoadTree.Default,DynLoadTree.ashx,並不是頁面地址。既然 ashx 都交由 AjaxPro.AjaxHandlerFactory 處理,就得看看它裡頭做了什麼。我用 Reflector 反編譯 AjaxPro.2.dll,看過 GetHandler 方法後才恍然大悟:
public IHttpHandler GetHandler(HttpContext context, string requestType, string url, string pathTranslated)
{
string str2 = requestType;
if (str2 == "GET")
{
// GET:說明是 HTML 對被引用 ashx 檔的下載請求
// 依檔名回傳對應的 Handler 產生 JavaScript
switch (fileNameWithoutExtension.ToLower())
{
case "prototype": return new EmbeddedJavaScriptHandler("prototype");
case "core": return new EmbeddedJavaScriptHandler("core");
default: return new TypeJavaScriptHandler(type);
}
}
else if (str2 == "POST")
{
// POST:說明是透過 XMLHTTP 送來、要求呼叫伺服器端方法
IAjaxProcessor[] processorArray = new IAjaxProcessor[] {
new XMLHttpRequestProcessor(context, type),
new IFrameProcessor(context, type) };
// ... 依需求回傳同步或非同步的 Handler
return new AjaxSyncHttpHandler(processorArray[i]);
}
return null;
}
它先判斷 requestType:若是 GET,代表是 HTML 對 ashx 檔的下載請求,依檔名回傳對應 Handler 產生 JavaScript 輸出到客戶端;若是 POST,代表是透過 XMLHTTP 呼叫伺服器端方法,則回傳相應 Handler,利用反射機制呼叫請求的方法。
GET 的處理很簡單:對 core、prototype 回傳 EmbeddedJavaScriptHandler,對 DynLoadTree.Default,DynLoadTree.ashx 回傳 TypeJavaScriptHandler。EmbeddedJavaScriptHandler 會從資源中提取指定檔案內容並輸出,這些內容都是固定且已內嵌於程式集的:
internal class EmbeddedJavaScriptHandler : IHttpHandler
{
private string fileName;
internal EmbeddedJavaScriptHandler(string fileName) { this.fileName = fileName; }
public void ProcessRequest(HttpContext context)
{
string[] strArray = this.fileName.Split(new char[] { ',' });
Assembly executingAssembly = Assembly.GetExecutingAssembly();
for (int i = 0; i < strArray.Length; i++)
{
Stream s = executingAssembly.GetManifestResourceStream("AjaxPro.2." + strArray[i] + ".js");
if (s != null)
{
StreamReader reader = new StreamReader(s);
context.Response.Write(reader.ReadToEnd());
context.Response.Write("\r\n");
reader.Close();
}
}
}
}
而 TypeJavaScriptHandler 的 ProcessRequest 則會依 Type 動態產生 JavaScript 內容並輸出。至於 POST 請求,以 AjaxSyncHttpHandler 為例,它的 ProcessRequest 會建立一個 AjaxProcHelper 物件並呼叫其 Run 方法來處理實質請求:
internal class AjaxSyncHttpHandler : IHttpHandler
{
private IAjaxProcessor p;
internal AjaxSyncHttpHandler(IAjaxProcessor p) { this.p = p; }
public void ProcessRequest(HttpContext context)
{
new AjaxProcHelper(this.p).Run();
}
public bool IsReusable { get { return false; } }
}
AjaxProcHelper.Run 的核心,是透過反射機制呼叫對應方法,再把結果寫入 context 輸出到客戶端:
internal void Run()
{
this.p.Context.Response.ContentType = this.p.ContentType;
this.p.Context.Response.ContentEncoding = Encoding.UTF8;
object[] args = this.p.RetreiveParameters();
if (this.p.AjaxMethod.IsStatic)
{
o = this.p.Type.InvokeMember(this.p.AjaxMethod.Name,
BindingFlags.InvokeMethod | BindingFlags.Public | BindingFlags.Static | BindingFlags.IgnoreCase,
null, null, args);
}
else
{
object obj3 = Activator.CreateInstance(this.p.Type, new object[0]);
o = this.p.AjaxMethod.Invoke(obj3, args);
}
// 若回傳 XMLDocument,則以 text/XML 輸出
// 否則序列化後寫入 Response
}
由此可清楚看到:Run 透過反射呼叫方法,再將結果寫入 context 輸出。此外也能看清 Utility 中 RegisterTypeForAjax 的兩個重載:
public static void RegisterTypeForAjax(Type type); public static void RegisterTypeForAjax(Type type, Page page);
最後來看 AjaxMethodAttribute 的定義(Attribute 的用法可參考 MSDN):
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
public class AjaxMethodAttribute : Attribute
{
private HttpSessionStateRequirement requireSessionState;
private bool useAsyncProcessing;
public AjaxMethodAttribute();
public AjaxMethodAttribute(HttpSessionStateRequirement requireSessionState);
internal HttpSessionStateRequirement RequireSessionState { get; }
internal bool UseAsyncProcessing { get; }
}
綜上所述,Ajax 之所以能呼叫伺服器端 C# 方法,靠的是「ashx 自訂 Handler + 反射」這套機制:前端產生的代理 JS 把方法名放進 http header、參數放進 body POST 出去,伺服器端的 AjaxHandlerFactory 依請求方法挑選合適的 Handler,再由 AjaxProcHelper 以反射執行對應方法並序列化回傳。整條鏈路串起來,就是我們日常使用的「無刷新 Ajax 呼叫」背後的真相。