ASP.NET Core中的端点过滤器是什么？如何应用？-C#.Net教程-PHP中文网

端点过滤器是ASP.NET Core 6引入的针对Minimal APIs的轻量级切面机制，执行时机晚于Action过滤器，更贴近业务逻辑，适用于跨MVC与Minimal APIs的细粒度控制。它通过IEndpointFilter接口实现，可在请求处理前后执行验证、日志、异常处理等操作，支持异步和返回值修改，常用于参数校验、权限检查、响应包装等场景。与Action过滤器相比，其作用范围更精确，注册方式更灵活，但需注意参数访问方式、短路逻辑、执行顺序及异常处理。推荐遵循单一职责、强类型参数、异步友好、可测试性等最佳实践，避免过度使用。

asp.net core中的端点过滤器是什么？如何应用？

ASP.NET Core中的端点过滤器（Endpoint Filter）是一种在请求到达最终处理程序（如最小API的委托或MVC控制器的Action方法）之前或之后执行逻辑的机制。它允许你在执行链的特定阶段插入自定义行为，比如验证请求、修改响应、处理异常，或者进行日志记录等。应用端点过滤器主要通过

AddEndpointFilter

登录后复制

或

AddEndpointFilterFactory

登录后复制

扩展方法，将其注册到特定的路由或路由组上。

端点过滤器是ASP.NET Core 6引入的一个新特性，尤其在Minimal APIs中表现出强大的灵活性。它提供了一个更轻量级、更靠近实际业务逻辑的切面编程方式，与传统的Action过滤器或Resource过滤器相比，它执行的位置更晚，因此能更精确地作用于特定的端点。通过实现

IEndpointFilter

登录后复制

接口，你可以定义自己的过滤器逻辑，然后在路由定义时链式地添加它们。

端点过滤器与传统Action过滤器有何不同？我何时应该选择使用它？

嗯，这是一个非常好的问题，因为它直接触及了我们选择技术方案的核心。在我看来，端点过滤器和Action过滤器虽然都能在请求处理流程中插入逻辑，但它们在设计哲学、作用范围以及执行时机上有着本质的区别，这决定了我们何时该优先选择哪一个。

首先，从作用范围来看，Action过滤器是MVC/Razor Pages特有的概念，它作用于Controller的Action方法。这意味着如果你在构建一个混合了Minimal APIs和MVC的应用程序，Action过滤器就无法影响到Minimal APIs的端点。而端点过滤器，顾名思义，是针对ASP.NET Core的“端点”概念设计的，它既可以应用于Minimal APIs，也可以通过一些间接方式（比如在Controller Action中定义为端点）应用于MVC，虽然这通常不是它的主要设计目标。所以，如果你正在大量使用Minimal APIs，或者希望你的过滤逻辑能够跨MVC和Minimal APIs共享（尽管后者实践起来可能需要一些技巧），端点过滤器显然是更直接的选择。

其次是执行时机。Action过滤器在模型绑定之后、Action方法执行之前/之后执行。这意味着你可以在这里访问到已经绑定好的模型数据。端点过滤器则更“晚”一些，它在路由匹配成功、模型绑定之前（如果Minimal API有参数绑定）或之后（如果参数已经绑定）执行，但肯定是在最终的请求委托（即你的Minimal API处理逻辑）执行之前或之后。这种“更晚”的执行时机，使得端点过滤器在处理与具体端点逻辑紧密相关的横切关注点时更加精确。比如，你可能只想对某个特定Minimal API端点进行参数验证，而不是对整个Controller的所有Action。

再者，从实现方式上，Action过滤器可以是同步或异步的，通常通过继承

IActionFilter

登录后复制

或

IAsyncActionFilter

登录后复制

接口实现。端点过滤器也类似，实现

IEndpointFilter

登录后复制

接口，其核心方法

InvokeAsync

登录后复制

返回一个

ValueTask<object?>

登录后复制

