過(guò)濾器范圍?

如何創(chuàng)建簡(jiǎn)單的過(guò)濾器

using System; 
using System.Threading.Tasks; 
using Microsoft.AspNetCore.Mvc; 
using Microsoft.AspNetCore.Mvc.Filters; 
using Newtonsoft.Json;  public class AddResponseHeaderFilter : ActionFilterAttribute 
{     // Async method which can surround the action execution// Invoked before and after the action executionpublic asyn coverride Task OnActionExecutionAsync(         ActionExecutingContext context, ActionExecutionDelegate next)     {         // Access the request         context.HttpContext.Response.Headers.Add(             "X-MyCustomHeader", Guid.NewGuid().ToString());                  var result = await next.Invoke();                  // Access the response         Console.WriteLine(JsonConvert.SerializeObject(result.Result));     } 
}  [Route("api/[controller]")] 
[ApiController] 
public class HomeController : ControllerBase 
{     [AddResponseHeaderFilter]     [Route("")]     [HttpGet]     public IActionResult Index()     {         return Ok(new { Message = "I'm Alive" });     } 
}

動(dòng)作過(guò)濾器的實(shí)現(xiàn)
示例 1：實(shí)現(xiàn) IActionFilter 的同步操作過(guò)濾器?

using Microsoft.AspNetCore.Mvc.Filters;namespace ActionFilters.Filters
{public class ActionFilterExample : IActionFilter{public void OnActionExecuting(ActionExecutingContext context){// Code executed before the action method executes}public void OnActionExecuted(ActionExecutedContext context){// Code executed after the action method executes}}
}

????????在此示例中，我們創(chuàng)建一個(gè)名為 ActionFilterExample 的類，該類實(shí)現(xiàn) IActionFilter 接口。該接口要求我們實(shí)現(xiàn)兩個(gè)方法：OnActionExecuting 和 OnActionExecuted。OnActionExecuting 方法包含將在操作方法之前執(zhí)行的代碼，而 OnActionExecuted 方法包含將在操作方法之后執(zhí)行的代碼。?

示例 2：實(shí)現(xiàn) IAsyncActionFilter 的異步操作過(guò)濾器?

using Microsoft.AspNetCore.Mvc.Filters;
using System.Threading.Tasks;namespace ActionFilters.Filters
{public class AsyncActionFilterExample : IAsyncActionFilter{public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next){// Code executed before the action method executesvar result = await next();// Code executed after the action method executes}}
}

?操作過(guò)濾器的范圍
可以在不同范圍級(jí)別添加操作過(guò)濾器：全局、操作和控制器。

public void ConfigureServices(IServiceCollection services)
{services.AddControllers(config =>{config.Filters.Add(new GlobalFilterExample());});
}

在.NET 6及更高版本中，由于缺少 Startup 類，您可以使用 Program 類：?

builder.Services.AddControllers(config => 
{ config.Filters.Add( new GlobalFilterExample()); 
});

services.AddScoped<ActionFilterExample>(); 
services.AddScoped<ControllerFilterExample>();

在 .NET 6 及更高版本中：?

builder.Services.AddScoped<ActionFilterExample>(); 
builder.Services.AddScoped<ControllerFilterExample>();

????????通過(guò)將操作過(guò)濾器注冊(cè)為服務(wù)，您可以通過(guò)使用相應(yīng)的過(guò)濾器屬性裝飾它們，有選擇地將其應(yīng)用到特定的操作方法或控制器。

namespace AspNetCore.Controllers
{[ServiceFilter(typeof(ControllerFilterExample))][Route("api/[controller]")][ApiController]public class TestController : ControllerBase{[HttpGet][ServiceFilter(typeof(ActionFilterExample))]public IEnumerable<string> Get(){return new string[] { "example", "data" };}}
}

調(diào)用順序
我們的過(guò)濾器的執(zhí)行順序如下：

我們可以通過(guò)向ServiceFilter屬性添加一個(gè)名為Order 的附加屬性來(lái)更改多個(gè)過(guò)濾器的調(diào)用順序：?

namespace AspNetCore.Controllers
{[ServiceFilter(typeof(ControllerFilterExample), Order=2)][Route("api/[controller]")][ApiController]public class TestController : ControllerBase{[HttpGet][ServiceFilter(typeof(ActionFilterExample), Order=1)]public IEnumerable<string> Get(){return new string[] { "example", "data" };}}
}

????????在本例中，ControllerFilterExample將在ActionFilterExample之前執(zhí)行，因?yàn)樗鼈兊捻樞蛑捣謩e為 2 和 1。通過(guò)為過(guò)濾器分配不同的順序值，您可以控制它們的執(zhí)行順序。

[HttpGet] 
[ServiceFilter(typeof(ActionFilterExample), Order=2)] 
[ServiceFilter(typeof(ActionFilterExample2), Order=1)] 
public IEnumerable<string> Get() 
{ return new string[] { "example", "data ” }; 
}

?????????在這種情況下，ActionFilterExample2將根據(jù)其順序值分別為 1 和 2，在ActionFilterExample之前執(zhí)行。

使用操作過(guò)濾器改進(jìn)代碼
????????為了使用操作過(guò)濾器改進(jìn)代碼，讓我們重點(diǎn)關(guān)注存儲(chǔ)庫(kù)中AppStart文件夾中起始項(xiàng)目的Controllers文件夾中的MoveController類。該控制器包含所有 CRUD 操作的實(shí)現(xiàn)。

盡管我們的操作已經(jīng)干凈且可讀，但由于全局異常處理，我們可以進(jìn)一步增強(qiáng)它們。

需要注意的一件重要事情是我們的Movie模型繼承自IEntity接口:

[Table("Movie")]
public class Movie: IEntity
{[Key]public Guid Id { get; set; }[Required(ErrorMessage = "Name is required")]public string Name { get; set; }[Required(ErrorMessage = "Genre is required")]public string Genre { get; set; }[Required(ErrorMessage = "Director is required")]public string Director { get; set; }
}

?????????現(xiàn)在，讓我們關(guān)注POST和PUT操作的驗(yàn)證代碼。通過(guò)將適當(dāng)?shù)牟僮鬟^(guò)濾器應(yīng)用于POST和PUT操作，我們可以消除這些操作中顯式驗(yàn)證代碼的需要，使它們更加簡(jiǎn)潔和可維護(hù)。

使用操作過(guò)濾器進(jìn)行驗(yàn)證
????????為了改進(jìn)POST和PUT操作中的驗(yàn)證代碼，我們可以使用操作過(guò)濾器。通過(guò)將驗(yàn)證邏輯提取到自定義操作過(guò)濾器中，我們可以使代碼更具可重用性并保持操作更清晰。

????????首先，我們?cè)诮鉀Q方案資源管理器中創(chuàng)建一個(gè)名為“ActionFilters”的新文件夾。在該文件夾中，創(chuàng)建一個(gè)名為ValidationFilterAttribute的新類：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using System.Linq;namespace ActionFilters.ActionFilters
{public class ValidationFilterAttribute : IActionFilter{public void OnActionExecuting(ActionExecutingContext context){var param = context.ActionArguments.SingleOrDefault(p => p.Value is IEntity);if (param.Value == null){context.Result = new BadRequestObjectResult("Object is null");return;}if (!context.ModelState.IsValid){context.Result = new UnprocessableEntityObjectResult(context.ModelState);}}public void OnActionExecuted(ActionExecutedContext context){          }}
}

?????????在ValidationFilterAttribute類中，我們重寫OnActionExecuting方法來(lái)執(zhí)行驗(yàn)證邏輯。我們檢查操作參數(shù)是否為 IEntity 類型，如果為 null，則返回BadRequestObjectResult。此外，如果 ModelState 無(wú)效，我們將返回UnprocessableEntityObjectResult。

public void ConfigureServices(IServiceCollection services)
{services.AddDbContext<MovieContext>(options =>options.UseSqlServer(Configuration.GetConnectionString("sqlConString")));services.AddScoped<ValidationFilterAttribute>();services.AddControllers();
}

對(duì)于.NET 6，我們需要在 Program 類中使用構(gòu)建器變量：?

builder.Services.AddDbContext<MovieContext>(options => options.UseSqlServer(Configuration.GetConnectionString( "sqlConString" ))); builder.Services.AddScoped<ValidationFilterAttribute>(); builder.Services.AddControllers();

最后，從 POST 和 PUT 操作中刪除驗(yàn)證代碼，并將ValidationFilterAttribute作為服務(wù)應(yīng)用：

[HttpPost]
[ServiceFilter(typeof(ValidationFilterAttribute))]
public IActionResult Post([FromBody] Movie movie)
{_context.Movies.Add(movie);_context.SaveChanges();return CreatedAtRoute("MovieById", new { id = movie.Id }, movie);
}[HttpPut("{id}")]
[ServiceFilter(typeof(ValidationFilterAttribute))]
public IActionResult Put(Guid id, [FromBody] Movie movie)
{var dbMovie = _context.Movies.SingleOrDefault(x => x.Id.Equals(id));if (dbMovie == null){return NotFound();}dbMovie.Map(movie);_context.Movies.Update(dbMovie);_context.SaveChanges();return NoContent();
}

????????通過(guò)將 ValidationFilterAttribute 應(yīng)用為服務(wù)過(guò)濾器，我們無(wú)需在操作中使用驗(yàn)證代碼。代碼現(xiàn)在更干凈、更具可讀性。此外，只要我們的模型類繼承自 IEntity 接口，此驗(yàn)證邏輯就可以重用。

services.Configure<ApiBehaviorOptions>(options => 
{ options.SuppressModelStateInvalidFilter = true ; 
});

?????????此配置可確保返回操作過(guò)濾器的驗(yàn)證結(jié)果（例如，UnprocessableEntity），而不是返回驗(yàn)證錯(cuò)誤的默認(rèn)BadRequest結(jié)果。

動(dòng)作過(guò)濾器中的依賴注入
????????為了消除通過(guò) ID 從數(shù)據(jù)庫(kù)中獲取電影并在 GetById、DELETE 和 PUT 操作中檢查其是否存在的代碼重復(fù)，我們可以創(chuàng)建一個(gè)新的操作過(guò)濾器來(lái)執(zhí)行此任務(wù)。我們還將使用依賴注入將 MovieContext 注入到動(dòng)作過(guò)濾器中。

讓我們?cè)?ActionFilters 文件夾中創(chuàng)建一個(gè)名為 ValidateEntityExistsAttribute<T> 的新操作過(guò)濾器類：

