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,其中第1添加了三个天性:

  • 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日期格式化

率先种办法:前端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类型对象进行格式化输出。
  • Web层通过开展AbpJsonResult,指定时间格式。
  • 前者,通过将Json日期转换为js的Date类型,再格式化输出。
  • WebApi,通过在Moduel中指定DateFormatString。

相关文章

网站地图xml地图