，这天然支持异步操作，并且允许你修改返回值。

何时选择端点过滤器？

Minimal APIs是你的主力：如果你正在构建一个以Minimal APIs为主的后端服务，那么端点过滤器无疑是实现横切关注点的首选。它与Minimal APIs的简洁风格高度契合。
需要对特定端点进行精细控制：当你的过滤逻辑只需要作用于一两个特定的路由，而不是整个Controller或一系列Action时，端点过滤器能提供更细粒度的控制。比如，对某个上传文件的API进行文件类型或大小验证。
轻量级、低开销的场景：端点过滤器通常比Action过滤器更轻量，因为它避免了MVC的许多内部机制。对于追求极致性能和简洁性的场景，它可能是一个更好的选择。
修改或包装端点返回值：如果你需要在端点执行后，对返回结果进行统一的包装、修改或格式化，端点过滤器非常适合。

举个例子，假设我们有一个Minimal API，用于创建一个用户，我们希望在用户创建前验证请求体中的邮箱格式是否正确。如果使用Action过滤器，你可能需要将其应用于整个Controller，或者通过属性筛选。而使用端点过滤器，你可以直接将其链式地添加到这个特定的

/users

登录后复制

POST端点上，逻辑清晰且作用范围明确。

// 假设这是我们的自定义端点过滤器
public class EmailValidationFilter : IEndpointFilter
{
    public async ValueTask<object?> InvokeAsync(EndpointFilterContext context, EndpointFilterDelegate next)
    {
        var user = context.Arguments.OfType<CreateUserRequest>().FirstOrDefault();
        if (user != null && !IsValidEmail(user.Email))
        {
            return Results.BadRequest(new { message = "Invalid email format." });
        }
        return await next(context);
    }

    private bool IsValidEmail(string email)
    {
        // 简单的邮箱格式验证
        return email.Contains("@") && email.Contains(".");
    }
}

// 在Minimal API中应用
app.MapPost("/users", (CreateUserRequest user) => { /* ... 创建用户逻辑 ... */ })
   .AddEndpointFilter<EmailValidationFilter>();

登录后复制

这种模式让我觉得非常自然，它把与特定业务逻辑相关的非核心关注点，以一种“即插即用”的方式挂载到了端点上，既保持了业务逻辑的干净，又实现了功能的扩展。

端点过滤器在请求管道中的具体执行时机是怎样的？我应该注意哪些潜在的陷阱？

理解端点过滤器在整个ASP.NET Core请求管道中的位置，是正确使用它的关键。它位于路由匹配之后，但通常在最终的请求处理委托（你的Minimal API lambda表达式或MVC Action）执行之前或之后。我们可以把它想象成一个“微型管道”，包裹着你的实际业务逻辑。

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

查看详情

具体来说，当一个请求进入ASP.NET Core应用程序时，它会经过一系列的中间件：

路由中间件：根据请求路径和HTTP方法匹配到具体的端点。
授权中间件（如果配置了）：处理授权策略。
端点过滤器：如果匹配到的端点注册了端点过滤器，它们将在这里按注册顺序执行。
- ```
InvokeAsync
```
  登录后复制
  方法中的
```
next(context)
```
  登录后复制
  调用之前的代码，会在最终处理程序之前执行。
- ```
next(context)
```
  登录后复制
  调用之后的代码，会在最终处理程序之后执行。
最终的请求处理程序：这是你的Minimal API委托或MVC Action方法，实际的业务逻辑在这里执行。

所以，端点过滤器可以看作是“最靠近”业务逻辑的一层横切关注点。它能够访问

EndpointFilterContext

登录后复制

，这个上下文包含了当前请求的

HttpContext

登录后复制

、路由参数、以及即将传递给下一个委托的参数（

Arguments

登录后复制

）。这使得它能够非常灵活地在执行前进行参数校验、权限检查，或者在执行后修改响应体、记录日志。

潜在的陷阱：

