asp.net core MVC 全局过滤器之ExceptionFilter过滤器(1)

在ASP.NET Core MVC中，我们可以使用全局过滤器来处理应用程序中的异常。其中，ExceptionFilter过滤器是一种常用的全局过滤器，用于处理应用程序中的异常。在本文中，我们将详细讲解ExceptionFilter过滤器的使用方法。

ExceptionFilter过滤器

ExceptionFilter过滤器是一种全局过滤器，用于处理应用程序中的异常。当应用程序中发生异常时，ExceptionFilter过滤器会捕获异常，并执行自定义的异常处理逻辑。我们可以使用ExceptionFilter过滤器来记录异常信息、发送错误邮件、显示友好的错误页面等。

使用ExceptionFilter过滤器

在ASP.NET Core MVC中，我们可以使用ExceptionFilter过滤器来处理应用程序中的异常。下面是使用ExceptionFilter过滤器的步骤：

1. 创建一个名为“CustomExceptionFilter”的ExceptionFilter过滤器。

public class CustomExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        // 处理异常
    }
}

在上面的代码中，我们创建了一个名为CustomExceptionFilter的ExceptionFilter过滤器，并实现了OnException方法。在OnException方法中，我们可以处理应用程序中的异常。

1. 在Startup类中注册CustomExceptionFilter过滤器。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews(options =>
    {
        options.Filters.Add(new CustomExceptionFilter());
    });
}

在上面的代码中，我们在ConfigureServices方法中注册了CustomExceptionFilter过滤器。

1. 在CustomExceptionFilter过滤器中处理异常。

public class CustomExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        var exception = context.Exception;
        var message = exception.Message;
        var stackTrace = exception.StackTrace;

        // 记录异常信息
        Console.WriteLine($"Exception: {message}");
        Console.WriteLine($"StackTrace: {stackTrace}");

        // 发送错误邮件
        var emailService = context.HttpContext.RequestServices.GetService<IEmailService>();
        emailService.SendErrorEmail(message, stackTrace);

        // 显示友好的错误页面
        context.Result = new ViewResult
        {
            ViewName = "Error",
            ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider(), new ModelStateDictionary())
            {
                Model = new ErrorViewModel { Message = message }
            }
        };

        context.ExceptionHandled = true;
    }
}

在上面的代码中，我们在CustomExceptionFilter过滤器的OnException方法中处理异常。我们首先记录异常信息，并使用依赖注入获取IEmailService服务发送错误邮件。然后，我们使用ViewResult显示友好的错误页面，并将ExceptionHandled属性设置为true，表示异常已经被处理。

示例一：使用ExceptionFilter过滤器记录异常信息

在这个示例中，我们将演示如何使用ExceptionFilter过滤器记录异常信息。

1. 创建一个新的ASP.NET Core MVC应用程序。
2. 创建一个名为“CustomExceptionFilter”的ExceptionFilter过滤器。

public class CustomExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        var exception = context.Exception;
        var message = exception.Message;
        var stackTrace = exception.StackTrace;

        // 记录异常信息
        Console.WriteLine($"Exception: {message}");
        Console.WriteLine($"StackTrace: {stackTrace}");
    }
}

在上面的代码中，我们创建了一个名为CustomExceptionFilter的ExceptionFilter过滤器，并实现了OnException方法。在OnException方法中，我们记录异常信息。

1. 在Startup类中注册CustomExceptionFilter过滤器。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews(options =>
    {
        options.Filters.Add(new CustomExceptionFilter());
    });
}

在上面的代码中，我们在ConfigureServices方法中注册了CustomExceptionFilter过滤器。

1. 在HomeController中抛出异常。

public class HomeController : Controller
{
    public IActionResult Index()
    {
        throw new Exception("An error occurred.");
    }
}

在上面的代码中，我们在HomeController的Index方法中抛出异常。

1. 运行应用程序，并访问HomeController的Index方法。

在浏览器中输入应用程序的URL，并访问HomeController的Index方法。在控制台中，我们将看到记录的异常信息。

示例二：使用ExceptionFilter过滤器显示友好的错误页面

在这个示例中，我们将演示如何使用ExceptionFilter过滤器显示友好的错误页面。

1. 创建一个新的ASP.NET Core MVC应用程序。
2. 创建一个名为“CustomExceptionFilter”的ExceptionFilter过滤器。

public class CustomExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        var exception = context.Exception;
        var message = exception.Message;

        // 显示友好的错误页面
        context.Result = new ViewResult
        {
            ViewName = "Error",
            ViewData = new ViewDataDictionary(new EmptyModelMetadataProvider(), new ModelStateDictionary())
            {
                Model = new ErrorViewModel { Message = message }
            }
        };

        context.ExceptionHandled = true;
    }
}

在上面的代码中，我们创建了一个名为CustomExceptionFilter的ExceptionFilter过滤器，并实现了OnException方法。在OnException方法中，我们使用ViewResult显示友好的错误页面，并将ExceptionHandled属性设置为true，表示异常已经被处理。

1. 在HomeController中抛出异常。

public class HomeController : Controller
{
    public IActionResult Index()
    {
        throw new Exception("An error occurred.");
    }
}

在上面的代码中，我们在HomeController的Index方法中抛出异常。

1. 创建一个名为“Error”的视图。

在Views文件夹中创建一个名为“Error”的文件夹，并在该文件夹中创建一个名为“Index.cshtml”的视图。在视图中，我们可以显示错误消息。

@model ErrorViewModel

<h1>Error</h1>

<p>@Model.Message</p>

在上面的代码中，我们创建了一个名为“Error”的视图，并在视图中显示错误消息。

1. 运行应用程序，并访问HomeController的Index方法。

在浏览器中输入应用程序的URL，并访问HomeController的Index方法。我们将看到友好的错误页面，其中包含错误消息。