ABP入门系列目录——学习Abp框架之实操演练
讲完了分页功能,这一节我们先不急着实现新的功能。来简要介绍下Abp中Json的用法。为什么要在这一节讲呢?当然是做铺垫啊,后面的系列文章会经常和Json这个东西打交道。

ABP+AdminLTE+Bootstrap
Table权限管理系统一期Github:https://github.com/Jimmey-Jiang/ABP-ASP.NET-Boilerplate-Project-CMS前往博客园总目录:ABP+AdminLTE+Bootstrap
Table权限管理系统一期

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

说完了Swagger ui
我们再来说一下abp对控制器的处理和json的封装.首先我们定义一个控制器,在新增控制器的时候,控制器会自动继承自AbpController,AbpControllerASP.NET MVC Controllers进行了集成.并且拥有了以前强大的功能.

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

图片 1图片 2图片 3

三、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特性进行相应的过滤。

我们看到AbpController封装了很多方法,集成了很多东西,继承自System.Web.Mvc.Controller,abp包含一下功能1.
本地化2. 异常处理3. 对返回的JsonResult进行包装4. 审计日志5.
权限认证([AbpMvcAuthorize]特性)6.
工作单元(默认未开启,通过添加[UnitOfWork]开启)7. 错误机制的响应.

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


AbpController定义了L方法简化本地化。

总结

本节主要讲解了以下几个问题:

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

图片 4

本地化:你需要设置LocalizationSourceName才能使用L**方法。你可以在控制器基类SimpleTaskSystemControllerBase里面设置,就可以在各个控制器里面调用了.这样保证一些公共东西的代码复用性.当然L方法也可以在视图地面调用,这样在控制js版本等作用还是非常方便的.同时在控制器里面也可以注入一些其他公共的东西,如你也可以使用预注如AbpSession,EventBus,PermissionManager,PermissionChecker,SettingManager,FeatureManager,FeatureChecker,LocalizationManager,Logger,CurrentUnitOfWork基础属性等。

异常处理和结果包装:所有的异常都是自动处理、记录并给客户端返回一个合适的响应.如果返回类型时JsonResult(或异步actions的Task<JsonResult>),
ABP会默认包装action的结果。你可以通过为controllers或actions或从全局的启动配置使用WrapResult和DontWrapResult特性来改变异常处理和包装。审计日志:AbpMvcAuditFilter用来集成审计日志系统。它默认记录所有actions的所有请求(如果审计没有被禁用)。你可以为actions和controllers使用AuditedDisableAuditing特性来控制审计日志。验证:AbpMvcValidationFilter自动检查ModelState.IsValid,如果action没通过验证则阻止其执行.授权:你可以给controllers或actions使用AbpMvcAutorize特性来禁止未授权的用户使用你的controllers和actions。如下:

图片 5

工作单元:AbpMvcUowFilter用来集成工作单元系统。它自动在action执行前可以使一个工作单元并在action结束后完成工作单元。你可以使用UnitOfWork特性来控制action的UOW的行为。你也可以使用启动配置来更改所有actions的默认工作单元特性。模型绑定器:AbpMvcDateTimeBinder用来格式化DateTime(和Nullable<DateTime>)输入,它使用Clock.Normalize方法。

Abp封装了AbpJsonResult继承于JsonResult,其中主要添加了两个属性:CamelCase
驼峰式命名 和Indented
是否缩进并在AbpController中重载了Controller的Json()方法,强制所有返回的Json格式数据为AbpJsonResult类型,并提供了AbpJson()的虚方法。

图片 6其中result为代码中指定返回的数据。其他几个键值对是ABP封装的,包含了是否认证、是否成功、错误信息,以及目标Url。这几个参数是不是很sweet。也可以通过调用return
AbpJson()来指定参数进行json格式化输出。所以开始如果我们直接获取json字符串的时候,会发现与我们原来的json不一样.如果在前端框架直接调用json()方法返回的时候,返回的不是json而是一个对象.当不需要abp对json进行封装包裹怎么办?只需要在方法上标记[DontWrapResult]特性标签即可。在AbpResultFilterAbpExceptionFilter过滤器中会根据WrapResultAttributeDontWrapResultAttribute特性进行相应的过滤。就拿一个简单的登录页来说,我们看看封装前和封装之后的代码

{success: true, Msg: "登录成功"}

封装之后,

{ result: {success: true, msg: "登录成功"}, "targetUrl": null, "success": true, "error": null, "unAuthorizedRequest": false, "__abp": true}

还有就是有时候在请求JsonResult的时候时间的格式是这样的:”2017-01-23T00:00:00″,这种我们需要怎么处理呢?查看AbpJsonReult源码发现调用的是Newtonsoft.Json序列化组件中的JsonConvert.SerializeObject(obj, settings);进行序列化。查看Newtonsoft.Json官网介绍,日期格式化输出,需要指定IsoDateTimeConverterDateTimeFormat