参数访问的挑战：
```
EndpointFilterContext.Arguments
```
登录后复制
是一个
```
IReadOnlyList<object?>
```
登录后复制
，包含了所有即将传递给端点处理委托的参数。这意味着你需要手动地从这个列表中提取和转换参数类型。如果参数顺序或类型发生变化，你的过滤器代码也需要相应更新。这与Action过滤器可以直接访问强类型模型有所不同。
- 解决方案/注意点：在过滤器中，通常会使用
```
context.Arguments.OfType<T>().FirstOrDefault()
```
  登录后复制
  来安全地获取特定类型的参数。这增加了代码的健壮性。
短路机制：如果你的端点过滤器在
```
InvokeAsync
```
登录后复制
中直接返回了一个
```
IResult
```
登录后复制
（比如
```
Results.BadRequest()
```
登录后复制
），那么后续的过滤器和最终的端点处理程序将不会被执行。这是一种强大的短路机制，但也意味着你需要谨慎使用，确保不会意外地阻止了正常的业务流程。
- 解决方案/注意点：明确过滤器的职责。如果一个过滤器旨在进行前置校验并可能短路请求，那么它的逻辑应该清晰且边界明确。
异常处理：端点过滤器内部抛出的未捕获异常，会沿着管道向上冒泡，最终被ASP.NET Core的异常处理中间件（如
```
UseExceptionHandler
```
登录后复制
或开发者异常页面）捕获。如果你希望在过滤器内部处理异常，你需要使用
```
try-catch
```
登录后复制
块。
- 解决方案/注意点：如果你的过滤器逻辑可能抛出异常，考虑将其包裹在
```
try-catch
```
  登录后复制
  中，并根据需要返回适当的
```
IResult
```
  登录后复制
  ，或者重新抛出以由更高级别的异常处理机制处理。
注册顺序的影响：如果你注册了多个端点过滤器，它们会按照注册的顺序依次执行。一个过滤器返回的结果会传递给下一个过滤器（通过
```
next
```
登录后复制
委托）。理解这个执行顺序对于实现复杂的逻辑链至关重要。
- 解决方案/注意点：保持过滤器的职责单一。避免在一个过滤器中做太多事情。如果需要多个步骤，就拆分成多个过滤器，并注意它们的注册顺序。
与传统Action过滤器的混淆：对于从MVC背景转过来的开发者，可能会混淆端点过滤器和Action过滤器的使用场景。记住，端点过滤器更贴近Minimal APIs，也更灵活地处理端点级别的关注点。
- 解决方案/注意点：当你在Minimal API中使用过滤器时，优先考虑端点过滤器。如果是在MVC Controller中，Action过滤器可能仍然是更自然的选项。

我个人在遇到需要对Minimal API进行请求体校验或者权限判断时，会首先想到端点过滤器。它的简洁性和直接性，让我觉得是在正确的位置做了正确的事情。但同时，也必须意识到它对参数的类型依赖性，这要求我们在设计API时，尽量保持参数的稳定性和可预测性。

除了简单的日志记录，端点过滤器还能实现哪些高级功能？有哪些推荐的最佳实践？

端点过滤器远不止是日志记录那么简单，它是一个非常强大的工具，可以实现许多高级功能，极大地提升我们Minimal APIs的健壮性和可维护性。在我看来，它为我们提供了一个优雅的切入点，去处理那些与核心业务逻辑正交的关注点。

高级功能：

请求参数验证与转换：
- 复杂参数校验：除了前面提到的邮箱格式，你可以实现更复杂的业务规则验证，比如检查请求体中的某个字段是否符合特定条件，或者多个字段之间的关联性。如果验证失败，可以直接返回
```
Results.BadRequest
```
  登录后复制
  。
- 参数预处理/转换：在请求到达业务逻辑之前，对某些参数进行标准化、格式化或者类型转换。例如，将传入的字符串日期转换为
```
DateTime
```
  登录后复制
  对象，或者清理用户输入中的特殊字符。
