這篇文章主要講解了“如何理解ABP的Json格式化”,文中的講解內(nèi)容簡單清晰,易于學(xué)習(xí)與理解,下面請大家跟著小編的思路慢慢深入,一起來研究和學(xué)習(xí)“如何理解ABP的Json格式化”吧!
寒亭網(wǎng)站建設(shè)公司創(chuàng)新互聯(lián)建站,寒亭網(wǎng)站設(shè)計制作,有大型網(wǎng)站制作公司豐富經(jīng)驗。已為寒亭近1000家提供企業(yè)網(wǎng)站建設(shè)服務(wù)。企業(yè)網(wǎng)站搭建\外貿(mào)網(wǎng)站建設(shè)要多少錢,請找那個售后服務(wù)好的寒亭做網(wǎng)站的公司定做!一、Json是干什么的
JSON(JavaScript Object Notation) 是一種輕量級的數(shù)據(jù)交換格式。 易于人閱讀和編寫。同時也易于機(jī)器解析和生成。JSON采用完全獨立于語言的文本格式,但是也使用了類似于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
其中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é)果,有以下幾點不足:
返回的字段大小寫與代碼中一致。這就要求我們在前端中也要與代碼中用一致的大小寫進(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()的虛方法。
////// Json the specified data, contentType, contentEncoding and behavior. /// /// 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結(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 { ///Converts given object to JSON string. ///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]特性即可。這個特性其實是一個快捷方式用來告訴ABP不要用AbpJsonResult包裹我,看源碼就明白了:
namespace Abp.Web.Models { [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)] public class DontWrapResultAttribute : WrapResultAttribute { ////// Initializes a new instance of the public DontWrapResultAttribute() : base(false, false) { } } ///class. /// /// Used to determine how ABP should wrap response on the web layer. /// [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)] public class WrapResultAttribute : Attribute { ////// Wrap result on success. /// public bool WrapOnSuccess { get; set; } ////// Wrap result on error. /// public bool WrapOnError { get; set; } ////// Log errors. /// Default: true. /// public bool LogError { get; set; } ////// Initializes a new instance of the /// Wrap result on success. /// Wrap result on error. public WrapResultAttribute(bool wrapOnSuccess = true, bool wrapOnError = true) { WrapOnSuccess = wrapOnSuccess; WrapOnError = wrapOnError; LogError = true; } } }class. ///
在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有效。
感謝各位的閱讀,以上就是“如何理解ABP的Json格式化”的內(nèi)容了,經(jīng)過本文的學(xué)習(xí)后,相信大家對如何理解ABP的Json格式化這一問題有了更深刻的體會,具體使用情況還需要大家實踐驗證。這里是創(chuàng)新互聯(lián)網(wǎng)站建設(shè)公司,,小編將為大家推送更多相關(guān)知識點的文章,歡迎關(guān)注!