因為專案需要,折騰了一整天之後,終於做出一個能回傳 JSON 資料的服務端。貼出來有兩個目的:一是請大家看看還有哪裡可以優化;二是免得其他 ASP.NET 開發者為了找這類程式碼而鬱悶。
整個實作分四個部分:一個負責組出 JSON 的幫助類、一個輸出 JSON 的服務端頁面、一個承載結果的客戶端頁面,以及前端 JavaScript。
這個類別同時提供兩種能力:一是用 JavaScriptSerializer 做通用序列化,二是用 StringBuilder 手工組出適合 ExtJS 分頁格式的 JSON。
using System;
using System.Collections;
using System.Text;
using System.Web.Script.Serialization;
/// <summary>
/// JSONHelper 的摘要說明
/// </summary>
public class JSONHelper
{
// 對應 JSON 的 singleInfo 成員
public string singleInfo = string.Empty;
protected string _error = string.Empty;
protected bool _success = true;
protected long _totalCount = 0;
protected ArrayList arrData = new ArrayList();
public JSONHelper() { }
public static string ToJSON(object obj)
{
JavaScriptSerializer serializer = new JavaScriptSerializer();
return serializer.Serialize(obj);
}
public static string ToJSON(object obj, int recursionDepth)
{
JavaScriptSerializer serializer = new JavaScriptSerializer();
serializer.RecursionLimit = recursionDepth;
return serializer.Serialize(obj);
}
// 對應於 JSON 的 success 成員
public bool success
{
get { return _success; }
set
{
// 設為 true 則清空 error
if (value) _error = string.Empty;
_success = value;
}
}
// 對應於 JSON 的 error 成員
public string error
{
get { return _error; }
set
{
// 設定 error 則自動把 success 設為 false
if (value != "") _success = false;
_error = value;
}
}
public long totlalCount
{
get { return _totalCount; }
set { _totalCount = value; }
}
// 重置,每次新產生一個 JSON 物件時必須執行
public void Reset()
{
_success = true;
_error = string.Empty;
singleInfo = string.Empty;
arrData.Clear();
}
public void AddItem(string name, string value)
{
arrData.Add("\"" + name + "\":\"" + value + "\"");
}
public void ItemOk() { arrData.Add("<BR>"); }
// 序列化 JSON 物件,得到回傳的 JSON 碼
public override string ToString()
{
StringBuilder sb = new StringBuilder();
sb.Append("{");
sb.Append("totalCount:" + totlalCount.ToString() + ",");
sb.Append("success:" + _success.ToString().ToLower() + ",");
sb.Append("error:\"" + _error.Replace("\"", "\\\"") + "\",");
sb.Append("singleInfo:\"" + singleInfo.Replace("\"", "\\\"") + "\",");
sb.Append("data:[");
int index = 0;
sb.Append("{");
if (arrData.Count <= 0)
{
sb.Append("}]");
}
else
{
foreach (string val in arrData)
{
index++;
if (val != "<BR>")
{
sb.Append(val + ",");
}
else
{
sb = sb.Replace(",", "", sb.Length - 1, 1);
sb.Append("},");
if (index < arrData.Count) sb.Append("{");
}
}
sb = sb.Replace(",", "", sb.Length - 1, 1);
sb.Append("]");
}
sb.Append("}");
return sb.ToString();
}
}
這個設計有個聰明之處:success 與 error 兩個 setter 互相牽制——設了 error 就自動把 success 轉為 false,設了 success 為 true 就清空 error,避免兩者狀態不一致。
接著建立一個 ASX 頁面作為服務端,從 ExtJS 傳來的 start 與 limit 參數取出分頁資訊,查詢資料後輸出 JSON。
using System;
using System.Data;
using System.Data.SqlClient;
using System.Text;
using System.Web;
namespace ExtJSDemo.Data
{
public partial class PagingRequest : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
// ExtJS Paging 必須指定的參數:從第幾筆記錄開始(ExtJS 預設 0 為第一行)
int start = Convert.ToInt32(Request["start"].ToString());
// ExtJS Paging 必須指定的參數:每頁顯示幾筆
int limit = Convert.ToInt32(Request["limit"].ToString());
JSONHelper jsonHelp = new JSONHelper();
int TotalRecords = 0;
DataSet DSet = GET_Product_Data(start, limit, out TotalRecords);
jsonHelp.success = true;
jsonHelp.totlalCount = TotalRecords; // 記錄總數
if (DSet != null)
{
DataTable DTable = DSet.Tables[0];
for (int i = 0; i < DTable.Rows.Count; i++)
{
jsonHelp.AddItem("Id", DTable.Rows[i]["Id"].ToString());
jsonHelp.AddItem("Name", DTable.Rows[i]["Name"].ToString());
jsonHelp.AddItem("StreetPrice", DTable.Rows[i]["StreetPrice"].ToString());
jsonHelp.AddItem("TypeName", DTable.Rows[i]["TypeName"].ToString());
jsonHelp.ItemOk();
}
}
Response.Write(jsonHelp.ToString()); // 輸出 JSON 碼
}
/// <summary>
/// 取得分頁資料
/// </summary>
/// <param name="start">記錄索引</param>
/// <param name="limit">每頁筆數</param>
/// <param name="TotalRecords">總記錄數</param>
public DataSet GET_Product_Data(int start, int limit, out int TotalRecords)
{
SqlConnection _Connection = null;
SqlDataAdapter _Adapter = null;
DataSet DSet = null;
try
{
_Connection = new SqlConnection(
System.Configuration.ConfigurationManager.AppSettings["SQLConnString"].ToString());
_Connection.Open();
_Adapter = new SqlDataAdapter("SELECT [Id] FROM [Product]", _Connection);
DSet = new DataSet();
_Adapter.Fill(DSet);
TotalRecords = Convert.ToInt32(DSet.Tables[0].Rows.Count);
if (TotalRecords < 1) return null; // 沒有記錄
int pageLowerBound = start + 1; // 從第幾筆開始
int pageUpperBound = pageLowerBound + limit;
StringBuilder sb = new StringBuilder();
if (TotalRecords >= pageLowerBound)
{
for (int i = pageLowerBound;
i < TotalRecords && i < pageUpperBound; i++)
{
// 組出 ID in() 條件,取其中一頁
sb.AppendFormat("'{0}',", DSet.Tables[0].Rows[i - 1][0].ToString());
}
}
else
{
return null; // 沒有記錄
}
if (sb.Length > 1) sb.Remove(sb.Length - 1, 1); // 刪掉最後一個逗號
StringBuilder strSql = new StringBuilder();
strSql.Append("SELECT a.[Id], a.[Name], a.[StreetPrice], b.TypeName ");
strSql.Append("FROM [Product] as a left join ProductType as b on a.Typeid = b.Typeid ");
strSql.AppendFormat("where a.[Id] in({0})", sb.ToString());
_Adapter = new SqlDataAdapter(strSql.ToString(), _Connection);
DSet = new DataSet();
_Adapter.Fill(DSet);
}
finally
{
if (_Connection != null && _Connection.State == ConnectionState.Open)
_Connection.Close();
}
return DSet;
}
}
}
這裡有個明顯的效能問題值得指出:查詢先撈出整張表的所有 Id、在記憶體中切出一頁、再用 IN 子句回查該頁資料,等於多跑了一趟資料庫。實務上建議改用 ROW_NUMBER()(SQL Server 2005 以上)或 OFFSET ... FETCH 直接在資料庫端分頁,並搭配 COUNT(*) 取得總筆數。此外,把 Id 字串直接拼進 SQL 是有 SQL 注入風險的寫法,應改用參數化查詢。
最後是一個簡單的 ASPX 頁面,載入 ExtJS 的樣式與程式庫,在 Ext.onReady 中啟動自訂的 PagingGridPanel:
<head id="Head1" runat="server">
<title></title>
<link rel="stylesheet" type="text/css" href="../ext3/resources/css/ext-all.css" />
<script type="text/javascript" src="../ext3/adapter/ext/ext-base.js"></script>
<script type="text/javascript" src="../ext3/ext-all.js"></script>
<script type="text/javascript" src="JS/PagingGridPanel.js"></script>
<script type="text/javascript">
Ext.BLANK_IMAGE_URL = "../ext3/resources/images/default/s.gif";
Ext.onReady(function () {
Ext.QuickTips.init();
Ext.form.Field.prototype.msgTarget = "side";
new PagingGridPanel(); // 見 JS 檔
});
</script>
</head>
第四步自然是寫那支 PagingGridPanel.js:定義 store(指定 root: 'data'、totalProperty: 'totalCount' 對應服務端輸出的欄位)、colModel 與 pageSize,並把 proxy 指向 PagingRequest.aspx。只要兩端的欄位名稱約定一致,ExtJS 的 PagingGridPanel 就能自動完成分頁與排序。
【完整流程到此】