C语言ABP入门连串(8)——Json格式化

总结

本节紧要教学了以下多少个难点:

  1. Asp.net中JsonResult的实现。
  2. ABP对JsonResult的再封装,匡助指定大小驼峰及是不是缩进举行Json格式化。
  3. 什么对DateTime类型对象举办格式化输出。
  • Web层通过拓展AbpJsonResult,指定时间格式。
  • 前端,通过将Json日期转换为js的Date类型,再格式化输出。
  • WebApi,通过在Moduel中指定DateFormatString。

ABP入门种类目录——学习Abp框架之实操演练
讲完了分页功用,这一节大家先不急着完毕新的出力。来容易介绍下Abp中Json的用法。为何要在这一节讲吧?当然是做铺垫啊,前边的多如牛毛作品会时时和Json这几个事物打交道。

三、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);进展种类化。

翻开牛顿soft.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是为何的

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

四、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 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获取。
  • 回来的日期未格式化,在前端还需自行格式化输出。