using System; 
using System.Linq; 
using Microsoft.AspNetCore.Mvc; 
using Microsoft.AspNetCore.Mvc.Filters;  namespace ActionFilters.ActionFilters 
{     public class ValidateEntityExistsAttribute<T> : IActionFilter where T : class, IEntity     {         private readonly MovieContext _context;          public ValidateEntityExistsAttribute(MovieContext context)         {             _context = context;         }          public void OnActionExecuting(ActionExecutingContext context)         {             Guid id = Guid.Empty;              if (context.ActionArguments.ContainsKey("id"))             {                 id = (Guid)context.ActionArguments["id"];             }             else             {                 context.Result = new BadRequestObjectResult("Bad id parameter");                 return;             }              var entity = _context.Set<T>().SingleOrDefault(x => x.Id.Equals(id));             if (entity == null)             {                 context.Result = new NotFoundResult();             }             else             {                 context.HttpContext.Items.Add("entity", entity);             }         }          public void OnActionExecuted(ActionExecutedContext context)         {         }     } 
} 

?services.AddScoped<ValidateEntityExistsAttribute<Movie>>();

????????對(duì)于 .NET 6，我們?cè)?Program 類中使用構(gòu)建器變量：?

builder.Services.AddScoped<ValidateEntityExistsAttribute<Movie>>();

最后，修改我們的操作以將 ValidateEntityExistsAttribute 應(yīng)用為服務(wù)過(guò)濾器：

[HttpGet("{id}", Name = "MovieById")] [ServiceFilter(typeof(ValidateEntityExistsAttribute<Movie>))] 
public IActionResult Get(Guid id) 
{     var dbMovie = HttpContext.Items["entity"] as Movie;      return Ok(dbMovie); 
}  [HttpPut("{id}")] 
[ServiceFilter(typeof(ValidationFilterAttribute))] 
[ServiceFilter(typeof(ValidateEntityExistsAttribute<Movie>))] 
public IActionResult Put(Guid id, [FromBody]Movie movie) 
{     var dbMovie = HttpContext.Items["entity"] as Movie;      dbMovie.Map(movie);      _context.Movies.Update(dbMovie);     _context.SaveChanges();      return NoContent(); 
}  [HttpDelete("{id}")] 
[ServiceFilter(typeof(ValidateEntityExistsAttribute<Movie>))] 
public IActionResult Delete(Guid id) 
{     var dbMovie = HttpContext.Items["entity"] as Movie;      _context.Movies.Remove(dbMovie);     _context.SaveChanges();      return NoContent(); 
}