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


Posted in Javascript onDecember 21, 2011

向客户端提供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
<behavior name="UIAjaxEndpointBehavior"> 
<webHttp /> 
<PolicyEndPointBehavior /> 
</behavior>

C. Binding 方式使用webHttpBinding
<service name="XX.DeviceUIService" behaviorConfiguration="UIAjaxServiceBehavior"> 
<endpoint address="" behaviorConfiguration="UIAjaxEndpointBehavior" 
binding="webHttpBinding" contract="DeviceUIServiceContract" /> 
</service>

二. 用.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<WebErrorDetail>))
其次我们要对异常做一些处理,让服务端能返回正确的HTTP Status Code.

try 
{ 
//BussinessCode..... 
} 
catch (DuplicateException ex) 
{ 
throw new WebFaultJsonFormatException<WebErrorDetail>(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed); 
} 
catch (NotExistException ex) 
{ 
throw new WebFaultJsonFormatException<WebErrorDetail>(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed); 
} 
catch (AppException ex) 
{ 
throw new WebFaultJsonFormatException<WebErrorDetail>(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed); 
} 
catch (Exception ex) 
{ 
throw new WebFaultJsonFormatException<WebErrorDetail>(new WebErrorDetail(ex.Message, ex), HttpStatusCode.ExpectationFailed); 
} 
其中WebFaultJsonFormatException的签名如下: 
[Serializable, DataContract] 
public class WebFaultJsonFormatException<T> : WebFaultException<T> 
{ 
public WebFaultJsonFormatException(T detail, HttpStatusCode statusCode) 
: base(detail, statusCode) 
{ 
ErrorDetailTypeValidator(detail); 
} 
public WebFaultJsonFormatException(T detail, HttpStatusCode statusCode, IEnumerable<Type> knownTypes) 
: base(detail, statusCode, knownTypes) 
{ 
ErrorDetailTypeValidator(detail); 
} 
private void ErrorDetailTypeValidator(T detail) 
{ 
foreach (DataContractAttribute item in detail.GetType().GetCustomAttributes(typeof(DataContractAttribute), true)) 
{ 
if (item.IsReference) 
throw new WebFaultJsonFormatException<PureWebErrorDetail>(new PureWebErrorDetail("The DataContractAttribute property 'IsReference' which applied on {0} can't be true when the transfer code type is JSON fromat.", typeof(T).FullName), HttpStatusCode.ExpectationFailed); 
} 
} 
} 
[Serializable, DataContract(IsReference = false)] 
public class PureWebErrorDetail 
{ 
public PureWebErrorDetail(string message, params object[] args) 
{ 
this.Message = string.Format(message, args); 
} 
[DataMemberAttribute] 
public string Message { get; set; } 
}

因为我们在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; set; } [DataMember] 
public string ErrorMessage { get; set; } 
[DataMember] 
public string FullMessage { get; set; } 
[DataMember] 
public string CallStack { get; set; } 
} 
[DataContract] 
public class TmResult<T> : TmResult 
where T : class 
{ 
[DataMember] 
public T Model { get; set; } 
}

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

所以在此也体会到各种标准的好处, 熟悉标准,熟悉编程模型及各种API, 我们的开发会更简单,更轻松.
以上都是按个人理解所写,有不对之处请指正.

Javascript 相关文章推荐
默认让页面的第一个控件选中的javascript代码
Dec 26 Javascript
javascript中字符串拼接需注意的问题
Jul 13 Javascript
使用PHP+JQuery+Ajax分页的实现
Apr 23 Javascript
无闪烁更新网页内容JS实现
Dec 19 Javascript
Flash图片上传组件 swfupload使用指南
Mar 14 Javascript
JavaScript检测字符串中是否含有html标签实现方法
Jul 01 Javascript
jQuery判断是否存在滚动条的简单方法
Sep 17 Javascript
Node.js中文件操作模块File System的详细介绍
Jan 05 Javascript
js正则表达式验证表单【完整版】
Mar 06 Javascript
vue增删改查的简单操作
Jul 15 Javascript
基于javascript canvas实现五子棋游戏
Jul 08 Javascript
解决vue 给window添加和移除resize事件遇到的坑
Jul 21 Javascript
40款非常有用的 jQuery 插件推荐(系列一)
Dec 21 #Javascript
这段js代码得节约你多少时间
Dec 20 #Javascript
js实现的仿新浪微博完美的时间组件升级版
Dec 20 #Javascript
非主流的textarea自增长实现js代码
Dec 20 #Javascript
javascript之querySelector和querySelectorAll使用介绍
Dec 20 #Javascript
js有关元素内容操作小结
Dec 20 #Javascript
js汉字排序问题 支持中英文混排,兼容各浏览器,包括CHROME
Dec 20 #Javascript
You might like
关于页面优化和伪静态
2009/10/11 PHP
PHP程序员面试 切忌急功近利(更需要注重以后的发展)
2010/09/01 PHP
PHP遍历并打印指定目录下所有文件实例
2014/02/10 PHP
php密码生成类实例
2014/09/24 PHP
JavaScript 基础篇之运算符、语句(二)
2012/04/07 Javascript
javascript变量作用域使用中常见错误总结
2013/03/26 Javascript
Js中setTimeout()和setInterval() 何时被调用执行的用法
2013/04/12 Javascript
JQuery加载图片自适应固定大小的DIV
2013/09/12 Javascript
深入理解JavaScript系列(19):求值策略(Evaluation strategy)详解
2015/03/05 Javascript
jQuery 1.9.1源码分析系列(十)事件系统之主动触发事件和模拟冒泡处理
2015/11/24 Javascript
使用JavaScript获取Request中参数的值方法
2016/09/27 Javascript
关于Iframe父页面与子页面之间的相互调用
2016/11/22 Javascript
vue-cli单页应用改成多页应用配置详解
2017/07/14 Javascript
原生JS实现图片无缝滚动方法(附带封装的运动框架)
2017/10/01 Javascript
微信小程序scroll-view实现滚动穿透和阻止滚动的方法
2018/08/20 Javascript
vue通过滚动行为实现从列表到详情,返回列表原位置的方法
2018/08/31 Javascript
vue实现分页的三种效果
2020/06/23 Javascript
用Python的urllib库提交WEB表单
2009/02/24 Python
Python中关键字is与==的区别简述
2014/07/31 Python
Python装饰器基础详解
2016/03/09 Python
实例讲解Python中SocketServer模块处理网络请求的用法
2016/06/28 Python
windows下python安装pip图文教程
2018/05/25 Python
儿童学习python的一些小技巧
2018/05/27 Python
Python3.8对可迭代解包的改进及用法详解
2019/10/15 Python
python 使用pygame工具包实现贪吃蛇游戏(多彩版)
2019/10/30 Python
Python3实现配置文件差异对比脚本
2019/11/18 Python
Python3.6 + TensorFlow 安装配置图文教程(Windows 64 bit)
2020/02/24 Python
基于Python3.7.1无法导入Numpy的解决方式
2020/03/09 Python
Python叠加矩形框图层2种方法及效果
2020/06/18 Python
js实现移动端H5页面手指滑动刻度尺功能
2017/11/16 HTML / CSS
MYSQL支持事务吗
2013/08/09 面试题
安全生产投入制度
2014/01/29 职场文书
《将心比心》教学反思
2014/04/08 职场文书
停车位租赁协议书
2014/09/24 职场文书
高考1977观后感
2015/06/04 职场文书
入党申请书格式
2019/06/20 职场文书