专栏首页DOTNETasp.net web api 异常捕获

asp.net web api 异常捕获

1 向客户端发送错误消息

使用throw new HttpResponseException()向客户端抛出错误信息。

HttpResponseException包含两个重载的构造函数,其中一个是构造函数参数类型为HttpResponseMessage,通过其设置状态码,错误消息短语以及消息体内容来向客户端抛出比较详细的错误信息。另一个参数类型为HttpStatusCode,只能设定状态码。

2自定义异常过滤器

扩展IExceptionFilter来定义异常过滤器。异常过滤器不会捕获类型为HttpResponseException的异常,下面的异常也无法被异常过滤器捕获:

1)controller构造器抛出的异常

2)消息处理器抛出的异常

3)路由过程中抛出的异常

4)响应内容序列化与反序列化过程中抛出的异常

代码示例:

public class CustomExceptionFilterAttribute : ExceptionFilterAttribute 
    {
        public override void OnException(HttpActionExecutedContext context)
        {
            if (context.Exception!=null)
            {
                LogHelper.LogError(context.Exception);
            }
        }
    }

3 扩展ExceptionHandler和ExceptionLogger

扩展ExceptionHandler可以捕获大部分异常,包括一些无法被异常过滤器捕获的异常。但是HttpResponseException类型的异常不会被捕获。

示例代码:

/// <summary>
    /// 自定义的异常处理程序
    /// </summary>
    public class GlobalExceptionHandler : ExceptionHandler
    {
        /// <summary>
        /// 处理异常
        /// </summary>
        /// <param name="context"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        public override Task HandleAsync(ExceptionHandlerContext context,CancellationToken cancellationToken)
        {
            if (!ShouldHandle(context))
            {
                return Task.FromResult(0);
            }
            context.Result = new ErrorResult
            {
                Request = context.ExceptionContext.Request,
                Content = "呀! 有异常,请联系管理员"
            };
            return Task.FromResult(0);
        }
        /// <summary>
        /// 判断是否应该处理
        /// 后期扩展,重写方法可过滤掉不需处理的异常
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public override bool ShouldHandle(ExceptionHandlerContext context)
        {
            return true;
        }
        private class ErrorResult : IHttpActionResult
        {
            public HttpRequestMessage Request { get; set; }
            public string Content { get; set; }
            public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
            {
                HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.InternalServerError);
                response.Content = new StringContent(Content);
                response.RequestMessage = Request;
                return Task.FromResult(response);
            }
        }
    }
public class GlobalExceptionLogger : ExceptionLogger
    {
        public override Task LogAsync(ExceptionLoggerContext context,CancellationToken cancellationToken)
        {
            if (!ShouldLog(context))
            {
                return Task.FromResult(0);
            }
            if (context.Exception != null)
            {
                string msg = ClientInfoAnalysis.GetClientInfo();
                LogHelper.LogError(context.Exception, msg);
            }
            return Task.FromResult(0);
        }
        /// <summary>
        /// 判断是否应记录异常
        /// 后期重写此方法,可过滤掉不需要记录的异常信息
        /// </summary>
        /// <param name="context"></param>
        /// <returns></returns>
        public override bool ShouldLog(ExceptionLoggerContext context)
        {
            if ((context.Exception is System.Web.HttpException))
            {
                return false;
            }
            return true;
        }
}
public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // 加载log4net配置文件
            LogConfigLoading.Load(AppSettings.Log4netPathForWeb);

            // 加载Web API服务
            config.Services.Replace(typeof(IAssembliesResolver), new ServiceAssembliesResolver(AppSettings.ServicesLocation));

            // 全局异常信息处理
            config.Services.Replace(typeof(IExceptionHandler), new GlobalExceptionHandler());

            // 全局异常记录
            config.Services.Add(typeof(IExceptionLogger), new GlobalExceptionLogger());
}
}

4某些异常无法被捕获的异常

问题描述

对于在服务加载过程中的异常,无法通过异常过滤器,即实现了System.Web.Http.Filters.IExceptionFilter接口的过滤器来捕获,也不能通过注册ExceptionLogger来达到目的。解决方法如下:

