本文示範一條經典的無刷新資料交換路徑:瀏覽器端用 XMLHTTP 物件送出請求,伺服器端在 C# 裡以 DataSet 完成資料庫查詢並把結果序列化成 XML 回傳,最後由 XMLDOM 在客戶端解析這份 XML,取出需要的欄位做進一步處理。
整體流程
- 客戶端以 XMLHTTP 向伺服器頁面發出請求。
- 伺服器頁面在後端用 C# 的 DataSet 操作資料庫,取得結果集。
- 伺服器把 DataSet 轉為 XML 字串輸出。
- 客戶端用 XMLDOM 取得 XMLHTTP 回傳的 XML,並操作其中的節點。
一、客戶端送出 XMLHTTP 請求
var xmlhttp = new ActiveXObject("Microsoft.XMLHTTP");
xmlhttp.open("GET", "Default2.aspx", false, "", "");
xmlhttp.send();
這裡採同步模式(第三個參數為 false),指令碼會停在 send() 之後等伺服器回應。若改成 true,就必須改用 onreadystatechange 事件,在 readyState 等於 4 時再處理回應。
二、伺服器端:用 DataSet 產生 XML
protected void Page_Load(object sender, EventArgs e)
{
// 連接資料庫
SqlConnection myConn = new SqlConnection("Data Source=192.168.0.36;Initial Catalog=Northwind;User ID=sa;PassWord=sa");
SqlDataAdapter myda = new SqlDataAdapter("select top 5 * from orders", myConn);
DataSet myds = new DataSet();
myConn.Open();
myda.Fill(myds);
myConn.Close();
// 把 XML 物件輸出給客戶端
Response.ContentType = "text/xml";
Response.Write(myds.GetXml());
Response.End();
}
幾個實務上要注意的地方:連線字串中的帳號密碼不該寫死在原始碼裡,建議移到 web.config 的加密區段;存取資料庫應改用 using 區塊或 try/finally 確保連線釋放;查詢條件若來自使用者輸入,請改用 SqlParameter 參數化,避免 SQL injection。DataSet 的 GetXml() 會直接吐出結構化的 XML,省下手動拼字串的麻煩。
三、客戶端:以 XMLDOM 解析結果
// 取得伺服器回傳的 XML 物件
var xmldom = new ActiveXObject("Microsoft.XMLDOM");
xmldom.async = false;
var pi = xmldom.createProcessingInstruction("xml", " version=\"1.0\" encoding=\"gb2312\"");
xmldom.appendChild(pi);
xmldom.loadXML(xmlhttp.responseXML.xml);
// 透過 XMLDOM 操作節點
var nodes = xmldom.getElementsByTagName("OrderID");
alert(nodes.length);
原範例把 responseXML 直接指派給變數,實際使用時建議先以 loadXML() 載入 XML 文字,並把宣告的變數名統一大小寫(JavaScript 對變數名是大小寫敏感的),否則會出現物件未定義的錯誤。若伺服器端已正確標註 Content-Type 為 text/xml,也可以直接使用 xmlhttp.responseXML.documentElement。
附錄一:XMLHTTP 常用方法與屬性
open 方法
共五個參數,前三個必填,後兩個在需要伺服器端身分驗證時才提供:
- method:HTTP 通訊方式,例如 GET 或 POST。
- url:接收資料的伺服器位址,通常指向 ASP、ASPX 或 CGI 程式。
- async:布林值。true 為非同步,用戶端不必等回應;false 為同步,會等伺服器回覆後才往下執行。
- userid:身分驗證用的帳號。
- password:身分驗證用的密碼。
send 方法
參數型別為 Variant,可以是字串、DOM 樹或任意資料流。非同步模式下,資料送完即結束 send 流程,用戶端可以去做別的事;同步模式則要等伺服器確認後才結束。
readyState 屬性
反映伺服器處理請求的進度,可據此設定對應的事件處理:
- 0:物件已建立,但文件尚未開始載入。
- 1:正在載入(LOADING)。
- 2:已載入部分內容(LOADED)。
- 3:部分內容已可互動(INTERACTIVE)。
- 4:全部完成(COMPLETED),可接受回應。
接收回應的屬性
- responseText:把回應當成純文字字串。
- responseBody:把回應當成 HTML 文件內容。
- responseXML:把回應視為 XML 文件,伺服器回傳 XML 時使用。
- responseStream:把回應視為 Stream 物件。
- status:HTTP 狀態碼,200 代表成功,可作為錯誤判斷依據。
附錄二:XMLDOM(document 物件)
常用屬性
- async:是否允許非同步下載,可讀寫。
- attributes:目前節點的屬性清單。
- childNodes:子節點清單,沒有子節點時回傳 null。
- doctype:文件型別宣告節點,含 DTD;無 DTD 時回傳 null。
- documentElement:文件的根節點。
- firstChild / lastChild:第一個與最後一個子節點。
- nextSibling / previousSibling:前後兄弟節點。
- nodeName:節點名稱字串。
- nodeType:節點型別代碼(1 元素、2 屬性、3 文字、4 CDATA、7 處理指令、8 註解、9 文件等)。
- nodeValue:與節點相關的文字內容,元素節點通常為 null。
- ownerDocument:包含該節點的文件根節點。
- parentNode:父節點。
- parseError:解析錯誤物件,無錯誤時回傳 0。
- readyState:文件載入狀態,0 未初始化、1 載入中、2 已載入、3 互動、4 完成。
- url:最近一次載入成功的 URL。
- validateOnParse:解析時是否驗證文件有效性,可讀寫。
- xml:節點及其所有子節點的 XML 描述,唯讀。
常用方法
- abort():取消進行中的非同步下載,並釋放記憶體中的文件。
- appendChild(newChild):把新節點附加為最後一個子節點。
- cloneNode(deep):複製節點;deep 為 true 時連子節點一起複製。
- createAttribute / createElement / createTextNode / createComment / createCDATASection / createProcessingInstruction / createEntityReference:建立各種類型的新節點,建立後需自行插入文件樹。
- createNode(type, name, nameSpaceURI):建立指定型別、名稱與命名空間的節點。
- getElementsByTagName(tagname):傳回指定標籤名的節點集合,使用 "*" 可取得全部元素。
- hasChildNodes():是否有子節點。
- insertBefore(newChild, refChild):在參考節點之前插入新節點。
- load(url):從指定位置載入 XML 文件,成功回傳 true。
- loadXML(xmlString):直接載入 XML 字串或片段。
- removeChild / replaceChild:移除或取代子節點。
- selectNodes(pattern) / selectSingleNode(pattern):以 XSL 樣式(XPath)查詢節點。
- transformNode(stylesheet):套用 XSL 樣式表轉換節點並回傳結果字串。
- parsed():驗證節點及其子節點是否都已解析。
事件
- ondataavailable:一有可用資料即觸發,但不告知資料量。
- onreadystatechange:readyState 改變時觸發,需搭配 readyState 屬性判斷目前狀態。
兩者都支援三種掛接方式:行內屬性寫法、事件屬性指派,以及具名腳本 <SCRIPT FOR="物件" EVENT="事件名稱">。