讲完了分页功能,这一节我们先不急着实现新的功能。来简要介绍下Abp中Json的用法。为什么要在这一节讲呢?当然是做铺垫啊,后面的系列文章会经常和Json这个东西打交道。
一、Json是干什么的
JSON(JavaScript Object Notation) 是一种轻量级的数据交换格式。 易于人阅读和编写。同时也易于机器解析和生成。JSON采用完全独立于语言的文本格式,但是也使用了类似于C语言家族的习惯(包括C, C++, C#, Java, JavaScript, Perl, Python等)。 这些特性使JSON成为理想的数据交换语言。
Json一般用于表示:
名称/值对:
{"firstName":"Brett","lastName":"McLaughlin","email":"aaaa"}
数组:
{ "people":[{"firstName":"Brett","lastName":"McLaughlin","email":"aaaa"},{"firstName":"Jason","lastName":"Hunter","email":"bbbb"},{"firstName":"Elliotte","lastName":"Harold","email":"cccc"}]}
二、Asp.net Mvc中的JsonResult
Asp.net mvc中默认提供了JsonResult来处理需要返回Json格式数据的情况。
一般我们可以这样使用:
public ActionResult Movies(){var movies = new List其中Json()是Controller基类中提供的虚方法。
返回的json结果格式化后为:[{"Title": "Ghostbusters","Genre": "Comedy","ReleaseDate": "\/Date(1483200000000)\/"},{"Title": "Gone with Wind","Genre": "Drama","ReleaseDate": "\/Date(1483372800000)\/"},{"Title": "Star Wars","Genre": "Science Fiction","ReleaseDate": "\/Date(1485100800000)\/"}]仔细观察返回的json结果,有以下几点不足:返回的字段大小写与代码中一致。这就要求我们在前端中也要与代码中用一致的大小写进行取值(item.Title,item.Genre,item.ReleaseDate)。
不包含成功失败信息:如果我们要判断请求是否成功,我们要手动通过获取json数据包的length获取。
返回的日期未格式化,在前端还需自行格式化输出。
三、Abp中对Json的封装
所以Abp封装了AbpJsonResult继承于JsonResult,其中主要添加了两个属性:CamelCase:大小驼峰(默认为true,即小驼峰格式)
Indented :是否缩进(默认为false,即未格式化)
并在AbpController中重载了Controller的Json()方法,强制所有返回的Json格式数据为AbpJsonResult类型,并提供了AbpJson()的虚方法。
///
/// /// Data./// Content type./// Content encoding./// Behavior.protected override JsonResult Json(object data, string contentType,Encoding contentEncoding, JsonRequestBehavior behavior){if (_wrapResultAttribute != null && !_wrapResultAttribute.WrapOnSuccess){return base.Json(data, contentType, contentEncoding, behavior);}return AbpJson(data, contentType, contentEncoding, behavior);}protected virtual AbpJsonResult AbpJson(object data,string contentType = null,Encoding contentEncoding = null,JsonRequestBehavior behavior = JsonRequestBehavior.DenyGet,bool wrapResult = true,bool camelCase = true,bool indented = false){if (wrapResult){if (data == null){data = new AjaxResponse();}else if (!(data is AjaxResponseBase)){data = new AjaxResponse(data);}}return new AbpJsonResult{Data = data,ContentType = contentType,ContentEncoding = contentEncoding,JsonRequestBehavior = behavior,CamelCase = camelCase,Indented = indented};}在ABP中用Controler继承自AbpController,直接使用return Json(),将返回Json结果格式化后:{"result": [{"title": "Ghostbusters","genre": "Comedy","releaseDate": "2017-01-01T00:00:00"},{"title": "Gone with Wind","genre": "Drama","releaseDate": "2017-01-03T00:00:00"},{"title": "Star Wars","genre": "Science Fiction","releaseDate": "2017-01-23T00:00:00"}],"targetUrl": null,"success": true,"error": null,"unAuthorizedRequest": false,"__abp": true}其中result为代码中指定返回的数据。其他几个键值对是ABP封装的,包含了是否认证、是否成功、错误信息,以及目标Url。这几个参数是不是很sweet。
也可以通过调用return AbpJson()来指定参数进行json格式化输出。
仔细观察会发现日期格式还是怪怪的。2017-01-23T00:00:00,多了一个T。查看AbpJsonReult源码发现调用的是Newtonsoft.Json序列化组件中的JsonConvert.SerializeObject(obj, settings);进行序列化。
查看Newtonsoft.Json官网介绍,日期格式化输出,需要指定IsoDateTimeConverter的DateTimeFormat即可。
IsoDateTimeConverter timeFormat = new IsoDateTimeConverter();timeFormat.DateTimeFormat = "yyyy-MM-dd HH:mm:ss";JsonConvert.SerializeObject(dt, Formatting.Indented, timeFormat)那在我们Abp中我们怎么去指定这个DateTimeFormat呢?
ABP中提供了AbpDateTimeConverter类继承自IsoDateTimeConverter。
但查看ABP中集成的Json序列化扩展类:public static class JsonExtensions{/// 明显没有指定DateTimeFormat,那我们就只能自己动手了,具体代码请参考4种解决json日期格式问题的办法的第四种办法。
当有异常发生时,Abp返回的Json格式化输出以下结果:{"targetUrl": null,"result": null,"success": false,"error": {"message": "An internal error occured during your request!","details": "..."},"unAuthorizedRequest": false}当不需要abp对json进行封装包裹怎么办?
简单。只需要在方法上标记[DontWrapResult]特性即可。这个特性其实是一个快捷方式用来告诉ABP不要用AbpJsonResult包裹我,看源码就明白了:namespace Abp.Web.Models{[AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)]public class DontWrapResultAttribute : WrapResultAttribute{///
/// public DontWrapResultAttribute(): base(false, false){}}///
/// [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)]public class WrapResultAttribute : Attribute{///
/// public bool WrapOnSuccess { get; set; }///
/// public bool WrapOnError { get; set; }///
/// Default: true.
/// public bool LogError { get; set; }///
/// /// Wrap result on success./// Wrap result on error.public WrapResultAttribute(bool wrapOnSuccess = true, bool wrapOnError = true){WrapOnSuccess = wrapOnSuccess;WrapOnError = wrapOnError;LogError = true;}}}在AbpResultFilter和AbpExceptionFilter过滤器中会根据WrapResultAttribute、DontWrapResultAttribute特性进行相应的过滤。
四、Json日期格式化
第一种办法:前端JS转换:
//格式化显示json日期格式function showDate(jsonDate) {var date = new Date(jsonDate);var formatDate = date.toDateString();return formatDate;}第二种办法:在Abp的WepApiModule(模块)中指定JsonFormatter的时间序列化时间格式。
GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.DateFormatString ="yyyy-MM-dd HH:mm:ss";PS:这种方法仅对WebApi有效。
总结本节主要讲解了以下几个问题:Asp.net中JsonResult的实现。
ABP对JsonResult的再封装,支持指定大小驼峰及是否缩进进行Json格式化。
如何对DateTime类型对象进行格式化输出。
Web层通过拓展AbpJsonResult,指定时间格式。
前端,通过将Json日期转换为js的Date类型,再格式化输出。
WebApi,通过在Moduel中指定DateFormatString。
以上所述是小编给大家介绍的ABP入门系列之Json格式化,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!
您可能感兴趣的文章:vue.js实现价格格式化的方法JS使用正则控制用户输入银行卡号及格式化springmvc fastjson 反序列化时间格式化方法(推荐) js时间戳格式化成日期格式的多种方法介绍JS操作XML实例总结(加载与解析XML文件、字符串) JS解析XML文件和XML字符串详解js字符串转换成xml对象并使用技巧解读js 加载并解析XML字符串的代码javascript解析xml字符串的函数Javascript格式化并高亮xml字符串的方法及注意事项
