Developer Exception Page Middleware in ASP.NET Core Application
在这篇文章中,我将向大家介绍,怎么在ASP.NET Core应用程序中,使用异常页面中间件,来处理我们程序中未处理的异常。在阅读这篇文章之前,可以看看我这个系列的之前写的文章。异常处理是所有应用程序中,特别关键的一个点,我们可以通过各种方式方法,来处理异常,但是在这篇文章我要向大家讲解,怎样使用异常页面中间件来处理异常。这篇文章中,我们主要讨论下面几个点:
什么是开发者异常页面中间件?
怎样在ASP.NET Core应用程序中,使用异常页面中间件?
怎样定制异常中间件?
我们在哪配置异常页面中间件?
理解异常页面中间件
默认情况下,ASP.NET Core应用程序,如果发生了异常,就是仅仅简单的返回一个状态码。我们通过一个例子,来了解一下。我们修改一下Configure方法,返回一个异常:
运行程序:就会看到这样的页面。
正如你上图所看到的,返回了一个500状态码,表示:服务器内部异常。但是作为一个开发者,当你开发应用程序,你应该要在页面上知道,异常的详细信息,然后你才能分析,并采取措施解决Bug.
怎样在ASP.NET Core应用程序中,使用DeveloperExceptionPage 中间件?
当程序发生异常的时候,如果你想在页面中显示异常的详细信息的话,你需要使用Developer Exception Page中间件。所以我们来修改一下Configure方法。在我们的程序中,添加异常中间件。
然后运行应用程序,就看到为什么发生异常了。也能定位错误了!
正如你在图中所看到的,Developer Exception Page包含一些Tab,例如:Stack、Query、Cookies、Headers. Stack向你展示哪一行代码发生的异常。Query向你展示Query Strings相关信息。Cookies向你展示请求设置的Cookies,Header向你展示客户端发送的请求报文头。
如果你查看Query Tab就会发现,没有Querystring相关信息,因为你没有在URL中传递querystring的信息,或者你没有在请求中设置Cooikes.我们在后面的文章中,将会详细讨论querystring 以及Cookies.
请注意:请仅仅只在看来开发模式下面使用Developer Exception Page中间件。因为你不想在生产环境显示这个开发的异常信息的。
怎样在ASP.NET Core应用程序中定制UseDeveloperExceptionPage中间件?
如果你想,你也可以定制异常中间件。你需要记住的是:不管你什么时候,想要定制特定中间件,你需要使用下面这些东西:
- UseDeveloperExceptionPage==>为了能定制异常中间件,需要使用DeveloperExceptionPageOption对象;
- UseDefaultFiles==>使用DefaultFileOptions对象来定制中间件;
- UseStaticFiles==>使用StaticFileOptions对象来定制中间件;
- UseFileServer==>使用FileServerOptions对象来定制中间件;
我们将要定制UseDeveloperExceptionPage中间件,所以我们需要使用DeveloperExceptionPageOptions对象。看下图:
运行程序:
DeveloperExceptionPageOptions类的SourceCodeLineCount属性指定了导致异常的代码行之前和之后要包含的代码行数。
我们在哪需要配置异常中间件UseDeveloperExceptionPage?
我们应该尽可能早的,在请求管道中配置异常中间件,这样我们就能发现,并显示异常信息在页面中了。
我们来修改一下Configure方法。将异常中间件放在Run方法之后再注册。
然后我们再次运行程序:
就会发现,不会在页面显示详细的异常信息了。这也就是为什么,我强调,我们应该尽可能早的配置异常中间件,以便处理程序中为处理的异常。
这篇文章,是我们ASP.NET Core基础概念学习系列的最后一篇文章了,从后面的系列开始,我们就正式进入ASP.NET Core的相关学习了。希望大家喜欢。