对一这种时间格式我们怎么解决呢?

  • 方法一:在服务器端将日期格式使用Select方法或LINQ表达式转换后发到客户端:

 var studentSet = students.Select ( p => new { p.Name, Birthday = p.Birthday.ToString("yyyy-mm-dd") } ).ToList();
  • 方法二:在javascript中将”Birthday”:”/Date(1391141532000)/”中的字符串转换成javascript中的日期对象,可以将Birthday这个Key所对应的Value中的非数字字符以替换的方式删除,到到一个数字1391141532000,然后实例化一个Date对象,将1391141532000毫秒作为参数,得到一个javascript中的日期对象.

//在String对象中扩展一个toDate方法,可以根据要求完善 String.prototype.toDate = function () { var dateMilliseconds; if (isNaN { //使用正则表达式将日期属性中的非数字删除 dateMilliseconds =this.replace(/\D/igm, ""); } else { dateMilliseconds=this; } //实例化一个新的日期格式,使用1970 年 1 月 1 日至今的毫秒数为参数 return new Date(parseInt(dateMilliseconds)); };
  • 方法三:可以选择一些第三方的json工具类,其中不乏有一些已经对日期格式问题已处理好了的,常见的json序列化与反序列化工具1.fastJSON.2.JSON_checker.3.Jayrock.4.Json.NET - LINQ to JSON.5.LitJSON.6.JSON for .NET.7.JsonFx.8.JSONSharp.9.JsonExSerializer.10.fluent-json11.Manatee Json
  • 方法四:其实MVC中也可以使用handler,但MVC中有专门针对服务器响应为JSON的Action

namespace JSONDateMVC.Common{ using System; using System.Web; using System.Web.Mvc; using Newtonsoft.Json; using Newtonsoft.Json.Converters; public class JsonResultPro : JsonResult { public JsonResultPro(){} public JsonResultPro(object data, JsonRequestBehavior behavior) { base.Data = data; base.JsonRequestBehavior = behavior; this.DateTimeFormat = "yyyy-MM-dd hh:mm:ss"; } public JsonResultPro(object data, String dateTimeFormat) { base.Data = data; base.JsonRequestBehavior = JsonRequestBehavior.AllowGet; this.DateTimeFormat = dateTimeFormat; } /// <summary> /// 日期格式 /// </summary> public string DateTimeFormat{ get; set; } public override void ExecuteResult(ControllerContext context) { if (context == null) { throw new ArgumentNullException("context"); } if ((this.JsonRequestBehavior == JsonRequestBehavior.DenyGet) && string.Equals(context.HttpContext.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase)) { throw new InvalidOperationException("MvcResources.JsonRequest_GetNotAllowed"); } HttpResponseBase base2 = context.HttpContext.Response; if (!string.IsNullOrEmpty(this.ContentType)) { base2.ContentType = this.ContentType; } else { base2.ContentType = "application/json"; } if (this.ContentEncoding != null) { base2.ContentEncoding = this.ContentEncoding; } if (this.Data != null) { //转换System.DateTime的日期格式到 ISO 8601日期格式 //ISO 8601 (如2008-04-12T12:53Z) IsoDateTimeConverter isoDateTimeConverter=new IsoDateTimeConverter(); //设置日期格式 isoDateTimeConverter.DateTimeFormat = DateTimeFormat; //序列化 String jsonResult = JsonConvert.SerializeObject(this.Data,isoDateTimeConverter); //相应结果 base2.Write(jsonResult); } } }}

这样就可以完全按自己的意思来设置日期格式了,但需要注意日期格式如平时的Format是有区别的,如这里表示时间的H如果大写表示24小时制,如果小写表示12小时制。

  • 方法五: js格式化

Date.prototype.format =function { var o = { "M+" : this.getMonth()+1, //month"d+" : this.getDate(), //day"h+" : this.getHours(), //hour"m+" : this.getMinutes(), //minute"s+" : this.getSeconds(), //second"q+" : Math.floor((this.getMonth, //quarter"S" : this.getMilliseconds() //millisecond } if/.test format=format.replace(RegExp.$1, (this.getFullYear.substr(4- RegExp.$1.length)); for(var k in o)if(new RegExp("").test format = format.replace(RegExp.$1, RegExp.$1.length==1? o[k] : ("00"+ o[k]).substr(.length)); return format; }

以上代码必须先声明,然后在使用。使用方法:

var d =new Date().format('yyyy-MM-dd');
  • 方法六:在Abp的WepApiModule中指定JsonFormatter的时间序列化时间格式

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

还有很多方法,我这里就推荐上面几种.

返回简书总目录:ABP+AdminLTE+Bootstrap
Table权限管理系统一期前往博客园总目录:ABP+AdminLTE+Bootstrap
Table权限管理系统一期

相关文章