在前端呼叫 WebService 時,可選擇 JSON 或 XML 作為資料格式。JSON 與 JavaScript 的整合較自然,因此常用於輕量級請求。
function getXmlHttp() {
var xmlHttp;
if (window.XMLHttpRequest) {
xmlHttp = new XMLHttpRequest();
} else {
xmlHttp = new ActiveXObject('Microsoft.XMLHTTP');
}
return xmlHttp;
}若使用 JSON,通常要把請求送到 asmx 頁面加上方法名稱的位址,並設定 Content-Type 為 application/json。
function webserviceJson(url, method, data, callback) {
var xhr = getXmlHttp();
xhr.open('POST', url + '/' + method, true);
xhr.onreadystatechange = function() {
if (xhr.readyState === 4 && xhr.status === 200) {
callback(xhr.responseText);
}
};
xhr.setRequestHeader('Content-Type', 'application/json; charset=utf-8');
xhr.send(data);
}呼叫時,data 可傳入 JSON 字串。
webserviceJson('/WebService1.asmx', 'HelloWorld', '{}', function(msg) {
console.log(msg);
});若改用 XML,Content-Type 要設為 text/xml,且 SOAPAction 通常需要包含命名空間。此外,POST 位址不再加上方法名稱。
實作時可把常用設定封裝成 options 物件,例如 namespace、method、contentType、dataType、data 與 callback。這樣能讓呼叫端更清楚,也方便日後維護。
JSON 模式下,url 後面通常需要加上方法名稱;XML 模式下,url 後面則不加方法名稱,且 SOAPAction 不可省略。若服務端回傳 DataTable,JSON 模式可能無法直接序列化,需先轉成 List 或自訂資料物件。
另一種替代方式,是使用 application/x-www-form-urlencoded,並以名稱值對形式送出參數。這種方式較簡單,但彈性不如 JSON 或 SOAP XML。