C语言ABP入门系列(8)——Json格式化

ABP入门系列目录——学习Abp框架的实操演练
语了了分页功能,这无异于省咱们先不着急在实现新的功用。来大概介绍下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.Titleitem.Genreitem.ReleaseDate)。
  • 勿带有成功失败信息:如果我们如果判请求是否成,我们要手动通过获取json数据包的length获取。
  • 返的日期未格式化,在前者还待自行格式化输出。

三、Abp中对Json的封装

所以Abp封装了AbpJsonResult继承于JsonResult,其中重大添加了简单单特性:

  • CamelCase:大小驼峰(默认为true,即小驼峰格式)
  • Indented :是否缩进(默认也false,即非格式化)

并在AbpController倍受重载了ControllerJson()主意,强制有返回的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官网介绍,日期格式化输出,需要指定IsoDateTimeConverterDateTimeFormat即可。

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

AbpResultFilterAbpExceptionFilter过滤器中见面基于WrapResultAttributeDontWrapResultAttribute特性开展对应的过滤。

季、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有效。


总结

本节重中之重教授了以下几独问题:

  1. Asp.net中JsonResult的实现。
  2. ABP对JsonResult的重复封装,支持指定大小驼峰及是否缩进进行Json格式化。
  3. 哪对DateTime类型对象进行格式化输出。

  4. Web层通过开展AbpJsonResult,指定时间格式。

  5. 前者,通过以Json日期变为js的Date类型,再格式化输出。
  6. WebApi,通过在Moduel中指定DateFormatString。