用JSON做数据传输格式中的一些问题总结_json

向客户端提供JSON数据的方式
一. 用WCF提供Json数据
用WCF向客户端提供Json数据我们需要注意,
A. 契约的定义, 在WebInvokeAttribute 或者 WebGetAttribute中的ResponseFormat设置为WebMessageForm.Json,

复制代码 代码如下:

[WebInvoke(Method = "POST", ResponseFormat = WebMessageFormat.Json, RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Bare)]
[WebGet(ResponseFormat = WebMessageFormat.Json, UriTemplate = "IsExistSSID/{SSID}", RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Bare)]

B. EndPointBehavior使用WebHttp

复制代码 代码如下:

C. Binding 方式使用webHttpBinding

复制代码 代码如下:

binding="webHttpBinding" contract="DeviceUIServiceContract" />

二. 用.Net MVC Action提供 JSON 数据
1. 在ValueProviderFactories.Factories.Add(new JsonValueProviderFactory())中加入 Json 数据的处理, MVC 3默认是加入的, 如果你使用的是 MVC3， 则无需理会这一点.
2. 采用JsonResult作为你Action的返回值。
3.返回是使用return Json(XXX); XXX为你要返回的数据，其数据类型必须为可序列化类型.
三. 可采用以asmx为后缀名的简单WebService来实现,
四. 使用HttpHandler机制来实现.
因为WCF已被微软定义为微软系下的通信平台，而后两种随可以实现，但是是较早的实现方式，所以在此我使用了WCF,直接把所提供的数据，视作系统的数据提供接口.
而在.NET MVC的环境里, 已经直接支持输出 Json 形式的数据，所以在非.NET MVC的环境选择WCF提供， 而在.NET MVC环境直接选择用JSON Action支持.
WEB客户端处理
用JQuery Ajax处理
把 dataType设置为 'json' 格式，在接收数据时会自动把result转换为json object格式.

复制代码 代码如下:

$.ajax({
url: ‘urladdress'
type: 'GET',
contentType: 'application/json',
dataType: 'json',
cache: false,
async: false,
error: JQueryAjaxErrorHandler,
success: function (result) { }
});

异常处理的考虑

在这里我主要考虑在Web环境下异常的处理, 根据HTTP协议的定义, 每次请求都会返回一个 HTTP Status Code , 不同的Code代表了不同的意义。因此我们的Web应用程序也应该是这样，根据不同的结果返回不同的 HTTP Status Code , 比如200,代表服务端正确的返回，417代表我们期望的服务端异常，404，请求不存在等， 以及301我们的未授权。

在WCF环境下，我们首先要给每个方法添加 FaultContract, 如下:
FaultContract(typeof(WebFaultException))
其次我们要对异常做一些处理，让服务端能返回正确的HTTP Status Code.

复制代码 代码如下:

尝试
{
//BussinessCode.....
}
catch (DuplicateException ex)
{
抛出新的 WebFaultJsonFormatException(new WebErrorDetail （例如消息，例如），HttpStatusCode.ExpectationFailed）；
}
catch (NotExistException ex)
{
抛出 new WebFaultJsonFormatException(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed);
}
catch (AppException ex)
{
抛出 new WebFaultJsonFormatException(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed);
}
catch (异常 ex)
{
抛出 new WebFaultJsonFormatException(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed);
}
其中WebFaultJsonFormatException的如下签名：
[Serialized, DataContract]
public class WebFaultJsonFormatException; :WebFaultException;
{
public WebFaultJsonFormatException(T 详细信息, HttpStatusCode statusCode)
: base(detail, statusCode)
{
ErrorDetailTypeValidator(detail);
}
public WebFaultJsonFormatException(TDetail, HttpStatusCode statusCode, IEnumerableknownTypes)
: base(detail, statusCode,knownTypes)
{
ErrorDetailTypeValidator(detail);
}
private void ErrorDetailTypeValidator(Tdetail)
{
foreach (DataContractAttribute 项目详细信息.GetType().GetCustomAttributes(typeof(DataContractAttribute), true))
{
if (item.IsReference)
抛出 new WebFaultJsonFormatException(new PureWebErrorDetail("当传输代码类型为 JSON fromat 时，应用于 {0} 的 DataContractAttribute 属性 'IsReference' 不能为 true。", typeof(T ).FullName), HttpStatusCode.ExpectationFailed);
}
}
}
[可序列化，DataContract(IsReference = false)]
public class PureWebErrorDetail
{
public PureWebErrorDetail(string message, params object[] args)
{
this.Message = string.Format(message, args);
}
[DataMemberAttribute]
public string Message { get;放; }
}

因为我们在JSON做数据传输的时候，DataContract中的IsReference是不可以为true的，其意思是相对于XML的，XML是可以支持数据的循环引用，而JSON是不支持的，所以WebFaultJsonFormatException的作用就在于判断我们当前的JSON数据类型的DataContract的IsReference是否为true，如果是，则返回一个我们定义好的错误信息。 如果没有采用这个定义，JQUery Ajax 相应问题接收到的 HTTP Status Code 是 15??? 的一个错误代码，但是这个错误代码不是我们正常的 HTTP Status Code范围.

异常处理的一个误区
最早的时候，由于本来用这个方式处理，也是长期以来写代码犯下的一个弊病，给每个方法加了一个固定的泛型返回值类型

复制代码 代码如下：

[DataContract]
public class TmResult
{
[DataMember]
public bool Success { get;放; }

[DataMember]
public string ErrorMessage { get;放; }

[DataMember]
public string FullMessage { get;放; }

[DataMember]
public string CallStack { get;放; }
}

[DataContract]
公共类 TmResult; : TmResult
where T : class
{
[DataMember]
public T Model { get;放; }
}

每次返回都会有一个Success代表成功是否，ErrorMessage代表Error情况下的错误信息，这样的方式其实就是每次返回的HTTP Status Code都是200 ，后来知道想到上面的解决办法之后，才觉得我们更本不需要搞这么复杂，既然是Web，那干吗不把程序写的更符合HTTP协议的定义，那样岂不是更简单。

所以这里也了解了各种标准的好处，熟悉标准，熟悉编程模型及各种API，我们的开发会更简单，更轻松。
以上都是按个人理解所写，有不当之处请指正。