zoukankan      html  css  js  c++  java
  • .Net Core3.0 WebApi 项目框架搭建 十一:基于Log4j的全局异常处理

    .Net Core3.0 WebApi 项目框架搭建:目录

    安装Log4j

    webapi.core项目Nuget安装Log4j

     添加Log4net.json配置文件

    <?xml version="1.0" encoding="utf-8"?>
    <configuration>
        <configSections>
            <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
        </configSections>
    
        <system.web>
            <compilation debug="true" targetFramework="4.5.2" />
            <httpRuntime targetFramework="4.5.2" />
        </system.web>
        <log4net>
            <!--错误日志:::记录错误日志-->
            <!--按日期分割日志文件 一天一个-->
            <!-- appender 定义日志输出方式   将日志以回滚文件的形式写到文件中。-->
            <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender">
                <!--保存路径:下面路径项目启动的时候自动在C盘中创建log、logError文件-->
                <file value="log/error/error_" />
                <!-- 如果想在本项目中添加路径,那就直接去掉C:\  只设置log\LogError   项目启动中默认创建文件 -->
                <appendToFile value="true"/>
                <!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
                <rollingStyle value="Date"/>
                <!--这是按日期产生文件夹-->
                <datePattern value="yyyy-MM-dd'.log'"/>
                <!--是否只写到一个文件中-->
                <staticLogFileName value="false"/>
                <!--保留的log文件数量 超过此数量后 自动删除之前的   好像只有在 按Size分割时有效 设定值value="-1"为不限文件数-->
                <param name="MaxSizeRollBackups" value="100"/>
                <!--每个文件的大小。只在混合方式与文件大小方式下使用。超出大小后在所有文件名后自动增加正整数重新命名,数字最大的最早写入。可用的单位:KB|MB|GB。不要使用小数,否则会一直写入当前日志-->
                <maximumFileSize value="50MB" />
                <!-- layout 控制Appender的输出格式,也可以是xml  一个Appender只能是一个layout-->
                <layout type="log4net.Layout.PatternLayout">
                    <!--每条日志末尾的文字说明-->
                    <!--输出格式 模板-->
                    <!-- <param name="ConversionPattern"  value="记录时间:%date 线程ID:[%thread] 日志级别:%-5level 记录类:%logger   
            操作者ID:%property{Operator} 操作类型:%property{Action}%n  当前机器名:%property%n当前机器名及登录用户:%username %n  
            记录位置:%location%n 消息描述:%property{Message}%n   异常:%exception%n 消息:%message%newline%n%n" />-->
    
                    <!--样例:2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
                    <!--<conversionPattern value="%newline %n记录时间:%date %n线程ID:[%thread] %n日志级别: %-5level %n错误描述:%message%newline %n"/>-->
                    <conversionPattern value="%n==========
                                      %n【日志级别】%-5level
                                      %n【记录时间】%date
                                      %n【执行时间】[%r]毫秒
                                      %n【错误位置】%logger 属性[%property{NDC}]
                                      %n【错误描述】%message
                                      %n【错误详情】%newline"/>
                </layout>
                <filter type="log4net.Filter.LevelRangeFilter,log4net">
                    <levelMin value="ERROR" />
                    <levelMax value="FATAL" />
                </filter>
            </appender>
    
            <!--DEBUG:::记录DEBUG日志-->
            <!--按日期分割日志文件 一天一个-->
            <!-- appender 定义日志输出方式   将日志以回滚文件的形式写到文件中。-->
            <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
                <!--保存路径:下面路径项目启动的时候自动在C盘中创建log、logError文件-->
                <file value="log/debug/debug_" />
                <!-- 如果想在本项目中添加路径,那就直接去掉C:\  只设置log\LogError   项目启动中默认创建文件 -->
                <appendToFile value="true"/>
                <!--按照何种方式产生多个日志文件(日期[Date],文件大小[Size],混合[Composite])-->
                <rollingStyle value="Date"/>
                <!--这是按日期产生文件夹-->
                <datePattern value="yyyy-MM-dd'.log'"/>
                <!--是否只写到一个文件中-->
                <staticLogFileName value="false"/>
                <!--保留的log文件数量 超过此数量后 自动删除之前的   好像只有在 按Size分割时有效 设定值value="-1"为不限文件数-->
                <param name="MaxSizeRollBackups" value="100"/>
                <!--每个文件的大小。只在混合方式与文件大小方式下使用。超出大小后在所有文件名后自动增加正整数重新命名,数字最大的最早写入。可用的单位:KB|MB|GB。不要使用小数,否则会一直写入当前日志-->
                <maximumFileSize value="50MB" />
                <!-- layout 控制Appender的输出格式,也可以是xml  一个Appender只能是一个layout-->
                <layout type="log4net.Layout.PatternLayout">
                    <!--每条日志末尾的文字说明-->
                    <!--输出格式 模板-->
                    <!-- <param name="ConversionPattern"  value="记录时间:%date 线程ID:[%thread] 日志级别:%-5level 记录类:%logger   
            操作者ID:%property{Operator} 操作类型:%property{Action}%n  当前机器名:%property%n当前机器名及登录用户:%username %n  
            记录位置:%location%n 消息描述:%property{Message}%n   异常:%exception%n 消息:%message%newline%n%n" />-->
    
                    <!--样例:2008-03-26 13:42:32,111 [10] INFO  Log4NetDemo.MainClass [(null)] - info-->
                    <!--<conversionPattern value="%newline %n记录时间:%date %n线程ID:[%thread] %n日志级别: %-5level %n错误描述:%message%newline %n"/>-->
                    <conversionPattern value="%n==========
                                      %n【日志级别】%-2level
                                      %n【记录时间】%date
                                      %n【执行时间】[%r]毫秒
                                      %n【debug位置】%logger 属性[%property{NDC}]
                                      %n【debug描述】%message"/>
                </layout>
                <filter type="log4net.Filter.LevelRangeFilter,log4net">
                    <levelMin value="DEBUG" />
                    <levelMax value="WARN" />
                </filter>
            </appender>
            <!--Set root logger level to DEBUG and its only appender to A1-->
            <root>
                <!--控制级别,由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF-->
                <level value="ALL" />
                <appender-ref ref="DebugAppender" />
                <appender-ref ref="ErrorAppender" />
            </root>
        </log4net>
    </configuration>

    添加日志接口类

    weapi.core项目新建Log 文件夹,新建 ILoggerHelper.cs 

     public interface ILoggerHelper
        {
    
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Debug(object source, string message);
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="ps">ps</param>
            void Debug(object source, string message, params object[] ps);
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Debug(Type source, string message);
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Info(object source, object message);
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Info(Type source, object message);
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Warn(object source, object message);
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Warn(Type source, object message);
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Error(object source, object message);
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Error(Type source, object message);
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Fatal(object source, object message);
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            void Fatal(Type source, object message);
    
            /* Log a message object and exception */
    
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Debug(object source, object message, Exception exception);
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Debug(Type source, object message, Exception exception);
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Info(object source, object message, Exception exception);
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Info(Type source, object message, Exception exception);
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Warn(object source, object message, Exception exception);
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Warn(Type source, object message, Exception exception);
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Error(object source, object message, Exception exception);
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Error(Type source, object message, Exception exception);
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Fatal(object source, object message, Exception exception);
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            void Fatal(Type source, object message, Exception exception);
        }

    在 Log 文件夹下新建 LogHelper.cs

     public class LogHelper : ILoggerHelper
        {
            private readonly ConcurrentDictionary<Type, ILog> Loggers = new ConcurrentDictionary<Type, ILog>();
    
            /// <summary>
            /// 获取记录器
            /// </summary>
            /// <param name="source">soruce</param>
            /// <returns></returns>
            private ILog GetLogger(Type source)
            {
                if (Loggers.ContainsKey(source))
                {
                    return Loggers[source];
                }
                else
                {
                    ILog logger = LogManager.GetLogger(Startup.repository.Name, source);
                    Loggers.TryAdd(source, logger);
                    return logger;
                }
            }
    
            /* Log a message object */
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Debug(object source, string message)
            {
                Debug(source.GetType(), message);
            }
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="ps">ps</param>
            public void Debug(object source, string message, params object[] ps)
            {
                Debug(source.GetType(), string.Format(message, ps));
            }
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Debug(Type source, string message)
            {
                ILog logger = GetLogger(source);
                if (logger.IsDebugEnabled)
                {
                    logger.Debug(message);
                }
            }
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Info(object source, object message)
            {
                Info(source.GetType(), message);
            }
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Info(Type source, object message)
            {
                ILog logger = GetLogger(source);
                if (logger.IsInfoEnabled)
                {
                    logger.Info(message);
                }
            }
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Warn(object source, object message)
            {
                Warn(source.GetType(), message);
            }
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Warn(Type source, object message)
            {
                ILog logger = GetLogger(source);
                if (logger.IsWarnEnabled)
                {
                    logger.Warn(message);
                }
            }
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Error(object source, object message)
            {
                Error(source.GetType(), message);
            }
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Error(Type source, object message)
            {
                ILog logger = GetLogger(source);
                if (logger.IsErrorEnabled)
                {
                    logger.Error(message);
                }
            }
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Fatal(object source, object message)
            {
                Fatal(source.GetType(), message);
            }
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            public void Fatal(Type source, object message)
            {
                ILog logger = GetLogger(source);
                if (logger.IsFatalEnabled)
                {
                    logger.Fatal(message);
                }
            }
            /* Log a message object and exception */
    
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Debug(object source, object message, Exception exception)
            {
                Debug(source.GetType(), message, exception);
            }
            /// <summary>
            /// 调试信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Debug(Type source, object message, Exception exception)
            {
                GetLogger(source).Debug(message, exception);
            }
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Info(object source, object message, Exception exception)
            {
                Info(source.GetType(), message, exception);
            }
            /// <summary>
            /// 关键信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Info(Type source, object message, Exception exception)
            {
                GetLogger(source).Info(message, exception);
            }
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Warn(object source, object message, Exception exception)
            {
                Warn(source.GetType(), message, exception);
            }
            /// <summary>
            /// 警告信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Warn(Type source, object message, Exception exception)
            {
                GetLogger(source).Warn(message, exception);
            }
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Error(object source, object message, Exception exception)
            {
                Error(source.GetType(), message, exception);
            }
            /// <summary>
            /// 错误信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Error(Type source, object message, Exception exception)
            {
                GetLogger(source).Error(message, exception);
            }
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Fatal(object source, object message, Exception exception)
            {
                Fatal(source.GetType(), message, exception);
            }
            /// <summary>
            /// 失败信息
            /// </summary>
            /// <param name="source">source</param>
            /// <param name="message">message</param>
            /// <param name="exception">ex</param>
            public void Fatal(Type source, object message, Exception exception)
            {
                GetLogger(source).Fatal(message, exception);
            }
        }

    配置LogManger 自启动

    在startup.cs文件中添加 Loger 日志仓库

            /// <summary>
            /// log4net 仓储库
            /// </summary>
            public static ILoggerRepository repository { get; set; }

    ConfigureServices方法中注入ILoggerHelper和日志启动

                //log注入ILoggerHelper
                services.AddSingleton<ILoggerHelper, LogHelper>();        
    
    
               //log4net
                repository = LogManager.CreateRepository("");//需要获取日志的仓库名,也就是你的当然项目名
                XmlConfigurator.Configure(repository, new FileInfo("Log4net.config"));//指定配置文件,

    测试日志

    Test控制写一个测试接口

            private readonly ILoggerHelper _logger;
    
    
            public TestController(ILoggerHelper loggerHelper)
            {
                _logger = loggerHelper;
            }
    
            /// <summary>
            /// 测试日志
            /// </summary>
            /// <returns></returns>
            [HttpGet]
            public IActionResult LogTest()
            {
                _logger.Error(typeof(TestController), "这是错误日志", new Exception("123"));
                _logger.Debug(typeof(TestController), "这是bug日志");
                //throw new System.IO.IOException();
                return Ok();
            }

    F5运行调试

     查看日志文件,有输出

     

    定义全局异常过滤器

    webapi.core项目 新建Filter 文件夹,添加 GlobalExceptionFilter.cs

    public class GlobalExceptionsFilter : IExceptionFilter
        {
            private readonly IHostEnvironment _env;
            private readonly ILoggerHelper _loggerHelper;
    
            public GlobalExceptionsFilter(IHostEnvironment env, ILoggerHelper loggerHelper)
            {
                _env = env;
                _loggerHelper = loggerHelper;
            }
    
            public void OnException(ExceptionContext context)
            {
                var json = new JsonErrorResponse();
                json.Message = context.Exception.Message;//错误信息
                if (_env.IsDevelopment())
                {
                    json.DevelopmentMessage = context.Exception.StackTrace;//堆栈信息
                }
                context.Result = new InternalServerErrorObjectResult(json);
    
                //采用log4net 进行错误日志记录
                _loggerHelper.Error(json.Message,"出现未知异常", context.Exception);
    
            }
    
            public class InternalServerErrorObjectResult : ObjectResult
            {
                public InternalServerErrorObjectResult(object value) : base(value)
                {
                    StatusCode = StatusCodes.Status500InternalServerError;
                }
            }
            //返回错误信息
            public class JsonErrorResponse
            {
                /// <summary>
                /// 生产环境的消息
                /// </summary>
                public string Message { get; set; }
                /// <summary>
                /// 开发环境的消息
                /// </summary>
                public string DevelopmentMessage { get; set; }
            }
    
        }

    在启动服务中,注入全局异常

                services.AddControllers(option =>
                {
                    option.Filters.Add(typeof(GlobalExceptionsFilter));
                });

    测试全局异常

    Test控制器新建接口,这里直接抛出一个异常。

            /// <summary>
            /// 抛出异常
            /// </summary>
            /// <returns></returns>
            [HttpGet]
            public IActionResult Throw()
            {
                throw new System.IO.IOException();
            }

    F5运行,测试接口

     查看日志文件,有日志输出。

  • 相关阅读:
    SQL大语句——实现分页,select top后面跟变量出错
    jQuery异步请求(如getJSON)跨域解决方案
    Debug常用命令
    清华操作系统实验--80x86汇编基础
    在Windows10中运行debug程序
    恢复Windows10应用商店
    最少硬币问题
    嵌套矩形问题
    清华大学操作系统实验准备--挖坑
    动态规划入门-数字三角形
  • 原文地址:https://www.cnblogs.com/huguodong/p/12923724.html
Copyright © 2011-2022 走看看