1. ActionFilter 介紹

ActionFilter全稱是ActionFilterAttribute，我們根據(jù)微軟的命名規(guī)范可以看出這是一個(gè)特性類，看一下它的聲明：

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
public abstract class ActionFilterAttribute : Attribute, IActionFilter, IFilterMetadata, IAsyncActionFilter, IAsyncResultFilter, IOrderedFilter, IResultFilter

這是一個(gè)允許標(biāo)注在類和方法上的特性類，允許多個(gè)標(biāo)記，標(biāo)注之后子類會(huì)繼承父類的特性。然后，這個(gè)類是一個(gè)抽象類，所以我們可以通過繼承ActionFilterAttribute來編寫自己的ActionFilter。

1.1 ActionFilter的四個(gè)方法

對(duì)于一個(gè)ActionFilter而言，最重要的是它的四個(gè)方法：

public virtual void OnActionExecuted(ActionExecutedContext context);
public virtual void OnActionExecuting(ActionExecutingContext context);

public virtual void OnResultExecuted(ResultExecutedContext context);
public virtual void OnResultExecuting(ResultExecutingContext context);

上圖是這四個(gè)方法在一次請(qǐng)求中執(zhí)行的順序。在一次請(qǐng)求真正執(zhí)行之前，想要攔截這個(gè)請(qǐng)求，應(yīng)該使用OnActionExecuting。

為什么單獨(dú)說這個(gè)呢？因?yàn)檫@個(gè)方法的出鏡率很高，大多數(shù)時(shí)候都會(huì)使用這個(gè)方法進(jìn)行請(qǐng)求過濾。

1.2 在ActionFilter中我們能做什么

我們來簡(jiǎn)單介紹一下，四個(gè)方法中的四種上下文類型，看一看里面有哪些我們可以利用的方法：

1.2.1 ActionExecutingContext

這是一個(gè)Action執(zhí)行前的上下文，表示Action并未開始執(zhí)行，但是已經(jīng)獲取到了控制器實(shí)例：

public class ActionExecutingContext : FilterContext
{
   public virtual IDictionary ActionArguments { get; }
   public virtual object Controller { get; }
   public virtual IActionResult Result { get; set; }
}

ActionExecutingContext繼承自FilterContext，我們暫且不關(guān)注它的父類，只看一下它自己的屬性。

• ActionArguments 表示Action的參數(shù)列表，這里面放著各種從用戶接到請(qǐng)求參數(shù)以及其他中間處理程序添加的參數(shù)

• Controller 表示執(zhí)行該請(qǐng)求的控制器，在之前我們提過，asp.net core 對(duì)于控制器的限制很小，所以控制器什么類型都可能，故而這里使用object作為控制器類型

• Result 執(zhí)行結(jié)果，正常情況下，在此處獲取這個(gè)屬性的值沒有意義。但是我們可以通過修改這個(gè)屬性的值，來讓我們攔截請(qǐng)求

1.2.2 ActionExecutedContext

ActionExecutedContext 表示Action執(zhí)行完成后的上下文，這時(shí)候Action已經(jīng)執(zhí)行完成，我們可以通過這個(gè)獲取Action執(zhí)行結(jié)果：

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，暫且忽略。

• Canceled 表示是否被設(shè)置短路

• Controller 處理請(qǐng)求的控制器

• Exception 執(zhí)行過程中是否發(fā)生異常，如果有異常則 有值，否則為Null

• ExceptionHandled 異常是否被處理

• Result 此處對(duì)Result進(jìn)行修改不會(huì)屏蔽執(zhí)行的ActionResult，但是可以向用戶隱藏對(duì)應(yīng)的實(shí)現(xiàn)

1.2.3 ResultExecutingContext

這是在Result渲染之前執(zhí)行的上下文，這時(shí)候Action已經(jīng)執(zhí)行完畢，正準(zhǔn)備渲染Result：

public class ResultExecutingContext : FilterContext
{
   public virtual bool Cancel { get; set; }
   public virtual object Controller { get; }
   public virtual IActionResult Result { get; set; }
}

• Cancel 取消當(dāng)前結(jié)果執(zhí)行以及后續(xù)篩選器的執(zhí)行

• Controller 控制器

• Result 處理結(jié)果

1.2.4 ResultExecutedContext

Result已經(jīng)執(zhí)行完成了，獲取執(zhí)行結(jié)果上下文：

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; }
}

這個(gè)類與 ActionExecutedContext類似，就不做介紹了。

1.2.5 FilterContext

在上面的四個(gè)上下文都繼承自 FilterContext，那么我們來看一下FilterContext中有哪些屬性或者方法：

public abstract class FilterContext : ActionContext
{
   public virtual IList Filters { get; }
   public TMetadata FindEffectivePolicy() where TMetadata : IFilterMetadata;
}

可以看到FilterContext繼承了另一個(gè)ActionContext的類。小伙伴們應(yīng)該對(duì)這個(gè)類要有一定的概念，這個(gè)類是Action的上下文類。它完整存在于一個(gè)Action的生命周期，所以有時(shí)候可以通過ActionContext進(jìn)行Action級(jí)的數(shù)據(jù)傳遞（不推薦）。

那么，繼續(xù)讓我們回過頭來看看ActionContext里有什么：

public class ActionContext
{
   public ActionDescriptor ActionDescriptor { get; set; }
   public HttpContext HttpContext { get; set; }
   public ModelStateDictionary ModelState { get; }
   public RouteData RouteData { get; set; }
}

• ActionDescriptor 執(zhí)行的Action描述信息，包括Action的顯示名稱、一些參數(shù)等，具體用到的時(shí)候，再為大伙詳細(xì)說

• HttpContext 可以通過這個(gè)屬性獲取此次請(qǐng)求的Request和Response對(duì)象

• ModelState 模型校驗(yàn)信息， 這部分在后續(xù)再為小伙伴們細(xì)說

• RouteData 路由信息，asp.net core 在處理請(qǐng)求時(shí)解析出來的路由信息，包括在程序中修改的路由信息

2. 使用ActionFilter

在《【asp.net core 系列】9 實(shí)戰(zhàn)之 UnitOfWork以及自定義代碼生成》也就是上一篇中，介紹到了ActionFilter與普通特性類一致，可以通過標(biāo)注控制器然后啟用該ActionFilter。

因?yàn)榇蠖鄶?shù)情況下，一個(gè)ActionFilter并不會(huì)僅僅局限于一個(gè)控制器，而是應(yīng)用于多個(gè)控制器。所以這時(shí)候，我們通常會(huì)設(shè)置一個(gè)基礎(chǔ)控制器，在這個(gè)控制器上進(jìn)行標(biāo)注，然后讓子類繼承這個(gè)控制器。通過這種方式來實(shí)現(xiàn)一次聲明多次使用。

當(dāng)然，在asp.net core 中添加了另外的一種使用ActionFilter的方式，Setup.cs中

public void ConfigureServices(IServiceCollection services)
{
   services.AddControllersWithViews();
}

默認(rèn)是這樣的，我們可以通過設(shè)置參數(shù)來添加一個(gè)全局應(yīng)用的Filter，例如說我們上一篇中創(chuàng)建的 UnitOfWorkFilterAttribute：

services.AddControllersWithViews(options=>
{
   options.Filters.Add();
});

通過這種方式可以啟用一個(gè)全局ActionFilter。如果需要使用asp.net core的默認(rèn)依賴注入可以使用 AddService進(jìn)行配置。（依賴注入的內(nèi)容在后續(xù)會(huì)講解）。

3. 工具類生成

繼續(xù)上一篇遺留的內(nèi)容：

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 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);
}