jQuery調用WebService返回JSON資料及參數設定注意問題

.NET Framework 3.5的發布解決了WebService調用中json問題，本文將介紹jQuery調用基於.NET Framework 3.5的WebService返回JSON資料，另外還要介紹一下用jQuery調用WebService的參數設定及設定不當所出現的問題，還有出現問題的原因

jQuery調用WebService網上的介紹也比較多，最近的項目中我也用到不少，一直都很少用.NET Ajax，比較鐘情於jQuery調用請求WebService有幾種方法，這主要說一下POST與GET方法，其實安全方法考慮不建議使用GET方法，下面就說一下用jquery調用WebService的參數設定及設定不當所出現的問題，還有出現問題的原因。我們這裡只討論返回JSON資料的情況，相信大家都比較瞭解JSON格式的資料對於ajax的方便，不瞭解的可以從網上找一下這方面的資料來看一下，這裡就不多說了，或者我以後再寫一篇這方面的文章。

下面是jQuery調用WebService伺服器端代碼：

WS1和WS2方法為POST方法請求的方法，所以設定UseHttpGet 為false，WS3與WS4為GET方法請求的方法，設定UseHttpGet 為true。

複製代碼 代碼如下:using System.Web.Script.Services;
using System.Web.Services;
namespace WebService35
{
///
/// WebService1 的摘要說明
///
[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[System.ComponentModel.ToolboxItem(false)]
// 若要允許使用 ASP.NET AJAX 從指令碼中調用此 Web 服務，請取消對下行的注釋。
[System.Web.Script.Services.ScriptService]
public class WebService1 : System.Web.Services.WebService
{
[WebMethod]
[ScriptMethod(UseHttpGet = false)]
public string WS1()
{
return "POST無參數";
}
[WebMethod]
[ScriptMethod(UseHttpGet = false)]
public string WS2(string s)
{
return s;
}
[WebMethod]
[ScriptMethod(UseHttpGet = true)]
public string WS3()
{
return "GET無參數";
}
[WebMethod]
[ScriptMethod(UseHttpGet = true)]
public string WS4(string s)
{
return s;
}
}
}

複製代碼 代碼如下:function fun1() {
$.ajax({
url: "WebService1.asmx/WS1",
type: "POST",
dataType: "json",
contentType: "application/json; charset=utf-8",
data: "",
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

上面的JS方法為用POST方法請求無參數的WebService方法的代碼，不過以上代碼並不能返回正確的JSON格式的資料，而是返回XML格式的資料，回為要使WebService返回JSON格式的資料，要在Request Headers中設定Content-Type為application/json，有人要問了，你不設定了contentType為 “application/json; charset=utf-8”了嗎？沒錯，是設定了，不過在jquery中，如果Content-Length為0或者沒有設定，它會忽略你設定的 contentType的，我可以看下面的這個圖，這是抓取的Request Headers的資料，可以看到Content-Length為0，並且沒有Content-Type，所WebService就不知道我們需要JSON 格式的資料，它就返回了預設的XML格式的資料給我們，之所以為0，是因為我沒有提交任何資料。

這要怎麼辦呢？繼續看下面的JS代碼，因為我們這裡是調用的一個沒能參數的WebService方法，所以我們可以提交一個空和JSON對象“{}"，如下所示，設定data為{}。

複製代碼 代碼如下:function fun1() {
$.ajax({
url: "WebService1.asmx/WS1",
type: "POST",
dataType: "json",
contentType: "application/json; charset=utf-8",
data: "{}",
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

現在我再來看，可以看到，Content-Length已經為2了，並且也有Contetn-Type，還是我們設定的值，這樣就能正確的返回JSON資料給我們使用了。

還有一種方法就是：既然jquery不給我們設定Content-Type，我們可以自己設定，如下面的代碼所示，我們在發送資料之前設定一下Content-Type為“application/json; charset=utf-8”，這樣就可以了。

複製代碼 代碼如下:function fun1() {
$.ajax({
url: "WebService1.asmx/WS1",
type: "POST",
dataType: "json",
data: "",
beforeSend: function(x) {
x.setRequestHeader("Content-Type", "application/json; charset=utf-8");
},
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

下面是我們手工設定了Content-Type之後抓取的Request Headers，可以看到，即使Content-Length為0，裡面也有了正確的Content-Type了。

不過，需要注意的是：如果我們設定了jquery的contentType，又發送了一個空的JSON對象，並且還手工設定了Content-Type，就如下代碼所示：

複製代碼 代碼如下:function fun1() {
$.ajax({
url: "WebService1.asmx/WS1",
type: "POST",
dataType: "json",
contentType: "application/json; charset=utf-8",
data: "{}",
beforeSend: function(x) {
x.setRequestHeader("Content-Type", "application/json; charset=utf-8");
},
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

那麼在IE發送的Requst Headers就如所示，你會看到Content-Type有兩個用逗號隔開的值，這是為什麼呢？因為，jquery為Content-Type設定了一次值，我們手工又設定一次，而在IE是多次設定Content-Type的值它會追加，而不是替換，不過這並不影響WebService正確返回 JSON資料給我們，不過應該避免這種情況出現。

如果說上面那種設定兩次Content-Type的值還能正確的返回JSON資料，那麼下面代碼就不能正確返回JSON資料了。

複製代碼 代碼如下:function fun1() {
$.ajax({
url: "WebService1.asmx/WS1",
type: "POST",
dataType: "json",
data: "{}",
beforeSend: function(x) {
x.setRequestHeader("Content-Type", "application/json; charset=utf-8");
},
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

從可以看到Content-Type也有兩個值，不過這個和上面那個還有點不一樣，這次呢這個值是不一樣的，一個是 application/x-www-form-urlencoded，一個是application/json; charset=utf-8，這種情況就不能正確的返回JSON格式的資料了。這又是為什麼呢？這是因為我們沒有為jquery設定 contentType為，並且又提交了一個空的JSON對象，可以為什麼這樣就會使用Content-Type出現這樣的情況的呢？因為jquery的 ajax用POST方法提交資料的時候，如果沒有設定contentType，並且所發送的資料不為空白，那麼它就會為ContentType設定一個預設值，也就是application/x-www-form-urlencoded，所以就會出現這種情況了。

所以呢，在用POST方法請求的時候，如果有提交資料，也就是jquery ajax的datar屬性不空的情況下（不為空白的情況：1.發送一個Null 物件調用無參數的WebService方法；2.請一個有參數的 WebService方法。），一定要設定contentType屬性，並且不能手工設定Content-Type了。

下面是請求有參數的WebService方法，一些情況在上面也都說過了，這裡就不多說了。

不過有一點要注意，就是用POST方法請求的時候，不用手工去編碼有漢字的參數值，如下面的data: "{s:'POST有參數'}"，就不用寫成data: "{s:"+encodeURI('POST有參數')+"}"了。

複製代碼 代碼如下:function fun2() {
$.ajax({
url: "WebService1.asmx/WS2",
contentType: "application/json; charset=utf-8",
type: "POST",
dataType: "json",
data: "{s:'POST有參數'}",
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText); ;
},
complete: function(x) {
alert(x.responseText);
}
});
}

以上是我們說的用POST方法請求，下面是用GET方法請求。

下面是一個用GET方法請求一個無參數的WebService方法，不過這是一段錯誤的代碼，錯在哪兒呢，各們童鞋可以自己想一下，我們下面一起說。

複製代碼 代碼如下:function fun3() {
$.ajax({
url: "WebService1.asmx/WS3",
type: "GET",
dataType: "json",
data: "",
contentType: "application/json; charset=utf-8",
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

是用上面一段代碼請求所抓取的Request Headers，大家看一下，問題出在哪裡。

下面的代碼是正確的用GET方法調用無參數的WebService方法。

複製代碼 代碼如下:function fun3() {
$.ajax({
url: "WebService1.asmx/WS3",
dataType: "json",
data: "",
beforeSend: function(x) {
x.setRequestHeader("Content-Type", "application/json; charset=utf-8");
},
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

下面的代碼是正確的用GET方法調用有參數的WebService方法。複製代碼 代碼如下:function fun4() {
$.ajax({
url: "WebService1.asmx/WS4",
dataType: "json",
data: encodeURI("s='GET有參數'"),
beforeSend: function(x) {
x.setRequestHeader("Content-Type", "application/json; charset=utf-8");
},
success: function(json) {
alert(json.d);
},
error: function(x, e) {
alert(x.responseText);
},
complete: function(x) {
alert(x.responseText);
}
});
}

是正確的用GET方法(有參數和無參數）調用WebService方法所抓取的Request Headers。

從可以看到，用GET方法請求，不管是有參數還是無參數，都是沒有Content-Length的，所以jquery也就不能為我們設定 Content-Type了，我只能手工設定Content-Type，所以我們也就沒有必要設定jquery ajax的contentType了。

需要注意的是，GET方法與POST方法不同，有參數的時候，如果參數的值不是ASCII字元，要用encodeURI編一下碼，要不服務端接收到的資料為亂碼。