ASP.NET Core API中ExceptionFilterAttribute集成IStringLocalizer的最佳实践
我之前也碰到过一模一样的问题——特性(Attribute)是由CLR直接实例化的,确实没办法直接通过构造函数注入依赖,毕竟它的创建时机早于DI容器的初始化。不过社区里有几个公认的最佳实践方案,你可以根据自己的场景挑合适的用:
方案1:从HttpContext.RequestServices获取服务
这是最直接的临时解决方案。ExceptionFilterAttribute的OnException方法能拿到ExceptionContext,里面包含了HttpContext,我们可以通过它的RequestServices来解析需要的服务,包括IStringLocalizer。
示例代码:
public class CustomExceptionFilter : ExceptionFilterAttribute { public override void OnException(ExceptionContext context) { // 从请求服务中获取本地化器 var localizer = context.HttpContext.RequestServices .GetRequiredService<IStringLocalizer<CustomExceptionFilter>>(); if (context.Exception is UnauthorizedAccessException) { context.Result = new ObjectResult(localizer["Unauthorized Access"]) { StatusCode = (int)HttpStatusCode.Unauthorized }; } else if (context.Exception is KeyNotFoundException) { context.Result = new ObjectResult(localizer["Key Not Found"]) { StatusCode = (int)HttpStatusCode.NotFound }; } context.ExceptionHandled = true; } }
优缺点:实现简单,不需要额外配置;但依赖HttpContext,单元测试时需要模拟RequestServices,稍微麻烦一点。
方案2:用ServiceFilter/TypeFilter注册过滤器(官方推荐)
ASP.NET Core提供了ServiceFilterAttribute和TypeFilterAttribute,允许我们把过滤器作为服务注册到DI容器中,这样就能正常注入依赖了。
步骤1:把过滤器改成普通类,实现IExceptionFilter
public class CustomExceptionFilter : IExceptionFilter { private readonly IStringLocalizer<CustomExceptionFilter> _localizer; // 构造函数直接注入本地化器 public CustomExceptionFilter(IStringLocalizer<CustomExceptionFilter> localizer) { _localizer = localizer; } public void OnException(ExceptionContext context) { if (context.Exception is UnauthorizedAccessException) { context.Result = new ObjectResult(_localizer["Unauthorized Access"]) { StatusCode = (int)HttpStatusCode.Unauthorized }; } else if (context.Exception is KeyNotFoundException) { context.Result = new ObjectResult(_localizer["Key Not Found"]) { StatusCode = (int)HttpStatusCode.NotFound }; } context.ExceptionHandled = true; } }
步骤2:注册过滤器服务
在Program.cs里把过滤器添加到DI容器:
builder.Services.AddScoped<CustomExceptionFilter>();
步骤3:使用ServiceFilter应用过滤器
- 控制器级别:
[ServiceFilter(typeof(CustomExceptionFilter))] public class MyApiController : ControllerBase { // ... }
- 全局注册(对所有控制器生效):
builder.Services.AddControllers(options => { options.Filters.Add<CustomExceptionFilter>(); });
如果不想提前注册服务,也可以用TypeFilter(它会动态实例化过滤器,适合临时场景):
[TypeFilter(typeof(CustomExceptionFilter))] public class MyApiController : ControllerBase { // ... }
优缺点:完全符合DI设计原则,依赖清晰,单元测试友好;需要额外的注册步骤,但这是官方推荐的标准做法。
方案3:改用全局异常处理中间件
如果你的异常处理逻辑比较复杂,或者想要统一处理所有未捕获的异常,中间件是个更好的选择——中间件天然支持DI,可以直接在构造函数注入IStringLocalizer。
示例代码:
public class ExceptionHandlingMiddleware { private readonly RequestDelegate _next; private readonly IStringLocalizer<ExceptionHandlingMiddleware> _localizer; public ExceptionHandlingMiddleware(RequestDelegate next, IStringLocalizer<ExceptionHandlingMiddleware> localizer) { _next = next; _localizer = localizer; } public async Task InvokeAsync(HttpContext context) { try { await _next(context); } catch (UnauthorizedAccessException) { context.Response.StatusCode = (int)HttpStatusCode.Unauthorized; await context.Response.WriteAsJsonAsync(new { Message = _localizer["Unauthorized Access"] }); } catch (KeyNotFoundException) { context.Response.StatusCode = (int)HttpStatusCode.NotFound; await context.Response.WriteAsJsonAsync(new { Message = _localizer["Key Not Found"] }); } catch (Exception) { context.Response.StatusCode = (int)HttpStatusCode.InternalServerError; await context.Response.WriteAsJsonAsync(new { Message = _localizer["An unexpected error occurred"] }); } } }
然后在Program.cs里注册中间件(注意顺序,要放在UseRouting之后,UseEndpoints之前):
app.UseMiddleware<ExceptionHandlingMiddleware>();
优缺点:全局统一处理,逻辑集中;但只能捕获未被过滤器处理的异常,如果需要针对特定控制器/方法做差异化处理,可能需要结合过滤器使用。
总结
如果只是局部控制器需要异常处理,推荐用方案2(ServiceFilter+DI注册),这是ASP.NET Core官方倡导的最佳实践;如果要全局统一处理所有异常,**方案3(中间件)**会更合适。
内容的提问来源于stack exchange,提问作者PatrickNolan

