如何覆盖 Owin 中默认的未处理异常输出？

Question

我已经使用 Owin 自托管和 WebApi 编写了简单的服务器：

namespace OwinSelfHostingTest
{
    using System.Threading;
    using System.Web.Http;
    using Microsoft.Owin.Hosting;
    using Owin;

    public class Startup
    {
        public void Configuration(IAppBuilder builder)
        {
            var config = new HttpConfiguration();

            config.Routes.MapHttpRoute(
                "Default",
                "{controller}/{id}",
                new { id = RouteParameter.Optional }
                );

            builder.UseWebApi(config);
        }
    }

    public class Server
    {
        private ManualResetEvent resetEvent = new ManualResetEvent(false);
        private Thread thread;

        private const string ADDRESS = "http://localhost:9000/";

        public void Start()
        {
            this.thread = new Thread(() =>
                {
                    using (var host = WebApp.Start<Startup>(ADDRESS))
                    {
                        resetEvent.WaitOne(Timeout.Infinite, true);
                    }
                });
            thread.Start();
        }

        public void Stop()
        {
            resetEvent.Set();
        }
    }

}

当控制器出现异常时，Owin returns XML 响应如下：

<Error>
    <Message>An error has occurred.</Message>
    <ExceptionMessage>Attempted to divide by zero.</ExceptionMessage>
    <ExceptionType>System.DivideByZeroException</ExceptionType>
    <StackTrace> 
        ...
    </StackTrace>
</Error>

但我想要不同的输出 - 那么我该如何覆盖它？

Answer 1

您可以通过创建一个 OWIN 中间件并将其连接到管道中来实现：

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

   public override async Task Invoke(IOwinContext context)
   {
      try
      {
          await Next.Invoke(context);
      }
      catch(Exception ex)
      {
          // Custom stuff here
      }
   }
 }

并在启动时挂钩它：

public class Startup
{
    public void Configuration(IAppBuilder builder)
    {
        var config = new HttpConfiguration();

        config.Routes.MapHttpRoute(
            "Default",
            "{controller}/{id}",
            new { id = RouteParameter.Optional }
            );

        builder.Use<CustomExceptionMiddleware>().UseWebApi(config);
    }
}

这样任何未处理的异常都会被您的中间件捕获并允许您自定义输出结果。

需要注意的重要事项：如果被托管的事物有自己的异常处理逻辑，就像 WebAPI 那样，异常将不会传播。此处理程序适用于 未被托管的基础服务处理的任何异常 。

Answer 2

当您等待异步方法时，不会将异常抛出到调用者的上下文中，但可以通过检查返回给调用者的任务来获得。

因此，通过对@yuval-itzchakov 提供的解决方案的这种修改，您将能够捕获潜在的异常：

var subtask = Next.Invoke(context);

await subtask;

if (subtask.Exception != null)
{
    // log subtask.Exception here
}

如何覆盖 Owin 中默认的未处理异常输出？

How to override default unhandled exception output in Owin?

c#

exception

asp.net-web-api

owin