返回总目录:ABP+AdminLTE+Bootstrap Table权限管理系统一期
一,控制器AbpController
说完了Swagger ui 我们再来说一下abp对控制器的处理和json的封装.
首先我们定义一个控制器,在新增控制器的时候,控制器会自动继承自AbpController,AbpController对ASP.NET MVC Controllers进行了集成.
并且拥有了以前强大的功能.
功能
我们看到AbpController封装了很多方法,集成了很多东西,继承自System.Web.Mvc.Controller,abp包含一下功能
1,本地化
2,异常处理
3,对返回的JsonResult进行包装
4,审计日志
5,权限认证([AbpMvcAuthorize]特性)
6,工作单元(默认未开启,通过添加[UnitOfWork]开启)
7,错误机制的响应.
AbpController定义了L方法简化本地化。
本地化:你需要设置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使用Audited和DisableAuditing特性来控制审计日志。
验证:
AbpMvcValidationFilter自动检查ModelState.IsValid,如果action没通过验证则阻止其执行.
授权:
你可以给controllers或actions使用AbpMvcAutorize特性来禁止未授权的用户使用你的controllers和actions。如下:
工作单元:
AbpMvcUowFilter用来集成工作单元系统。它自动在action执行前可以使一个工作单元并在action结束后完成工作单元(如果没有异常抛出)。你可以使用UnitOfWork特性来控制action的UOW的行为。你也可以使用启动配置来更改所有actions的默认工作单元特性。
模型绑定器:
AbpMvcDateTimeBinder用来格式化DateTime(和Nullable<DateTime>)输入,它使用Clock.Normalize方法。
二, abp中对json的封装
Abp封装了AbpJsonResult
继承于JsonResult
,其中主要添加了两个属性:CamelCase 驼峰式命名 和Indented 是否缩进并在AbpController
中重载了Controller
的Json()
方法,强制所有返回的Json格式数据为AbpJsonResult
类型,并提供了AbpJson()
的虚方法。
其中result为代码中指定返回的数据。其他几个键值对是ABP封装的,包含了是否认证、是否成功、错误信息,以及目标Url。这几个参数是不是很sweet。
也可以通过调用return AbpJson()
来指定参数进行json格式化输出。
所以开始如果我们直接获取json字符串的时候,会发现与我们原来的json不一样.如果在前端框架直接调用json()方法返回的时候,返回的不是json而是一个对象.当不需要abp对json进行封装包裹怎么办?只需要在方法上标记[DontWrapResult]
特性标签即可。在AbpResultFilter
和AbpExceptionFilter
过滤器中会根据WrapResultAttribute
、DontWrapResultAttribute
特性进行相应的过滤。
就拿一个简单的登录页来说,我们看看封装前和封装之后的代码
{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官网介绍,日期格式化输出,需要指定IsoDateTimeConverter
的DateTimeFormat
对一这种时间格式我们怎么解决呢?
方法1:在服务器端将日期格式使用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(this)) { //使用正则表达式将日期属性中的非数字(D)删除 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-json
11.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(format) { 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()+3)/3), //quarter "S" : this.getMilliseconds() //millisecond } if(/(y+)/.test(format)) format=format.replace(RegExp.$1, (this.getFullYear()+"").substr(4- RegExp.$1.length)); for(var k in o)if(new RegExp("("+ k +")").test(format)) format = format.replace(RegExp.$1, RegExp.$1.length==1? o[k] : ("00"+ o[k]).substr((""+ o[k]).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";
这种方法仅对WebApi有效。 还有很多方法,我这里就推荐上面几种.