.Net Core自定义异常过滤器

当系统中出现未经处理的异常时，异常过滤器就会执行。

下面以WebApi项目为例，记录异常过滤器的使用方法。

需求：当开发环境出现异常时，返回异常的堆栈信息。非开发环境出现异常，返回字符串“服务器发生未处理异常”。

1.新建一个WebApi项目，创建一个控制器类，写一个测试action，访问一个不存在的文件。

using Microsoft.AspNetCore.Mvc;

namespace WebApiFilter.Controllers
{
    [Route("api/[controller]/[action]")]
    [ApiController]
    public class DemoController : ControllerBase
    {
        [HttpGet]
        public string Test1()
        {
            string s = System.IO.File.ReadAllText("f:/1.txt");
            return s;
        }
    }
}

 

2.自定义类MyExceptionFilter，实现接口IAsyncExceptionFilter。

using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using System.Threading.Tasks;

namespace WebApiFilter
{
    public class MyExceptionFilter : IAsyncExceptionFilter
    {
        private readonly IWebHostEnvironment _environment;
        public MyExceptionFilter(IWebHostEnvironment environment)
        {
            this._environment = environment;
        }


        public Task OnExceptionAsync(ExceptionContext context)
        {
            //context.Exception代表异常信息对象
            //如果给 context.ExceptionHandled赋值为true，则其他ExceptionFilter不会被执行
            //context.Result的值会被输出到客户端

            string msg;
            if (_environment.EnvironmentName == "Development")
            {
                msg = context.Exception.ToString();
            }
            else
            {
                msg = "服务器发生未处理异常";
            }

            ObjectResult objectResult = new ObjectResult(new
            {
                code = 500,
                message = msg
            });
            context.Result = objectResult;//context.Result的值会被输出到客户端
            context.ExceptionHandled = true;//其他ExceptionFilter不会被执行
            return Task.CompletedTask;
        }
    }
}

3.将自定义的异常过滤器进行注入。

 

设置运行环境变量值为开发，运行项目，可以看到输出的异常信息。

 

 

设置运行环境变量值为其他，运行项目，可以看到输出的异常信息。

 

到此为止，已经实现了根据环境变量的值输出不同的错误信息。

同时可以执行多个自定义的异常过滤器，例如，在上面的基础上，增加异常日志记录的过滤器，发生未经处理的异常时，将异常信息记录到日志文件中。

创建LogExceptionFilter过滤器类，实现IAsyncExceptionFilter接口。

using Microsoft.AspNetCore.Mvc.Filters;
using System.IO;
using System.Threading.Tasks;

namespace WebApiFilter
{
    public class LogExceptionFilter : IAsyncExceptionFilter
    {
        public Task OnExceptionAsync(ExceptionContext context)
        {
            //将异常信息记录到日志文件中
            return File.AppendAllTextAsync("f:/error.log", context.Exception.ToString());
        }
    }
}

将新加的过滤器注入到服务中

 

运行项目，就会看到异常信息被记录到文件中了。

 日志文件的内容：