前言
Asp.net WebForm 和 Asp.net MVC(簡稱 MVC)都是基於 Asp.net 的 Web 開發框架,兩者有很大的區別,其中一個就是 MVC 更注重 HTTP 本質,而 WebForm 試圖屏蔽 HTTP,為此提供了大量的伺服器控制項和 ViewState 機制,讓開發人員可以像開發 Windows Form 應用程式一樣,基於事件模型去編程。兩者各有優缺點和適用情境,但 MVC 現在是許多 Asp.net 開發者的首選。
WebForm 是建立在 Asp.net 基礎上的,Asp.net 提供了足夠的擴展性,我們也可以利用這些在 WebForm 下編寫像 MVC 一樣的框架。說到 WebForm 很多人就會聯想到伺服器控制項(拖控制項!!!),其實不然,我們也可以完全不使用伺服器控制項,像 MVC 那樣關注 HTML。WebForm 要拋棄伺服器控制項、集中關注 HTML,首先就要將 <form runat="server"></form> 標簽去掉,這個 runat server 的 form 是其 PostBack 機制的基礎。既然我們要回歸到 HTML+CSS+JS,那麼意味著許多東西都要自己實作,例如處理 Ajax 請求。
本系列實現一個基於 WebForm 平台的輕量級 Ajax 組件,主要分為三個部分:
1. 介紹 WebForm 下各種實現方式。
2. 分析 ajaxpro 組件。
3. 編寫自己的 Ajax 組件。
一、Ajax 簡介
非同步允許我們在不刷新整個頁面的情況下,向伺服器請求或提交資料。對於複雜的頁面,為了請求一點資料而重載整個頁面顯然很低效,Ajax 就是為了解決這個問題的。Ajax 的核心是 XmlHttpRequest 物件,透過該物件以文字的形式向伺服器提交請求;XmlHttpRequest 2.0 之後,還支援提交二進位資料。
Ajax 安全:出於安全考慮,Ajax 受同源策略限制,也就是只能訪問同一個域、同一個連接埠的請求,跨域請求會被拒絕。當然有時候需求需要跨域發送請求,常用的跨域處理方法有 CORS(跨域資源共享)和 JSONP(參數式 JSON)。
Ajax 資料互動格式:雖然 Ajax 核心物件 XmlHttpRequest 有「XML」字眼,但客戶端與伺服器資料交換格式不限於 XML,例如現在更多是使用 JSON 格式。
Ajax 也是有缺點的,例如對搜尋引擎的支援不太好,有時候也會違背 URL 資源定位的初衷。
二、Asp.net MVC 平台下使用 Ajax
在 MVC 裡,Ajax 呼叫後台方法非常方便,只需要指定 Action 的名稱即可。
前台程式碼:
<body>
<h1>index</h1>
<input type="button" value="GetData" onclick="getData()" />
<span id="result"></span>
</body>
<script type="text/javascript">
function getData() {
$.get("GetData", function (data) {
$("#result").text(data);
});
}
</script>
後台程式碼:
public class AjaxController : Controller {
public ActionResult GetData() {
if (Request.IsAjaxRequest()) {
return Content("data");
}
return View();
}
}
三、WebForm 平台下使用 Ajax
3.1 基於伺服器控制項包或第三方組件
這是基於伺服器控制項的,例如 ajax toolkit 工具包,或者像 FineUI 這樣的組件。Web 前端始終是由 HTML+CSS+JS 組成的,只不過是如何生成的問題。基於伺服器控制項的都是在後台生成的,通常效率也低一點。伺服器組件會在前台生成一系列代理,本質還是一樣的,只不過控制項封裝了這個過程。基於控制項或第三方組件的模式,在一些管理系統還是挺有用的,訪問量不是很大,可以快速開發。
3.2 基於 ICallbackEventHandler 介面
.net 提供了 ICallbackEventHandler 介面,用於處理回呼請求。該介面需要用 ClientScriptManager 在前台生成代理腳本,用於發送和接收請求,所以需要 <form runat="server"> 標簽。
前台程式碼:
<body>
<form id="form1" runat="server">
<div>
<input type="button" value="獲取回調結果" onclick="callServer()" />
<span id="result" style="color:Red;"></span>
</div>
</form>
</body>
<script type="text/javascript">
function getCallbackResult(result) {
document.getElementById("result").innerHTML = result;
}
</script>
後台程式碼:
public partial class Test1 : System.Web.UI.Page, ICallbackEventHandler {
protected void Page_Load(object sender, EventArgs e) {
// 客戶端腳本 Manager
ClientScriptManager scriptMgr = this.ClientScript;
// 取得回調函數,getCallbackResult 就是回調函數
string functionName = scriptMgr.GetCallbackEventReference(this, "", "getCallbackResult", "");
// 發起請求的腳本,callServer 就是點擊按鈕事件的執行函式
string scriptExecutor = "function callServer(){" + functionName + ";}";
// 註冊腳本
scriptMgr.RegisterClientScriptBlock(this.GetType(), "callServer", scriptExecutor, true);
}
// 介面方法
public string GetCallbackResult() {
return "callback result";
}
// 介面方法
public void RaiseCallbackEvent(string eventArgument) { }
}
這種方式有以下缺點:
1. 實現起來較複雜,每個頁面 Load 事件都要去註冊相應的腳本。
2. 前台會生成一個用於代理的腳本文件。
3. 對於頁面互動複雜的,實現起來非常麻煩。
4. 雖然是回調,但此時頁面物件還是生成了。
3.3 使用一般處理常式
一般處理常式其實是一個實現了 IHttpHandler 介面類,與頁面類一樣,它也可以用於處理請求。一般處理常式通常用於生成 HTML,也沒有複雜的事件機制,只有一個 ProcessRequest 入口用於處理請求。我們可以將 Ajax 請求位址寫成 .ashx 文件的路徑,這樣就可以處理了,而且效率比較高。要輸出文字內容只需要 Response.Write(data) 即可,例如從資料庫取得資料後,序列化為 JSON 格式字串,然後輸出。如果要生成 HTML,可以透過載入使用者控制項生成:
public void ProcessRequest(HttpContext context) {
Page page = new Page();
Control control = page.LoadControl("~/PageOrAshx/UserInfo.ascx");
if (control != null) {
StringWriter sw = new StringWriter();
HtmlTextWriter writer = new HtmlTextWriter(sw);
control.RenderControl(writer);
string html = sw.ToString();
context.Response.Write(html);
}
}
這種方式的優點是輕量、高效;缺點是對於互動多的需要定義許多 ashx 文件,加大了管理和維護成本。
3.4 頁面基類
將處理 Ajax 請求的方法定義在頁面物件內,這樣每個頁面就可以專注處理本頁面相關的請求了。這裡有幾點需要注意。
1. 如何知道這個請求是 Ajax 請求?
透過請求標頭 X-Requested-With:XMLHttpRequest 可以判斷,大部分瀏覽器的非同步請求都會包含這個請求標頭;也可以透過自訂請求標頭實現,例如 AjaxFlag:XHR。
2. 在哪裡統一處理?
如果在每個頁面類裡判斷和呼叫是很麻煩的,所以將這個處理過程轉到一個頁面基類裡處理。
3. 如何知道呼叫的是哪個方法?
透過傳參或定義在請求標頭都可以,例如 MethodName:GetData。
4. 知道方法名稱了,如何動態呼叫?
反射。
5. 如何知道該方法可以被外部呼叫?
可以認為 public 型別的就可以被外部呼叫,也可以透過標記屬性標記。
透過上面的分析,簡單實現如下。
頁面基類:
public class PageBase : Page {
public override void ProcessRequest(HttpContext context) {
HttpRequest request = context.Request;
if (string.Compare(request.Headers["AjaxFlag"], "AjaxFlag", 0) == 0) {
string methodName = request.Headers["MethodName"];
if (string.IsNullOrEmpty(methodName)) {
EndRequest("MethodName 標記不能為空!");
}
Type type = this.GetType().BaseType;
MethodInfo info = type.GetMethod(methodName, BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static);
if (info == null) {
EndRequest("找不到合適的方法調用!");
}
string data = info.Invoke(this, null) as string;
EndRequest(data);
}
base.ProcessRequest(context);
}
private void EndRequest(string msg) {
HttpResponse response = this.Context.Response;
response.Write(msg);
response.End();
}
}
頁面類:
public partial class Test1 : PageBase {
protected void Page_Load(object sender, EventArgs e) { }
public string GetData() {
return "213";
}
}
前台程式碼:
function getData() {
$.ajax({
headers: { "AjaxFlag": "XHR", "MethodName": "GetData" },
success: function (data) {
$("#result").text(data);
}
});
}
四、優化版頁面基類
上面的頁面基類功能很少,而且透過反射這樣呼叫的效率很低。這裡優化一下:
1. 可以支援簡單型別的參數。例如上面的 GetData 可以是 GetData(string name),透過函式元資料可以取得相關的參數,再根據請求的參數,就可以設定參數了。
2. 加入標記屬性。只有被 AjaxMethodAttribute 標記的屬性才能被外部呼叫。
3. 優化反射。利用緩存,避免每次都根據函式名稱去搜尋函式資訊。
標記屬性:
public class AjaxMethodAttribute : Attribute { }
緩存物件:
public class CacheMethodInfo {
public string MethodName { get; set; }
public MethodInfo MethodInfo { get; set; }
public ParameterInfo[] Parameters { get; set; }
}
基類程式碼:
public class PageBase : Page {
private static Hashtable _ajaxTable = Hashtable.Synchronized(new Hashtable());
public override void ProcessRequest(HttpContext context) {
HttpRequest request = context.Request;
if (string.Compare(request.Headers["AjaxFlag"], "XHR", true) == 0) {
InvokeMethod(request.Headers["MethodName"]);
}
base.ProcessRequest(context);
}
/// <summary>
/// 反射執行函式
/// </summary>
/// <param name="methodName"></param>
private void InvokeMethod(string methodName) {
if (string.IsNullOrEmpty(methodName)) {
EndRequest("MethodName 標記不能為空!");
}
CacheMethodInfo targetInfo = TryGetMethodInfo(methodName);
if (targetInfo == null) {
EndRequest("找不到合適的方法調用!");
}
try {
object[] parameters = GetParameters(targetInfo.Parameters);
string data = targetInfo.MethodInfo.Invoke(this, parameters) as string;
EndRequest(data);
} catch (FormatException) {
EndRequest("參數型別匹配發生錯誤!");
} catch (InvalidCastException) {
EndRequest("參數型別轉換發生錯誤!");
} catch (ThreadAbortException) {
} catch (Exception e) {
EndRequest(e.Message);
}
}
/// <summary>
/// 取得函式元資料並緩存
/// </summary>
private CacheMethodInfo TryGetMethodInfo(string methodName) {
Type type = this.GetType().BaseType;
string cacheKey = type.AssemblyQualifiedName;
Dictionary<string, CacheMethodInfo> dic = _ajaxTable[cacheKey] as Dictionary<string, CacheMethodInfo>;
if (dic == null) {
dic = new Dictionary<string, CacheMethodInfo>();
MethodInfo[] methodInfos = (from m in type.GetMethods(BindingFlags.Public | BindingFlags.Instance | BindingFlags.Static)
let ma = m.GetCustomAttributes(typeof(AjaxMethodAttribute), false)
where ma.Length > 0
select m).ToArray();
foreach (var mi in methodInfos) {
CacheMethodInfo cacheInfo = new CacheMethodInfo();
cacheInfo.MethodName = mi.Name;
cacheInfo.MethodInfo = mi;
cacheInfo.Parameters = mi.GetParameters();
dic.Add(mi.Name, cacheInfo);
}
_ajaxTable.Add(cacheKey, dic);
}
CacheMethodInfo targetInfo = null;
dic.TryGetValue(methodName, out targetInfo);
return targetInfo;
}
/// <summary>
/// 取得函式參數
/// </summary>
private object[] GetParameters(ParameterInfo[] parameterInfos) {
if (parameterInfos == null || parameterInfos.Length <= 0) {
return null;
}
HttpRequest request = this.Context.Request;
NameValueCollection nvc = null;
string requestType = request.RequestType;
if (string.Compare("GET", requestType, true) == 0) {
nvc = request.QueryString;
} else {
nvc = request.Form;
}
int length = parameterInfos.Length;
object[] parameters = new object[length];
if (nvc == null || nvc.Count <= 0) {
return parameters;
}
for (int i = 0; i < length; i++) {
ParameterInfo pi = parameterInfos[i];
string[] values = nvc.GetValues(pi.Name);
object value = null;
if (values != null) {
if (values.Length > 1) {
value = String.Join(",", values);
} else {
value = values[0];
}
}
if (value == null) {
continue;
}
parameters[i] = Convert.ChangeType(value, pi.ParameterType);
}
return parameters;
}
private void EndRequest(string msg) {
HttpResponse response = this.Context.Response;
response.Write(msg);
response.End();
}
}
頁面類:
public string GetData3(int i, double d, string str) {
string[] datas = new string[] { i.ToString(), d.ToString(), str };
return "參數分別是:" + String.Join(",", datas);
}
前台程式碼:
function getData3() {
$.ajax({
headers: { "AjaxFlag": "XHR", "MethodName": "GetData3" },
data: { "i": 1, "d": "10.1a", "str": "hehe" },
success: function (data) {
$("#result").text(data);
}
});
}
五、總結
上面的頁面基類已經具備可以完成基本的功能,但它還不夠好,主要有:
1. 依附在頁面基類。對於本來有頁面基類的,無疑會變得更加複雜,我們希望把它獨立開來,變成一個單獨的組件。
2. 效率問題。反射的效率很低,尤其在 Web 這類應用程式上,更應該慎用。以動態執行函式為例,效率主要低在:a. 根據字串動態查找函式的過程;b. 執行函式時,反射內部需要將參數打包成一個陣列,再將參數解析到執行緒堆疊上,在呼叫前 CLR 還要檢測參數的正確性,再判斷有沒有權限執行。上面的優化其實只優化了一半,也就是優化了查找的過程,而 Invoke 同樣會有效能損失。當然,隨著 .net 版本越高,反射的效率也會有所提升,但這種動態的東西,始終是用效率換取靈活性的。
3. 不能支援複雜參數。有時候參數比較多,函式參數一般會封裝成一個物件型別。
4. AjaxMethodAttribute 只是一個空的標記屬性。我們可以為它加入一些功能,例如標記函式的名稱、是否使用 Session、緩存設定等都可以在這裡完成。
用過 WebForm 的朋友可能會提到 AjaxPro 組件,這是一個開源的組件,下一篇就透過原始碼了解這個組件,借鑒它的處理過程,並分析它的優缺點。