Shulou(Shulou.com)06/03 Report--

This article mainly explains "how to understand the Json format of ABP". The content of the explanation is simple and clear, and it is easy to learn and understand. Please follow the editor's train of thought to study and learn "how to understand the Json format of ABP".

What does Json do?

JSON (JavaScript Object Notation) is a lightweight data exchange format. Easy for people to read and write. At the same time, it is also easy to parse and generate by machine. JSON uses a completely language-independent text format, but also uses habits similar to those of the C language family (including C, Clipper, Java, JavaScript, Perl, Python, etc.). These features make JSON an ideal data exchange language.

Json is generally used to indicate:

Name / value pair:

{"firstName": "Brett", "lastName": "McLaughlin", "email": "aaaa"}

Array:

{"people": [{"firstName": "Brett", "lastName": "McLaughlin", "email": "aaaa"}, {"firstName": "Jason", "lastName": "Hunter", "email": "bbbb"}, {"firstName": "Elliotte", "lastName": "Harold", "email": "cccc"}]}}

2. JsonResult in Asp.net Mvc

JsonResult is provided by default in Asp.net mvc to handle situations where data in Json format needs to be returned.

In general, we can use it like this:

Public ActionResult Movies () {var movies = new List (); movies.Add (new {Title = "Ghostbusters", Genre = "Comedy", ReleaseDate = new DateTime (2017 Magazine 1)}); movies.Add (new {Title = "Gone with Wind", Genre = "Drama", ReleaseDate = new DateTime (2017 Magazine 1,3)}); movies.Add (new {Title = "Star Wars", Genre = "Science Fiction", ReleaseDate = new DateTime (2017 Medi 1,23)}); return Json (movies, JsonRequestBehavior.AllowGet);}

Where Json () is the virtual method provided in the Controller base class.

The returned json result is formatted as follows:

[{"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)\ /"}]

If you take a closer look at the returned json result, you will find the following deficiencies:

The case of the returned field is the same as in the code. This requires us to item.Title,item.Genre,item.ReleaseDate values in the front end in the same case as in the code.

Does not contain success or failure information: if we want to determine whether the request is successful, we need to obtain it manually through the length that fetches the json packet.

The returned date is not formatted, and the output needs to be self-formatted at the front end.

III. Encapsulation of Json in Abp

So Abp encapsulates AbpJsonResult inheriting from JsonResult, which mainly adds two attributes:

CamelCase: size hump (default is true, that is, small hump format)

Indented: whether to indent (default is false, that is, unformatted)

The Json () method of Controller is overloaded in AbpController, forcing all returned Json format data to be of type AbpJsonResult, and providing a virtual method of 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, camelCase = camelCase};}

Inherit from AbpController with Controler in ABP, directly use return Json (), and format the returned Json result:

{"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}

Where result is the data returned as specified in the code. Several other key-value pairs are encapsulated by ABP, including authentication, success, error messages, and the target Url. These parameters are not very sweet.

You can also specify a parameter for json formatted output by calling return AbpJson ().

If you look closely, you will find that the format of the date is still strange. 2017-01-23T00:00:00, with an extra T. Looking at the AbpJsonReult source code, it is found that JsonConvert.SerializeObject (obj, settings) in the Newtonsoft.Json serialization component is called; for serialization.

To view the description of Newtonsoft.Json 's official website and the date formatted output, you need to specify the DateTimeFormat of IsoDateTimeConverter.

IsoDateTimeConverter timeFormat = new IsoDateTimeConverter (); timeFormat.DateTimeFormat = "yyyy-MM-dd HH:mm:ss"; JsonConvert.SerializeObject (dt, Formatting.Indented, timeFormat)

So how do we specify this DateTimeFormat in our Abp?

The AbpDateTimeConverter class is provided in ABP that inherits from IsoDateTimeConverter.

You can view the Json serialization extension classes integrated in ABP:

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);}}

Obviously did not specify DateTimeFormat, then we have to do it ourselves, the specific code, please refer to the fourth of four ways to solve the problem of json date format.

When an exception occurs, the Json format returned by Abp outputs the following result:

{"targetUrl": null, "result": null, "success": false, "error": {"message": "An internal error occured during your request!", "details": "..."}, "unAuthorizedRequest": false}

What if there is no need for abp to encapsulate the json package?

simple. You just need to mark the [DontWrapResult] attribute on the method. This feature is actually a shortcut to tell ABP not to wrap me in AbpJsonResult, just look at the source code:

Namespace Abp.Web.Models {[AttributeUsage (AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)] public class DontWrapResultAttribute: WrapResultAttribute {/ Initializes a new instance of the class. / public DontWrapResultAttribute (): base (false, false) {}} / 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 class. / Wrap result on success. / Wrap result on error. Public WrapResultAttribute (bool wrapOnSuccess = true, bool wrapOnError = true) {WrapOnSuccess = wrapOnSuccess; WrapOnError = wrapOnError; LogError = true;}

The AbpResultFilter and AbpExceptionFilter filters are filtered according to the WrapResultAttribute and DontWrapResultAttribute features.

IV. Json date formatting

The first method: front-end JS conversion:

/ / format display json date format function showDate (jsonDate) {var date = new Date (jsonDate); var formatDate = date.toDateString (); return formatDate;}

The second way is to specify the time serialization time format of JsonFormatter in the WepApiModule (module) of Abp.

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss"

PS: this method only works for WebApi.

Thank you for your reading, the above is the content of "how to understand the Json format of ABP". After the study of this article, I believe you have a deeper understanding of how to understand the Json format of ABP. Here is, the editor will push for you more related knowledge points of the article, welcome to follow!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.