用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 相关文章推荐
Prototype String对象 学习
Jul 19 Javascript
关于Jqzoom的使用心得 jquery放大镜效果插件
Apr 12 Javascript
js判断日期时间有效性的方法
Oct 24 Javascript
jQuery添加和删除指定标签的方法
Dec 16 Javascript
jquery表单插件Autotab使用方法详解
Jun 24 Javascript
AngularJS表格添加序号的方法
Mar 03 Javascript
vue 动态改变静态图片以及请求网络图片的实现方法
Feb 07 Javascript
JS的Ajax与后端交互数据的实例
Aug 08 Javascript
详解小程序输入框闪烁及重影BUG解决方案
Aug 31 Javascript
electron中使用bootstrap的示例代码
Nov 06 Javascript
vue axios post发送复杂对象问题
Jun 04 Javascript
Webpack5正式发布,有哪些新特性
Oct 12 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
非常不错的MySQL优化的8条经验
2008/03/24 PHP
PHP获取类中常量,属性,及方法列表的方法
2009/04/09 PHP
PHP小程序自动提交到自助友情连接
2009/11/24 PHP
web目录下不应该存在多余的程序(安全考虑)
2012/05/09 PHP
php实现memcache缓存示例讲解
2013/12/04 PHP
Laravel框架集合用法实例浅析
2020/05/14 PHP
jQuery获取选中内容及设置元素属性的方法
2014/07/09 Javascript
浅谈js构造函数的方法与原型prototype
2016/07/04 Javascript
功能强大的Bootstrap使用手册(一)
2016/08/02 Javascript
Bootstrap table两种分页示例
2016/12/23 Javascript
JS实现列表页面隔行变色效果
2017/03/25 Javascript
Node接收电子邮件的实例代码
2017/07/21 Javascript
EasyUI的DataGrid每行数据添加操作按钮的实现代码
2017/08/22 Javascript
IntersectionObserver实现图片懒加载的示例
2017/09/29 Javascript
nodejs中密码加密处理操作详解
2018/03/20 NodeJs
vue中父子组件的参数传递和应用示例
2021/01/04 Vue.js
[01:08:17]2018DOTA2亚洲邀请赛3月29日 小组赛B组 EG VS VGJ.T
2018/03/30 DOTA
python安装PIL模块时Unable to find vcvarsall.bat错误的解决方法
2016/09/19 Python
python远程连接服务器MySQL数据库
2018/07/02 Python
django进阶之cookie和session的使用示例
2018/08/17 Python
python实现IOU计算案例
2020/04/12 Python
Lungolivigno Fashion官网:高级时装在线购物
2020/10/17 全球购物
简述数据库的设计过程
2015/06/22 面试题
母婴店促销方案
2014/03/05 职场文书
就业协议书的作用
2014/04/11 职场文书
村庄环境整治方案
2014/05/15 职场文书
留学生求职信
2014/06/03 职场文书
管理工程专业求职信
2014/08/10 职场文书
超市七夕促销活动方案
2014/08/28 职场文书
入党积极分子对十八届四中全会期盼的思想汇报
2014/10/17 职场文书
优秀教师推荐材料
2014/12/16 职场文书
廉政承诺书范文
2015/04/28 职场文书
2016党员党课心得体会
2016/01/07 职场文书
九年级化学教学反思
2016/02/22 职场文书
Python如何配置环境变量详解
2021/05/18 Python
Win11无法安装更新补丁KB3045316怎么办 附KB3045316补丁修复教程
2022/08/14 数码科技