作为一种以HTTP协议为基础的WCF 服务，只要客户端能模拟进行HTTP请求，都能成为服务的消费者。之前写过《对Jquery+JSON+WebService的一点认识》，觉得在REST是基于HTTP协议的，AJAX的操作也应该一样。但是事实上还是有些差别的。由于网上资源聊聊无几，因此记录下自己的个人体会。希望对你有些帮助！
本篇主要讲述的类容为在ASP.NET中，如何通过AJAX来消费REST服务。
使用JQuery框架模拟AJAX请求时，操作类型主要有GET、POST两种。本节也以这两种常用的方式来进行介绍。（type (String) : (默认: “GET”) 请求方式 (“POST” 或 “GET”)， 默认为 “GET”。注意：其它 HTTP 请求方法，如 PUT 和 DELETE 也可以使用，但仅部分浏览器支持。摘自：JQuery 1.4 API手册）。
- 1、GET请求
- 2、POST请求，简单数据类型
- 3、POST请求，复杂数据类型
Jq+JSON消费REST WCF4.0 服务时，对返回给客户端数据格式，以及客户端传递给服务端数据格式是通过ResponseFormat、RequestFormat 两个枚举类型的指定的。如下代码所示。
服务端实现代码：
01 |
public class AjaxService |
03 |
[WebGet(UriTemplate = "/{id}" |
04 |
,ResponseFormat =WebMessageFormat.Json |
05 |
, RequestFormat = WebMessageFormat.Json)] |
06 |
public Person GetPerson(string id) |
17 |
[WebInvoke(UriTemplate = "/Post" |
18 |
, BodyStyle = WebMessageBodyStyle.WrappedRequest |
19 |
, ResponseFormat = WebMessageFormat.Json |
20 |
, RequestFormat = WebMessageFormat.Json)] |
21 |
public string UpdatePerson(Person person) |
23 |
return person.Id + person.Name + person.Age + person.Phone; |
26 |
[WebInvoke(UriTemplate = "/Rest/Post" |
27 |
, BodyStyle = WebMessageBodyStyle.WrappedRequest |
28 |
, ResponseFormat = WebMessageFormat.Json |
29 |
, RequestFormat = WebMessageFormat.Json)] |
30 |
public string Update(string message) |
32 |
return string.Concat("hello", message); |
客户端实现代码
1、GET请求。
4 |
contentType: "application/json; charset=utf-8", |
5 |
success: function (json) { alert(json.Name) }, |
6 |
error: function (error) { |
7 |
alert("调用出错" + error.responseText); |
效果如下图：
2、POST请求，简单数据类型。
01 |
var jsonMsg = { 'message': 'zhangsan' }; |
02 |
var message = JSON2.stringify(jsonMsg) |
05 |
url: "AjaxService/Rest/Post", |
06 |
contentType: "application/json", |
10 |
success: function (json) { alert(json) }, |
11 |
error: function (error) { |
12 |
alert("调用出错" + error.responseText); |
运行结果如下图：
3、POST请求，复杂数据类型
POST复杂数据类型与简单类型原理是一样的。在Web页面建构JSON数据对象，然后将其转换为JSON的字符串格式。
代码如下：
01 |
var jsonData = { 'person': { 'Id': '36', 'Name': 'zhangsan', 'Age': '27', 'Phone': '01082667896'} }; |
02 |
var message = JSON2.stringify(jsonData) |
05 |
url: "AjaxService/Post", |
06 |
contentType: "application/json; charset=utf-8", |
09 |
success: function (json) { alert(json) }, |
10 |
error: function (error) { |
11 |
alert("调用出错" + error.responseText); |
运行结果如下图：
如同在WebService中一样：客户端上传的JSON字符串格式的数据，会在服务端复杂数据类型中的相应字段中。
这样就通过JQ+JSON完成了与REST WCF的交互。但是有一点需要注意的是：在使用POST操作时，在客户端与服务端交互过程中，需要指定WebMessageBodyStyle、在GET操作时，不论格式，可以不必指定。用途是：指定是否包装参数和返回值。也就是在客户端与服务端的交互过程中，上传给服务端的参数以及服务端回传给客户端的返回值需要做怎样的包装操作。这一点非常重要，否则调用在消费服务是会有异常。
WebMessageBodyStyle的定义如下：
1 |
public enum WebMessageBodyStyle |
MSDN给出的说明如下：
- Bare 不包装请求和响应。
- Wrapped 包装请求和响应。
- WrappedRequest 包装请求，但不包装响应。
- WrappedResponse 包装响应，但不包装请求。
与WebService调用异同总结：
- 1、调用方式一样。
- 2、客户端发送给服务端数据格式略有差别。在WebService中可以通过形如：
data: "{'name':'zhangsan'}",向服务端发送请求，但是这种字符串格式中RESTful中是不被支持的。
- 3、WebService调用结果通过.d获取，即json.d。而在RESTful Service中，直接获取,即json。
- 4、WebService不用指定客户端请求、服务端相应的格式。而在RESTful Service中需要指定
这个过程也不复杂，有此类开发经验的人很容易。但是对初次接触REST开发的人来说还是需要费一番周折的。
参考：
http://www.west-wind.com/weblog/posts/2008/Apr/21/jQuery-AJAX-calls-to-a-WCF-REST-Service
JQuery1.4 API手册
MSDN
Mikel
