Java自学者论坛

 找回密码
 立即注册

手机号码,快捷登录

恭喜Java自学者论坛(https://www.javazxz.com)已经为数万Java学习者服务超过8年了!积累会员资料超过10000G+
成为本站VIP会员,下载本站10000G+会员资源,会员资料板块,购买链接:点击进入购买VIP会员

JAVA高级面试进阶训练营视频教程

Java架构师系统进阶VIP课程

分布式高可用全栈开发微服务教程Go语言视频零基础入门到精通Java架构师3期(课件+源码)
Java开发全终端实战租房项目视频教程SpringBoot2.X入门到高级使用教程大数据培训第六期全套视频教程深度学习(CNN RNN GAN)算法原理Java亿级流量电商系统视频教程
互联网架构师视频教程年薪50万Spark2.0从入门到精通年薪50万!人工智能学习路线教程年薪50万大数据入门到精通学习路线年薪50万机器学习入门到精通教程
仿小米商城类app和小程序视频教程深度学习数据分析基础到实战最新黑马javaEE2.1就业课程从 0到JVM实战高手教程MySQL入门到精通教程
查看: 582|回复: 0

Asp.net Core 异常日志与API返回值处理

[复制链接]
  • TA的每日心情
    奋斗
    2024-11-24 15:47
  • 签到天数: 804 天

    [LV.10]以坛为家III

    2053

    主题

    2111

    帖子

    72万

    积分

    管理员

    Rank: 9Rank: 9Rank: 9

    积分
    726782
    发表于 2021-5-13 09:22:49 | 显示全部楼层 |阅读模式

    需求:

    1、对异常进行捕获记录日志 并且修改返回值给前端

     

    解释:

    ILogger4是自定义的一个日志,更改它就好

     

    解决方案1:

    使用中间件进行异常捕获并且修改其返回值

     public class ErrorMiddleware
        {
            private readonly RequestDelegate _next;
            ILogger4<ErrorMiddleware> logger4;
            public ErrorMiddleware(RequestDelegate next,ILogger4<ErrorMiddleware> logger4)
            {
                _next = next;
                this.logger4 = logger4;
            }
    
            public async Task Invoke(HttpContext httpContext)
            {
                try
                {
                    await _next(httpContext);
                }
                catch (Exception e)
                {
                    logger4.LogError(e,e.Message+"\r\n"+e.StackTrace);
                    throw e;
                }
            
              
            }
        }

    这一步简单,从源码里 ExceptionHandlerMiddleware.cs类里 Copy的代码

    使用中间件进行修改返回值

     public class ResultMiddleware
        {
            private readonly RequestDelegate _next;
    
            public ResultMiddleware(RequestDelegate next)
            {
                _next = next;
            }
    
            public async Task Invoke(HttpContext httpContext)
            {
    
                await _next(httpContext);
    string bodyString = "<p>不好意思 系统正在升级维护 请稍后再试</p>";
    var by = Encoding.UTF8.GetBytes(bodyString);
    var heard =(Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http.HttpResponseHeaders)httpContext.Response.Headers; heard.HeaderContentLength = by.Length.ToString();
    //必须要手动设置请求头的ContentLength大小 才能修改返回值的数据 await httpContext.Response.Body.WriteAsync(by);
            }
        }

    这是从网上copy 修改的代码,不推荐使用 开销太大 转为过滤器

     

    解决方案2:

    使用中间件进行异常捕获并且修改其返回值

    异常过滤器

     /// <summary>
        /// 异常过滤器
        /// </summary>
        public class ErrorFilter :Attribute,IExceptionFilter
        {
    
            ILogger4<ErrorFilter> logger4;
            /// <summary>
            /// 标签
            /// </summary>
            public ErrorFilter() {
            }
    
            /// <summary>
            /// 全局配置
            /// </summary>
            /// <param name="logger4"></param>
            public ErrorFilter(ILogger4<ErrorFilter> logger4) {
                this.logger4 = logger4;
            }
    
            public void OnException(ExceptionContext context)
            {
                var e = context.Exception;
                logger4.LogError(e, e.Message + "\r\n" + e.StackTrace);
                context.Result = new JsonResult(new BaseResult(e.Message));
            }
        }

     

    方法过滤器

      /// <summary>
        /// 对打上该标记的 返回结果为JsonResult的请求进行Result包装
        /// </summary>
        public class ApiResultFilter : Attribute, IActionFilter
        {
            /// <summary>
            /// 执行方法体之后
            /// </summary>
            /// <param name="context"></param>
            public void OnActionExecuted(ActionExecutedContext context)
            {
                
                var result = context.Result;
                if (result!=null &&result is JsonResult resulta)
                {
                    context.Result = new JsonResult(new BaseResult(resulta.Value));
                }
               
            }
    
            /// <summary>
            /// 执行方法体之前
            /// </summary>
            /// <param name="context"></param>
            public void OnActionExecuting(ActionExecutingContext context)
            {
                //不做修改
            }
        }

     

    可以使用标签的方法

     /// <summary>
            /// 测试 返回过滤器
            /// </summary>
            /// <returns></returns>
            [ErrorFilter]
            [ApiResultFilter]
            [HttpGet]
            public IActionResult TestReuslt()
            {
                throw new Exception("AA");
                var obj = new
                {
                    A = "321"
                };
                return Json(obj);
            }

     

     

    也可以使用全局配置的方法

    //注册过滤器
                services.AddSingleton<ApiResultFilter>();
                services.AddSingleton<ErrorFilter>();
                
                services.AddMvc(
                    config => {
                        config.Filters.AddService(typeof(ApiResultFilter));
                        config.Filters.AddService(typeof(ErrorFilter));
                    })
                .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

     

    注意:

    打上的标签无法获取IOC容器

    不要使用全局配置与标签一起使用 会造成多次调用

     

    在这里推荐使用过滤器而不是中间件,

     

    贴上一张大佬的过滤器调用图

     

     

    结果:

     

    哎...今天够累的,签到来了1...
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    QQ|手机版|小黑屋|Java自学者论坛 ( 声明:本站文章及资料整理自互联网,用于Java自学者交流学习使用,对资料版权不负任何法律责任,若有侵权请及时联系客服屏蔽删除 )

    GMT+8, 2024-12-23 02:22 , Processed in 0.177191 second(s), 29 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表