返回總目錄: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有效。 還有很多方法,我這里就推薦上面幾種.