[转]Create Custom Exception Filter in ASP.NET Core
本文转自:http://www.binaryintellect.net/articles/5df6e275-1148-45a1-a8b3-0ba2c7c9cea1.aspx
In my previous article I explained how errors in an ASP.NET Core web application can be dealt with using middleware. I also mentioned that time that you can also use exception filters to handle errors. In this article I will explain how to do just that.
In ASP.NET MVC 5 you used the [HandleError] attribute and OnException() controller method to deal with exceptions that arise in the actions of a controller. In ASP.NET Core the process is bit different but the overall concept is still the same. As you are probable aware of, filters sit in the ASP.NET Core pipeline and allow you to execute a piece of code before or after an action execution. To understand how errors can be handled in ASP.NET Core let's create an exception filter called HandleException and then try to mimic the behavior of [HandleError] of ASP.NET MVC 5.
Begin by creating a new ASP.NET web application. Then add a class to it named HandleExceptionAttribute. This class needs to inherit from ExceptionFilterAttribute base class. The complete code of this class is shown below:
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Mvc.ViewFeatures;
....
.... public class HandleExceptionAttribute : ExceptionFilterAttribute
{
public override void OnException(ExceptionContext context)
{
var result = new ViewResult { ViewName = "Error" };
var modelMetadata = new EmptyModelMetadataProvider();
result.ViewData = new ViewDataDictionary(
modelMetadata, context.ModelState);
result.ViewData.Add("HandleException",
context.Exception);
context.Result = result;
context.ExceptionHandled = true;
}
}
}
The HandleExceptionAttribute class overrides the OnException() method of t he base class. The OnException() method is called only when there is an unhandled exception in an action. Inside, we create a ViewResult object that represents the custom error page. It is assumed that the view representing the custom error page is Error.cshtml. Later we will write some code to remove this hard-coding.
Then the code creates an empty object of EmptyModelMetadataProvider class. This is required because we need to initialize the ViewData of the request and add exception details in it. Then ViewData property of the ViewResult is assigned to a new ViewDataDictionary object. While creating the ViewDataDictionary the IModelMetadataProvider object created earlier is passed to the constructor along with the context's ModelState.
We would like to store the exception details into the ViewData so that the Error view can retrieve them and possibly display on the page. To facilitate this HandleException key is added to the ViewData. The exception being thrown can be obtained using context's Exception property.
Then Result property of context is set to the ViewResult we just configured. Finally, ExceptionHandled property is set to true to indicate that the exception need not be bubbled up any further.
Now open the HomeController and decorate the Index() action with the [HandleException] attribute.
[HandleException]
public IActionResult Index()
{
throw new Exception("This is some exception!!!");
return View();
}
Also add Error.cshtml in Shared folder and write the following code to it:
@{
Exception ex = ViewData["HandleException"] as Exception;
} <h1>@ex.Message</h1> <div>@ex.StackTrace</div>
As you can see the Error view can grab the exception details using the HandleException key stored in the ViewData. The Message and StackTrace properties of the Exception are then outputted on the page.
If you run the application you should see the error page like this:
So far so good. Now let's add a couple of features to our [HandleException] attribute:
- The ViewName should be customizable
- There should be provision to handle only specific type of exceptions
Go ahead and add two public properties to the HandleExceptionAttribute class. These properties are shown below:
public class HandleExceptionAttribute : ExceptionFilterAttribute
{ public string ViewName { get; set; } = "Error";
public Type ExceptionType { get; set; } = null;
....
....
}
The ViewName property allows you to specify a custom view name that is then used while forming the ViewResult. The ExceptionType property holds the Type of the exception you wish to handle (say DivideByZeroException or FormatException).
Then modify the OnException() as shown below:
public override void OnException(ExceptionContext context)
{
if(this.ExceptionType != null)
{
if(context.Exception.GetType() == this.ExceptionType)
{
....
....
}
}
else
{
....
....
}
}
The OnException() method now checks whether a specific ExceptionType is to be handled (non null value). If yes then it checks whether the exception being thrown matches with that type (inner if block) and accordingly ViewResult is configured. If no specific ExceptionType is to be checked then control directly goes in the else block. The code in both the cases is shown below:
var result = new ViewResult { ViewName = this.ViewName };
var modelMetadata = new EmptyModelMetadataProvider();
result.ViewData = new ViewDataDictionary
(modelMetadata, context.ModelState);
result.ViewData.Add("HandleException", context.Exception);
context.Result = result;
context.ExceptionHandled = true;
This code is quite similar to what you wrote earlier. But this time it uses the ViewName property while forming the ViewResult.
Now open the HomeController and change the [HandleException] attribute like this:
[HandleException(ViewName ="CustomError",
ExceptionType =typeof(DivideByZeroException))]
public IActionResult Index()
{
throw new Exception("This is some exception!!!");
return View();
}
Now the [HandleException] attribute specifies two properties - ViewName and ExceptionType. Since ExceptionType is set to the type of DivideByZeroException the [HandleException] won't handle the error (because Index() throws a custom Exception). So, rename Error.cshtml to CustomError.cshtml and throw a DivideByZeroException. This time error gets trapped as expected.
It should be noted that [HandleException] can be applied on top of the controller class itself rather than to individual actions.
[HandleException]
public class HomeController : Controller
{
....
....
}
More details about the ASP.NET Core filters can be found here.
That's it for now! Keep coding!!
[转]Create Custom Exception Filter in ASP.NET Core的更多相关文章
- java中如何创建自定义异常Create Custom Exception
9.创建自定义异常 Create Custom Exception 马克-to-win:我们可以创建自己的异常:checked或unchecked异常都可以, 规则如前面我们所介绍,反正如果是chec ...
- 002.Create a web API with ASP.NET Core MVC and Visual Studio for Windows -- 【在windows上用vs与asp.net core mvc 创建一个 web api 程序】
Create a web API with ASP.NET Core MVC and Visual Studio for Windows 在windows上用vs与asp.net core mvc 创 ...
- 004.Create a web app with ASP.NET Core MVC using Visual Studio on Windows --【在 windows上用VS创建mvc web app】
Create a web app with ASP.NET Core MVC using Visual Studio on Windows 在 windows上用VS创建mvc web app 201 ...
- Global exception handling in asp.net core webapi
在.NET Core中MVC和WebAPI已经组合在一起,都继承了Controller,但是在处理错误时,就很不一样,MVC返回错误页面给浏览器,WebAPI返回Json或XML,而不是HTML.Us ...
- Custom Exception in ASP.NET Web API 2 with Custom HttpResponse Message
A benefit of using ASP.NET Web API is that it can be consumed by any client with the capability of m ...
- [转]How do you create a custom AuthorizeAttribute in ASP.NET Core?
问: I'm trying to make a custom authorization attribute in ASP.NET Core. In previous versions it was ...
- [转]ASP.NET Core Exception Filters and Resource Filters
本文转自:https://damienbod.com/2015/09/30/asp-net-5-exception-filters-and-resource-filters/ This article ...
- Asp.Net Core Filter 深入浅出的那些事-AOP
一.前言 在分享ASP.NET Core Filter 使用之前,先来谈谈AOP,什么是AOP 呢? AOP全称Aspect Oriented Programming意为面向切面编程,也叫做面向方法编 ...
- Filters in ASP.NET Core
Filters in ASP.NET Core allow code to be run before or after specific stages in the request processi ...
随机推荐
- tomcat 安装与使用!
$安装:安装方式为zip解压. 打开tomcat官网点此链接:https://tomcat.apache.org/download-80.cgi 选择你想要使用的版本,点击相应位数选择zip解压包版, ...
- WPF 动态更换模板
Window x:Class="模板选择器.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml ...
- EF进阶篇(二)——CRUD
前言 不写前言了... 内容 我们都知道我们修改的实体状态添加到上下文里面,然后上下文根据实体状态生成相应的SQL执行脚本,去隐式执行到数据库中.(屏幕前的你暂且这样理解吧,因为小编语文没有学好,太通 ...
- O(n^2) 级别的排序算法
o(n^2) 的排序算法.性能那么差,为什么还要学习? 首先,它是基础,千里之行,始于足下.它编码简单,容易实现,是一些简单情景的首选,它能给我们的问题一个暴力的解法,这样的解法也许不是最优的,但是它 ...
- 22.Container With Most Water(能装最多水的容器)
Level: Medium 题目描述: Given n non-negative integers a1, a2, ..., an , where each represents a point ...
- promise的一个简单易懂实例
Promise: <!DOCTYPE html> <html lang="en"> <head> <meta charset=" ...
- C++_异常2-返回错误码
一种比异常终止更灵活的办法是,使用函数的返回值来指出问题. 例如,ostream类的get(void)成员通常返回下一个输入字符的ASCII码,但到达文件尾时,将返回EOF. 对hmean()来说,这 ...
- JAVA数据结构--LinkedList双向链表
链表是一种物理存储单元上非连续.非顺序的存储结构,数据元素的逻辑顺序是通过链表中的指针链接次序实现的.链表由一系列结点(链表中每一个元素称为结点)组成,结点可以在运行时动态生成.每个结点包括两个部分: ...
- nginx+uwsgi+virtualenv+supervisor部署项目
一.导论 WSGI是Web服务器网关接口.它是一个规范,描述了Web服务器如何与Web应用程序通信,以及Web应用程序如何链接在一起以处理一个请求,(接收请求,处理请求,响应请求) 基于wsgi运行的 ...
- DVWA1.9平台XSS小结
LOW级别就不写了...... 直接上中高级别(结合源码更好理解) 1.XSS Reflected(Medium) 从源码中可以清楚的看到,输入的<script>标签被过滤掉了,看清了,只 ...