ASP.NET Core异常Filter使用技巧

下面详细介绍 ASP.NET Core 异常Filter 的使用技巧，从异常处理场景、创建自定义Filter、全局注册到依赖注入等方面进行解析，并辅以原理解释表及思维导图，帮助你全面掌握相关技巧。😊

1. 异常Filter概述

异常Filter 是 ASP.NET Core 中用于捕获控制器或Action中未处理异常的一种机制。它能够在异常抛出后统一处理，记录日志、返回标准化错误响应等。相比中间件，全局异常处理Filter适用于捕获控制器层面的异常，具备更细粒度的控制能力。

2. 创建自定义异常Filter

通过实现 IExceptionFilter 或 IAsyncExceptionFilter 接口，可以创建自定义异常Filter。下面是一个简单示例代码：

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using System;

namespace MyApp.Filters
{
    // 实现 IExceptionFilter 接口，实现同步异常处理
    public class CustomExceptionFilter : IExceptionFilter
    {
        // 构造函数中可通过依赖注入引入日志记录器
        public CustomExceptionFilter(ILogger<CustomExceptionFilter> logger)
        {
            _logger = logger;
        }
        private readonly ILogger<CustomExceptionFilter> _logger;

        // 实现 OnException 方法，捕获异常后执行
        public void OnException(ExceptionContext context)
        {
            // 输出异常日志
            _logger.LogError(context.Exception, "发生异常：{Message}", context.Exception.Message);

            // 构造标准错误响应
            var errorResponse = new
            {
                Code = 500,
                Message = "服务器内部错误，请稍后重试。"
            };

            // 返回 JSON 格式错误响应，并设置状态码为500
            context.Result = new JsonResult(errorResponse)
            {
                StatusCode = 500
            };

            // 设置异常已处理，防止后续处理
            context.ExceptionHandled = true;
        }
    }
}

代码解析：

• 命名空间与引用：引入 Microsoft.AspNetCore.Mvc.Filters 提供Filter接口，Microsoft.Extensions.Logging 用于日志记录。
• CustomExceptionFilter 类：实现 IExceptionFilter 接口，必须实现 OnException 方法。
• 构造函数：通过构造函数注入 ILogger 对象，实现日志输出。
• OnException 方法：
  • 调用 _logger.LogError 输出异常信息，便于后续排查问题。
  • 构造一个匿名对象作为标准错误响应，并使用 JsonResult 返回，同时设置 HTTP 状态码为500。
  • 将 context.ExceptionHandled 设置为 true，表示异常已处理，不再传递。

3. 异常Filter的注册方式

3.1 局部注册

在控制器或Action上应用 异常Filter：

using Microsoft.AspNetCore.Mvc;
using MyApp.Filters;

[TypeFilter(typeof(CustomExceptionFilter))]
public class HomeController : Controller
{
    public IActionResult Index()
    {
        // 模拟异常
        throw new Exception("测试异常");
    }
}

代码解析：

• 使用 [TypeFilter(typeof(CustomExceptionFilter))] 特性，在 HomeController 上注册自定义异常Filter，使得该控制器中所有Action均受保护。
• 当 Index Action 抛出异常时，CustomExceptionFilter 会捕获并处理。

3.2 全局注册

在 Startup.cs 中配置全局异常Filter：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews(options =>
    {
        // 将自定义异常Filter添加到全局过滤器集合中
        options.Filters.Add<CustomExceptionFilter>();
    });
}

代码解析：

• 在 ConfigureServices 方法中，通过 AddControllersWithViews 的 options.Filters 集合添加自定义异常Filter。
• 全局注册后，所有控制器中的未处理异常均将通过 CustomExceptionFilter 进行捕获和处理。

4. 使用技巧与最佳实践

1. 依赖注入支持：利用构造函数注入所需服务，如日志记录器、数据库操作对象等，确保Filter具备完整功能。
2. 细粒度控制：根据业务需求，可在不同层级（控制器级、Action级或全局）注册异常Filter，实现不同异常处理策略。
3. 日志与通知：在捕获异常后，可扩展功能，如发送邮件或短信通知管理员，确保异常信息及时反馈。
4. 标准化响应格式：统一错误响应格式，有助于前端统一处理异常，提高用户体验。

5. 原理解释表

下面的表格总结了 ASP.NET Core 异常Filter 的核心原理及相关概念，适用于 WordPress Classic Editor：

6. 思维导图概览

以下是实现 异常Filter 的思维导图结构，有助于直观理解各组件间的关系：

• 异常Filter
  • 实现接口
    • IExceptionFilter 或 IAsyncExceptionFilter
  • 自定义Filter
    • 重写 OnException 方法
    • 日志记录与错误响应构造
  • 注册方式
    • 局部注册：控制器或Action级别
    • 全局注册：Startup配置全局Filters
  • 依赖注入
    • 构造函数注入 Logger、其他服务

此思维导图帮助理清 异常Filter 的创建、注册及使用流程，有助于快速掌握实践技巧。🔍

7. 总结

通过以上解析，我们了解了 ASP.NET Core 异常Filter 的核心概念、创建步骤及最佳实践。掌握自定义异常Filter的开发和全局配置方法，可以使系统异常处理更加统一、便捷，提高整体应用的健壮性和可维护性。希望这份解析能助你在开发中更高效地捕获和处理异常，提升系统质量！😊