Core中间件和过滤器实现错误日志记录盛杰堂心水论坛

发布日期:2019-10-07 21:20   来源:未知   阅读:

  ASP.NET Core的处理流程是一个管道,中间件是组装到应用程序管道中用来处理请求和响应的组件。每个中间件可以:

  中间件是一个请求委托(publicdelegateTask RequestDelegate(HttpContext context))的实例,所以中间件的本质就是一个方法,方法的参数是HttpContext,返回Task。传入的HttpContext参数包含了请求和响应信息,我们可以在中间件中对这些信息就行修改。中间件的管道处理流程如下:

  我们知道中间件是配置请求处理管道的组件,那么谁来负责构建管道呢?负责构建管道的角色是ApplicationBuilder。ApplicationBuilder通过Use、Run、Map及MapWhen方法来注册中间件,构建请求管道。我们简单看下这几个方法。

  新建一个WebAPI项目,修改StartUp中的Configure方法如下,用Run方法注册的中间件可以叫做终端中间件,即该中间件执行完成后不再执行后续的中间件。

  Use方法的参数是一个委托实例,委托的第一个参数是HttpContext,这是待处理的请求上下文;第二个参数next是下一个中间件,我们可以通过oke调用下一个中间件,并且可以在调用下一个中间件之前/之后对HttpContext做一个逻辑处理。

  运行程序如下所示。注意如果我们没有调用oke方法,会造成管道短路,后续的所有中间件都不再执行。

  在业务简单的情况下,使用一个请求处理管道来处理所有的请求就可以了,当业务复杂的时候, 我们可能考虑把不同业务的请求交给不同的管道中处理。Map 基于给定请求路径的匹配项来创建请求管道分支。如果请求路径以给定路径开头,盛杰堂心水论坛,则执行分支。看一个栗子,需求是/userinfo开头的请求使用用户分支管道来处理,/product开头的请求使用产品分支管道处理,代码如下:

  MapWhen和Map的思想比较相似,MapWhen基于自定义条件来创建请求管道分支,并将请求映射到管道的新分支。看一个栗子就明白了,下边栗子的需求是查询参数包含name的请求交给一个分支管道处理,url包含/userinfo的请求交给用户分支来处理,代码如下:

  到这里我们对中间件已经有了一个基本的了解,接下了通过一个异常日志 中间件来了解开发中怎么去使用中间件。

  这里使用的日志组件为nlog,首先创建一个WebAPI项目,添加一个自定义日志处理中间件CostomErrorMiddleware,当程序出错时会记录日志,同时开发环境下会把异常的详细信息打印在页面上,非开发环境隐藏详细信息,代码如下:

  到这里异常处理中间件就注册完成了,修改ValueController自己制造一个异常来测试一下,代码如下:

  运行程序,在开发环境下访问/Values/1,显示结果如下,同时这些错误信息也会通过nlog写入到错误日志中:

  过滤器大家应该都很熟悉,在Core中过滤器的使用没有太大的变化,这里也实现一个使用过滤器记录错误日志的栗子,直接看代码吧,首先创建一个过滤器,代码如下:

  修改StartUp类,注入nlog,配置全局过滤器,代码如下,其中fig和中间件栗子中一样:

  然后修改ValuesController,设置错误和上边中间件的栗子一样,运行代码访问/values/1时,在开发环境中显示如下,同时错误信息也会写入错误日志中:

  在生产环境中访问/values/1的话,错误详细也会写入错误日志中,浏览器显示如下:

  本文介绍了中间件的基本使用,同时使用中间件和过滤器两种方式实现了异常日志的记录,如果文中有错误的地方希望大家可以指出,我会及时改正。