38

我正在尝试在构建于 OWIN 中间件（使用 Owin.Host.SystemWeb 的 IIS 主机）之上的 ASP.NET Web API 2.1 项目中创建统一的错误处理/报告。目前我使用了一个自定义异常记录器，它继承自System.Web.Http.ExceptionHandling.ExceptionLogger并使用 NLog 记录所有异常，如下代码：

public class NLogExceptionLogger : ExceptionLogger
{

    private static readonly Logger Nlog = LogManager.GetCurrentClassLogger();
    public override void Log(ExceptionLoggerContext context)
    {
       //Log using NLog
    } 
}

我想将所有 API 异常的响应正文更改为友好的统一响应，该响应使用System.Web.Http.ExceptionHandling.ExceptionHandler以下代码隐藏所有异常详细信息：

public class ContentNegotiatedExceptionHandler : ExceptionHandler
{
    public override void Handle(ExceptionHandlerContext context)
    {
        var errorDataModel = new ErrorDataModel
        {
            Message = "Internal server error occurred, error has been reported!",
            Details = context.Exception.Message,
            ErrorReference = context.Exception.Data["ErrorReference"] != null ? context.Exception.Data["ErrorReference"].ToString() : string.Empty,
            DateTime = DateTime.UtcNow
        };

        var response = context.Request.CreateResponse(HttpStatusCode.InternalServerError, errorDataModel);
        context.Result = new ResponseMessageResult(response);
    }
}

当发生异常时，这将为客户端返回以下响应：

{
  "Message": "Internal server error occurred, error has been reported!",
  "Details": "Ooops!",
  "ErrorReference": "56627a45d23732d2",
  "DateTime": "2015-12-27T09:42:40.2982314Z"
}

现在，如果Api Controller 请求管道中发生任何异常，这一切都很好。

但是在我的情况下，我使用中间件Microsoft.Owin.Security.OAuth来生成不记名令牌，而这个中间件对 Web API 异常处理一无所知，所以例如，如果在方法中抛出了异常，ValidateClientAuthentication我将NLogExceptionLogger不会ContentNegotiatedExceptionHandler知道有关此异常的任何信息，也不尝试处理它，我在中使用的示例代码AuthorizationServerProvider如下：

public class AuthorizationServerProvider : OAuthAuthorizationServerProvider
{
    public override Task ValidateClientAuthentication(OAuthValidateClientAuthenticationContext context)
    {
        //Expcetion occurred here
        int x = int.Parse("");

        context.Validated();
        return Task.FromResult<object>(null);
    }

    public override async Task GrantResourceOwnerCredentials(OAuthGrantResourceOwnerCredentialsContext context)
    {
        if (context.UserName != context.Password)
        {
            context.SetError("invalid_credentials", "The user name or password is incorrect.");
            return;
        }

        var identity = new ClaimsIdentity(context.Options.AuthenticationType);

        identity.AddClaim(new Claim(ClaimTypes.Name, context.UserName));

        context.Validated(identity);
    }
}

因此，我将不胜感激在实施以下 2 个问题方面的任何指导：

1 - 创建一个仅处理由 OWIN 中间件生成的异常的全局异常处理程序？我按照这个答案创建了一个用于异常处理的中间件并将其注册为第一个中间件，并且我能够记录源自“OAuthAuthorizationServerProvider”的异常，但我不确定这是否是最佳方法。

2 - 现在，当我在上一步中实现日志记录时，我真的不知道如何更改异常的响应，因为我需要为“OAuthAuthorizationServerProvider”中发生的任何异常返回一个标准的 JSON 模型给客户端。这里有一个相关的答案，我试图依赖它，但它没有用。

这是我的 Startup 类和GlobalExceptionMiddleware我为异常捕获/记录创建的自定义。缺少的和平正在为任何异常返回统一的 JSON 响应。任何想法将不胜感激。

public class Startup
{
    public void Configuration(IAppBuilder app)
    {
        var httpConfig = new HttpConfiguration();

        httpConfig.MapHttpAttributeRoutes();

        httpConfig.Services.Replace(typeof(IExceptionHandler), new ContentNegotiatedExceptionHandler());

        httpConfig.Services.Add(typeof(IExceptionLogger), new NLogExceptionLogger());

        OAuthAuthorizationServerOptions OAuthServerOptions = new OAuthAuthorizationServerOptions()
        {
            AllowInsecureHttp = true,
            TokenEndpointPath = new PathString("/token"),
            AccessTokenExpireTimeSpan = TimeSpan.FromDays(1),
            Provider = new AuthorizationServerProvider()
        };

        app.Use<GlobalExceptionMiddleware>();

        app.UseOAuthAuthorizationServer(OAuthServerOptions);
        app.UseOAuthBearerAuthentication(new OAuthBearerAuthenticationOptions());

        app.UseWebApi(httpConfig);
    }
}