public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            try
            {
                config.Services.Replace(typeof(IAssembliesResolver), new ServiceAssembliesResolver(SysSettings.ServicesLocation));
            }
            catch (Exception ex)
            {
                LogHelper.Error(ex);
            }

//其他代码
}
}

其中ServiceAssembliesResolver为:

public class ServiceAssembliesResolver : DefaultAssembliesResolver
    {
        //服务插件路径
        private string path;
        public ServiceAssembliesResolver(string path):base()
        {
            this.path = path;
        }
        public override ICollection<Assembly> GetAssemblies()
        {
            //获得已有的服务
            ICollection<Assembly> baseAssemblies = base.GetAssemblies();
            //初始化
            List<Assembly> assemblies = new List<Assembly>(baseAssemblies);
            //加载每一个服务插件
            foreach (string file in Directory.GetFiles(path, "*.dll"))
            {
                var controllersAssembly = Assembly.LoadFrom(file);
                assemblies.Add(controllersAssembly);
            }

            return assemblies;
        }
    }

但上述方法很可能不起作用,根本原因在于将config.Services.Replace(typeof(IAssembliesResolver), new ServiceAssembliesResolver(SysSettings.ServicesLocation));放入try-catch块中,若ServiceAssembliesResolver在实例化的时候不抛出异常,而是当调用GetAssemblies时抛出异常(例如服务插件存储文件夹被删除),此时无法记录异常。那么问题就在于GetAssemblies方法何时被调用,通过跟踪代码发现Register中的所有代码都执行完成才会加载服务。解决办法是在ServiceAssembliesResolver.GetAssemblies中捕获异常并记录下来。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 设计原则

    一、面向对象应用程序开发原则(SOLID) 1单一职责原则(SRP) 定义: 一个类应该只有一个发生变化的原因。这条原则曾被称为内聚性,即一个模块的组成元素之间...

    甜橙很酸
  • ASP.NET Web API编程——控制器

    1控制器操作的参数 控制器操作的参数可以是内置类型也可以是自定义类型,无参也是允许的。 2控制器操作返回值 类型 说明 void ...

    甜橙很酸
  • ASP.NET MVC编程——错误处理与日记

    ASP.NET MVC的错误处理应考虑到这几个方面:模型绑定期间发生的错误,未能路由到指定操作,针对控制器的错误处理。使用配置文件可以帮助我们处理异常,但是不够...

    甜橙很酸
  • SpringMVC源码解析(一)

    为了简单起见,再一个就是现在这个年代也没有啥项目使用JSP了。所以本次分析使用SpringBoot结合thymeleaf来搞

    Java学习录
  • 手动实现call apply bind

    bind:当绑定函数被调用时,bind传入的参数会被插入到目标函数的参数列表的开始位置,传递给绑定函数的参数会跟在它们后面。

    ConardLi
  • 第二十节 netty源码分析之 reactor中的EventLoop01

    (如果使用到的是 NIO, 那么通常是 NioEventLoopGroup), 那么这个 NioEventLoopGroup 在 Netty 中到底扮演着什么角...

    用户1418372
  • Spring事务源码解析(一)@EnableTransactionManagement注解

    本篇文章的Demo基于上一篇文章SpringJDBC源码解析 新添加内容如下 首先在配置类中添加开启事务的注解@EnableTransactionManagem...

    Java学习录
  • micrometer自定义metrics

    spring-boot-actuator-autoconfigure-2.0.0.RELEASE-sources.jar!/org/springframewor...

    codecraft
  • Android获取网络状态

    前言:在开发安卓移动端时,几乎每一个app都需要连接网络,因此,对设备的网络状态检测是很有必要的!比如:检测当前网络是否可用,当前可用的网络是属于WIFI还是M...

    AlicFeng
  • 深入理解 依赖注入

    相信所有面试java开发的童鞋一定都被问到过是否使用过Spring,是否了解其IOC容器,为什么不直接使用工厂模式,以及究竟IOC和DI区别在于哪里这种问题。今...

    眯眯眼的猫头鹰

扫码关注云+社区

领取腾讯云代金券