权限与授权检查：
- 虽然ASP.NET Core有内置的授权机制（
```
[Authorize]
```
  登录后复制
  属性或
```
RequireAuthorization()
```
  登录后复制
  ），但端点过滤器可以实现更细粒度的、基于业务逻辑的权限检查。比如，检查当前用户是否对请求的资源拥有“编辑”权限，而不仅仅是“登录”权限。
- 这对于需要动态权限分配或者自定义权限策略的场景非常有用。
响应体修改与包装：
- 统一响应格式：在端点执行成功后，对返回结果进行统一的包装，例如将其封装在一个包含
```
data
```
  登录后复制
  、
```
statusCode
```
  登录后复制
  和
```
message
```
  登录后复制
  的标准JSON对象中。这对于API消费者来说，可以提供一致的体验。
- 敏感数据过滤：在某些情况下，端点可能返回包含敏感信息的对象，而你希望在发送给客户端之前，过滤掉或匿名化这些敏感字段。
- 缓存控制头添加：根据业务逻辑，动态地为响应添加
```
Cache-Control
```
  登录后复制
  、
```
ETag
```
  登录后复制
  等HTTP缓存头。
限流与熔断：
- 结合一些第三方库或自定义逻辑，在端点过滤器中实现对特定API的请求限流（Rate Limiting）。比如，限制某个用户或IP在一定时间内只能访问某个API多少次。
- 这可以保护你的后端服务免受恶意攻击或过载。
事务管理：
- 对于需要跨多个操作保证原子性的业务逻辑，可以在端点过滤器中开启数据库事务，在
```
next()
```
  登录后复制
  调用后提交事务，或者在出现异常时回滚事务。这能让你的业务逻辑更专注于数据操作本身，而将事务的生命周期管理交给过滤器。

推荐的最佳实践：

保持单一职责原则（SRP）：
- 每个端点过滤器应该只关注一件事情。例如，一个过滤器负责验证邮箱格式，另一个负责检查用户权限。避免将所有逻辑都塞进一个过滤器中。这使得过滤器更容易理解、测试和维护。
优先使用强类型参数：
- 虽然
```
context.Arguments
```
  登录后复制
  是
```
object?
```
  登录后复制
  列表，但在过滤器内部，尽量使用
```
OfType<T>().FirstOrDefault()
```
  登录后复制
  来获取参数，并进行空值检查。这比直接通过索引访问要安全得多，并能减少运行时错误。
善用异步操作：
- ```
InvokeAsync
```
  登录后复制
  方法返回
```
ValueTask<object?>
```
  登录后复制
  ，这表明它天生适合异步操作。当你的过滤逻辑涉及I/O操作（如数据库查询、外部API调用）时，务必使用
```
await
```
  登录后复制
  关键字，以避免阻塞线程。
提供清晰的错误响应：
- 当过滤器短路请求时，确保返回一个清晰、有意义的错误响应（例如，
```
Results.BadRequest
```
  登录后复制
  、
```
Results.Unauthorized
```
  登录后复制
  、
```
Results.Forbid
```
  登录后复制
  ），并包含具体的错误信息，方便客户端进行处理。
可测试性：
- 设计过滤器时，考虑其可测试性。尽量将复杂的业务逻辑封装到独立的、可测试的服务中，过滤器只负责协调和调用这些服务。这样可以更容易地对过滤器进行单元测试。
文档化：
- 为你的端点过滤器编写清晰的文档，说明其用途、行为以及可能产生的副作用。这对于团队成员理解和使用这些过滤器至关重要。
避免过度使用：
- 端点过滤器很强大，但并不是万能的。对于一些更全局的、与特定端点关联不强的横切关注点（例如，全局异常处理、HTTP请求日志），中间件（Middleware）可能仍然是更好的选择。端点过滤器更适合那些与特定端点或路由组紧密相关的逻辑。