讲完了分页功用，这一节我们先不急着完成新的功用。来扼要引见下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<object>();
movies.Add(new { Title = "Ghostbusters", Genre = "Comedy", ReleaseDate = new DateTime(2017,1,1) });
movies.Add(new { Title = "Gone with Wind", Genre = "Drama", ReleaseDate = new DateTime(2017, 1, 3) });
movies.Add(new { Title = "Star Wars", Genre = "Science Fiction", ReleaseDate = new DateTime(2017, 1, 23) });
return Json(movies, JsonRequestBehavior.AllowGet);
}
个中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()的虚要领。
/// <summary>
/// Json the specified data, contentType, contentEncoding and behavior.
/// </summary>
/// <param name="data">Data.</param>
/// <param name="contentType">Content type.</param>
/// <param name="contentEncoding">Content encoding.</param>
/// <param name="behavior">Behavior.</param>
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
{
/// <summary>Converts given object to JSON string.</summary>
/// <returns></returns>
public static string ToJsonString(this object obj, bool camelCase = false, bool indented = false)
{
JsonSerializerSettings settings = new JsonSerializerSettings();
if (camelCase)
settings.ContractResolver = (IContractResolver) new CamelCasePropertyNamesContractResolver();
if (indented)
settings.Formatting = Formatting.Indented;
settings.Converters.Insert(0, (JsonConverter) new AbpDateTimeConverter());
return JsonConvert.SerializeObject(obj, settings);
}
}
显著没有指定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
{
/// <summary>
/// Initializes a new instance of the <see cref="DontWrapResultAttribute"/> class.
/// </summary>
public DontWrapResultAttribute()
: base(false, false)
{
}
}
/// <summary>
/// Used to determine how ABP should wrap response on the web layer.
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)]
public class WrapResultAttribute : Attribute
{
/// <summary>
/// Wrap result on success.
/// </summary>
public bool WrapOnSuccess { get; set; }
/// <summary>
/// Wrap result on error.
/// </summary>
public bool WrapOnError { get; set; }
/// <summary>
/// Log errors.
/// Default: true.
/// </summary>
public bool LogError { get; set; }
/// <summary>
/// Initializes a new instance of the <see cref="WrapResultAttribute"/> class.
/// </summary>
/// <param name="wrapOnSuccess">Wrap result on success.</param>
/// <param name="wrapOnError">Wrap result on error.</param>
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花样化用法引见的细致内容，更多请关注ki4网别的相干文章！