public class GlobalExceptionMiddleware : OwinMiddleware
{
    public GlobalExceptionMiddleware(OwinMiddleware next)
        : base(next)
    { }

    public override async Task Invoke(IOwinContext context)
    {
        try
        {
            await Next.Invoke(context);
        }
        catch (Exception ex)
        {
            NLogLogger.LogError(ex, context);
        }
    }
}
4

3 回答 3

42

好的，所以这比预期的要容易，感谢@Khalid 的提醒，我最终创建了一个名为的 owin 中间件OwinExceptionHandlerMiddleware，该中间件专用于处理任何 Owin 中间件中发生的任何异常（记录它并在返回之前操纵响应）客户端）。

您需要将此中间件注册为类中的第一个，Startup如下所示：

public class Startup
{
    public void Configuration(IAppBuilder app)
    {
        var httpConfig = new HttpConfiguration();

        httpConfig.MapHttpAttributeRoutes();

        httpConfig.Services.Replace(typeof(IExceptionHandler), new ContentNegotiatedExceptionHandler());

        httpConfig.Services.Add(typeof(IExceptionLogger), new NLogExceptionLogger());

        OAuthAuthorizationServerOptions OAuthServerOptions = new OAuthAuthorizationServerOptions()
        {
            AllowInsecureHttp = true,
            TokenEndpointPath = new PathString("/token"),
            AccessTokenExpireTimeSpan = TimeSpan.FromDays(1),
            Provider = new AuthorizationServerProvider()
        };

        //Should be the first handler to handle any exception happening in OWIN middlewares
        app.UseOwinExceptionHandler();

        // Token Generation
        app.UseOAuthAuthorizationServer(OAuthServerOptions);

        app.UseOAuthBearerAuthentication(new OAuthBearerAuthenticationOptions());

        app.UseWebApi(httpConfig);
    }
}

中使用的代码OwinExceptionHandlerMiddleware如下：

using AppFunc = Func<IDictionary<string, object>, Task>;

public class OwinExceptionHandlerMiddleware
{
    private readonly AppFunc _next;

    public OwinExceptionHandlerMiddleware(AppFunc next)
    {
        if (next == null)
        {
            throw new ArgumentNullException("next");
        }

        _next = next;
    }

    public async Task Invoke(IDictionary<string, object> environment)
    {
        try
        {
            await _next(environment);
        }
        catch (Exception ex)
        {
            try
            {

                var owinContext = new OwinContext(environment);

                NLogLogger.LogError(ex, owinContext);

                HandleException(ex, owinContext);

                return;
            }
            catch (Exception)
            {
                // If there's a Exception while generating the error page, re-throw the original exception.
            }
            throw;
        }
    }
    private void HandleException(Exception ex, IOwinContext context)
    {
        var request = context.Request;

        //Build a model to represet the error for the client
        var errorDataModel = NLogLogger.BuildErrorDataModel(ex);

        context.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
        context.Response.ReasonPhrase = "Internal Server Error";
        context.Response.ContentType = "application/json";
        context.Response.Write(JsonConvert.SerializeObject(errorDataModel));

    }

}

public static class OwinExceptionHandlerMiddlewareAppBuilderExtensions
{
    public static void UseOwinExceptionHandler(this IAppBuilder app)
    {
        app.Use<OwinExceptionHandlerMiddleware>();
    }
}
于 2015-12-28T11:53:46.383 回答
8

有几种方法可以做你想做的事：

  1. 创建首先注册的中间件，然后所有异常都会冒泡到该中间件。此时只需通过 OWIN 上下文通过 Response 对象写出您的 JSON。

  2. 您还可以创建包装 Oauth 中间件的包装中间件。在这种情况下，它将捕获源自此特定代码路径的错误。

最终编写您的 JSON 消息是关于创建它、序列化它并通过 OWIN 上下文将其写入响应。

看来您与#1 走在正确的道路上。希望这会有所帮助，祝你好运:)

于 2015-12-27T15:42:24.767 回答
2

接受的答案是不必要的复杂，不继承自OwinMiddleware类

您需要做的就是：

 public class HttpLogger : OwinMiddleware
    {
        
        public HttpLogger(OwinMiddleware next) : base(next) { }

        public override async Task Invoke(IOwinContext context)
        {
            
            await Next.Invoke(context);
            Log(context)
            
        }
    }

此外，无需创建扩展方法。它很简单，无需引用

 appBuilder.Use(typeof(HttpErrorLogger));

如果你只想记录特定的请求，你可以过滤上下文属性：

前任：

if (context.Response.StatusCode != 200) { Log(context) }
于 2021-07-14T16:15:20.513 回答