講完了分頁功能，這一節(jié)我們先不急著實(shí)現(xiàn)新的功能。來簡要介紹下Abp中Json的用法。為什么要在這一節(jié)講呢？當(dāng)然是做鋪墊啊，后面的系列文章會經(jīng)常和Json這個東西打交道。
一、Json是干什么的
JSON(Javascript Object Notation) 是一種輕量級的數(shù)據(jù)交換格式。 易于人閱讀和編寫。同時也易于機(jī)器解析和生成。JSON采用完全獨(dú)立于語言的文本格式，但是也使用了類似于C語言家族的習(xí)慣（包括C, C++, C#, Java, Javascript, Perl, Python等）。 這些特性使JSON成為理想的數(shù)據(jù)交換語言。
Json一般用于表示：
名稱/值對：
{"firstName":"Brett","lastName":"McLaughlin","email":"aaaa"}數(shù)組：
{ "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中默認(rèn)提供了JsonResult來處理需要返回Json格式數(shù)據(jù)的情況。
一般我們可以這樣使用：
public ActionResult Movies(){ var movies = new List<object>(); movies.Add(new { movies.Add(new { movies.Add(new { return Json(movies, JsonRequestBehavior.AllowGet);}其中Json()是Controller基類中提供的虛方法。
返回的json結(jié)果格式化后為：
[ { "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)//" }]仔細(xì)觀察返回的json結(jié)果，有以下幾點(diǎn)不足：
返回的字段大小寫與代碼中一致。這就要求我們在前端中也要與代碼中用一致的大小寫進(jìn)行取值（item.Title，item.Genre，item.ReleaseDate）。
不包含成功失敗信息：如果我們要判斷請求是否成功，我們要手動通過獲取json數(shù)據(jù)包的length獲取。
返回的日期未格式化，在前端還需自行格式化輸出。
三、Abp中對Json的封裝
所以Abp封裝了AbpJsonResult繼承于JsonResult，其中主要添加了兩個屬性：
CamelCase：大小駝峰（默認(rèn)為true，即小駝峰格式）
Indented ：是否縮進(jìn)（默認(rèn)為false，即未格式化）
并在AbpController中重載了Controller的Json()方法，強(qiáng)制所有返回的Json格式數(shù)據(jù)為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結(jié)果格式化后：
{ "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為代碼中指定返回的數(shù)據(jù)。其他幾個鍵值對是ABP封裝的，包含了是否認(rèn)證、是否成功、錯誤信息，以及目標(biāo)Url。這幾個參數(shù)是不是很sweet。
也可以通過調(diào)用return AbpJson()來指定參數(shù)進(jìn)行json格式化輸出。
仔細(xì)觀察會發(fā)現(xiàn)日期格式還是怪怪的。2017-01-23T00:00:00，多了一個T。查看AbpJsonReult源碼發(fā)現(xiàn)調(diào)用的是Newtonsoft.Json序列化組件中的JsonConvert.SerializeObject(obj, settings);進(jìn)行序列化。
查看Newtonsoft.Json官網(wǎng)介紹，日期格式化輸出，需要指定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序列化擴(kuò)展類：
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日期格式問題的辦法的第四種辦法。
當(dāng)有異常發(fā)生時，Abp返回的Json格式化輸出以下結(jié)果：
{ "targetUrl": null, "result": null, "success": false, "error": { "message": "An internal error occured during your request!", "details": "..." }, "unAuthorizedRequest": false}當(dāng)不需要abp對json進(jìn)行封裝包裹怎么辦？
簡單。只需要在方法上標(biāo)記[DontWrapResult]特性即可。這個特性其實(shí)是一個快捷方式用來告訴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過濾器中會根據(jù)WrapResultAttribute、DontWrapResultAttribute特性進(jìn)行相應(yīng)的過濾。
四、Json日期格式化
第一種辦法：前端JS轉(zhuǎn)換：
//格式化顯示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有效。
總結(jié)
本節(jié)主要講解了以下幾個問題：
Asp.net中JsonResult的實(shí)現(xiàn)。
ABP對JsonResult的再封裝，支持指定大小駝峰及是否縮進(jìn)進(jìn)行Json格式化。
如何對DateTime類型對象進(jìn)行格式化輸出。
Web層通過拓展AbpJsonResult，指定時間格式。
前端，通過將Json日期轉(zhuǎn)換為js的Date類型，再格式化輸出。
WebApi，通過在Moduel中指定DateFormatString。
以上所述是小編給大家介紹的ABP入門系列之Json格式化，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復(fù)大家的。在此也非常感謝大家對VeVb武林網(wǎng)網(wǎng)站的支持！
新聞熱點(diǎn)
疑難解答
圖片精選
