在上一篇中,咱們提到了如何建立一個UnitOfWork並經過ActionFilter設置啓用。這一篇咱們將簡單介紹一下ActionFilter以及如何利用ActionFilter,順便補齊一下上一篇的工具類。c#
ActionFilter全稱是ActionFilterAttribute,咱們根據微軟的命名規範能夠看出這是一個特性類,看一下它的聲明:框架
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)] public abstract class ActionFilterAttribute : Attribute, IActionFilter, IFilterMetadata, IAsyncActionFilter, IAsyncResultFilter, IOrderedFilter, IResultFilter
這是一個容許標註在類和方法上的特性類,容許多個標記,標註以後子類會繼承父類的特性。而後,這個類是一個抽象類,因此咱們能夠經過繼承ActionFilterAttribute來編寫本身的ActionFilter。asp.net
對於一個ActionFilter而言,最重要的是它的四個方法:工具
public virtual void OnActionExecuted(ActionExecutedContext context); public virtual void OnActionExecuting(ActionExecutingContext context); public virtual void OnResultExecuted(ResultExecutedContext context); public virtual void OnResultExecuting(ResultExecutingContext context);
上圖是這四個方法在一次請求中執行的順序。在一次請求真正執行以前,想要攔截這個請求,應該使用OnActionExecuting
。優化
爲何單獨說這個呢?由於這個方法的出鏡率很高,大多數時候都會使用這個方法進行請求過濾。ui
咱們來簡單介紹一下,四個方法中的四種上下文類型,看一看裏面有哪些咱們能夠利用的方法:spa
這是一個Action執行前的上下文,表示Action並未開始執行,可是已經獲取到了控制器實例:.net
public class ActionExecutingContext : FilterContext { public virtual IDictionary<string, object> ActionArguments { get; } public virtual object Controller { get; } public virtual IActionResult Result { get; set; } }
ActionExecutingContext繼承自FilterContext,咱們暫且不關注它的父類,只看一下它本身的屬性。code
ActionExecutedContext 表示Action執行完成後的上下文,這時候Action已經執行完成,咱們能夠經過這個獲取Action執行結果:對象
public class ActionExecutedContext : FilterContext { public virtual bool Canceled { get; set; } public virtual object Controller { get; } public virtual Exception Exception { get; set; } public virtual ExceptionDispatchInfo ExceptionDispatchInfo { get; set; } public virtual bool ExceptionHandled { get; set; } public virtual IActionResult Result { get; set; } }
一樣,繼承自FilterContext,暫且忽略。
這是在Result渲染以前執行的上下文,這時候Action已經執行完畢,正準備渲染Result:
public class ResultExecutingContext : FilterContext { public virtual bool Cancel { get; set; } public virtual object Controller { get; } public virtual IActionResult Result { get; set; } }
Result已經執行完成了,獲取執行結果上下文:
public class ResultExecutedContext : FilterContext { public virtual bool Canceled { get; set; } public virtual object Controller { get; } public virtual Exception Exception { get; set; } public virtual ExceptionDispatchInfo ExceptionDispatchInfo { get; set; } public virtual bool ExceptionHandled { get; set; } public virtual IActionResult Result { get; } }
這個類與 ActionExecutedContext相似,就不作介紹了。
在上面的四個上下文都繼承自 FilterContext,那麼咱們來看一下FilterContext中有哪些屬性或者方法:
public abstract class FilterContext : ActionContext { public virtual IList<IFilterMetadata> Filters { get; } public TMetadata FindEffectivePolicy<TMetadata>() where TMetadata : IFilterMetadata; }
能夠看到FilterContext繼承了另外一個ActionContext的類。小夥伴們應該對這個類要有必定的概念,這個類是Action的上下文類。它完整存在於一個Action的生命週期,因此有時候能夠經過ActionContext進行Action級的數據傳遞(不推薦)。
那麼,繼續讓咱們回過頭來看看ActionContext裏有什麼:
public class ActionContext { public ActionDescriptor ActionDescriptor { get; set; } public HttpContext HttpContext { get; set; } public ModelStateDictionary ModelState { get; } public RouteData RouteData { get; set; } }
在《【asp.net core 系列】9 實戰之 UnitOfWork以及自定義代碼生成》也就是上一篇中,介紹到了ActionFilter與普通特性類一致,能夠經過標註控制器而後啓用該ActionFilter。
由於大多數狀況下,一個ActionFilter並不會僅僅侷限於一個控制器,而是應用於多個控制器。因此這時候,咱們一般會設置一個基礎控制器,在這個控制器上進行標註,而後讓子類繼承這個控制器。經過這種方式來實現一次聲明屢次使用。
固然,在asp.net core 中添加了另外的一種使用ActionFilter的方式,Setup.cs中
public void ConfigureServices(IServiceCollection services) { services.AddControllersWithViews(); }
默認是這樣的,咱們能夠經過設置參數來添加一個全局應用的Filter,例如說咱們上一篇中建立的 UnitOfWorkFilterAttribute:
services.AddControllersWithViews(options=> { options.Filters.Add<UnitOfWorkFilterAttribute>(); });
經過這種方式能夠啓用一個全局ActionFilter。若是須要使用asp.net core的默認依賴注入可使用 AddService進行配置。(依賴注入的內容在後續會講解)。
繼續上一篇遺留的內容:
public static void CreateEntityTypeConfig(Type type) { var targetNamespace = type.Namespace.Replace("Data.Models", ""); if (targetNamespace.StartsWith(".")) { targetNamespace = targetNamespace.Remove(0); } var targetDir = Path.Combine(new[] { CurrentDirect, "Domain.Implements", "EntityConfigures" }.Concat( targetNamespace.Split('.')).ToArray()); if (!Directory.Exists(targetDir)) { Directory.CreateDirectory(targetDir); } var baseName = type.Name.Replace("Entity", ""); if (!string.IsNullOrEmpty(targetNamespace)) { targetNamespace = $".{targetNamespace}"; } var file = $"using {type.Namespace};" + $"\r\nusing Microsoft.EntityFrameworkCore;" + $"\r\nusing Microsoft.EntityFrameworkCore.Metadata.Builders;" + $"\r\nnamespace Domain.Implements.EntityConfigures{targetNamespace}" + "\r\n{" + $"\r\n\tpublic class {baseName}Config : IEntityTypeConfiguration<{type.Name}>" + "\r\n\t{" + "\r\n\t\tpublic void Configure(EntityTypeBuilder<SysUser> builder)" + "\r\n\t\t{" + $"\r\n\t\t\tbuilder.ToTable(\"{baseName}\");" + $"\r\n\t\t\tbuilder.HasKey(p => p.Id);" + "\r\n\t\t}\r\n\t}\r\n}"; File.WriteAllText(Path.Combine(targetDir, $"{baseName}Config.cs"), file); }
工具類其實本質上就是一次文件寫入的方法,自己沒什麼難度。
不過,這裏還有有個小問題,每次調用都會覆蓋原有的文件,還有就是這裏面有不少能夠優化的地方,小夥伴們能夠本身試試去優化一下,讓代碼更好看一點。
到目前爲止,實戰系列也有了幾篇,不少小夥伴問我能提供一下源碼嗎?固然,能呀。不過不是如今,容我留個謎底。當主要框架功能完成以後,我就會給小夥伴們發代碼的。
其實也是由於如今還沒個完整的,開放給小夥伴們也沒啥意義。固然了,跟着一塊敲,也是能實現的哈。關鍵地方的代碼都有。
更多內容煩請關注個人博客《高先生小屋》