一、为什么使用log4net
日志的重要性就阐述了，为什么使用log4net，这里说一下，因为使用人群广泛，性能又相差无几，那当然是用的人越多越好了，流量才是王道。
下面开始一步一步的通过代码和图片的形式来使用log4net
第一步要创建一个配置文件，起名字叫Log4net.config
代码如下
<?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"> <!--保存路径：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"> <!--保存路径：下面路径项目启动的时候自动创建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>
引用Nuget包 log4net 然后创建日志处理类，在Api层中增加一个文件夹Log 创建两个类 ILoggerHelper和 LoggerHelper
代码如下
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace WebApi.Core.Api.Log { 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); } }
这里面会有一个报错，往下继续看，没关系下面会添加的
using log4net; using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace WebApi.Core.Api.Log { public class LoggerHelper: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); } } }
在startup.cs 文件中添加Loger日志仓库变量
/// <summary> /// log4net 仓储库 /// </summary> public static ILoggerRepository repository { get; set; }
ConfigureServices 方法中注入ILoggerHelper和日志启动
//log注入ILoggerHelper services.AddSingleton<ILoggerHelper, LoggerHelper>(); //log4net repository = LogManager.CreateRepository("WebApi.Core.Api");//项目名称 XmlConfigurator.Configure(repository, new FileInfo("log4net.config"));//指定配置文件，
还是很简单的，接下来我们测试一下
using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; using Newtonsoft.Json.Linq; using WebApi.Core.Api.Log; using WebApi.Core.IService; using WebApi.Core.Service; namespace WebApi.Core.Api.Controllers { /// <summary> /// 测试仓储模式控件 /// </summary> public class TestRepositoryController : BaseController { //声明一个常量 private readonly ITestService testService; //声明一个日志常量 private readonly ILoggerHelper _logger; //构造函数注入 service public TestRepositoryController(ITestService testS,ILoggerHelper loggerHelper) { testService = testS; _logger = loggerHelper; } /// <summary> /// 测试仓储模式，求和表示层 /// </summary> /// <param name="i"></param> /// <param name="j"></param> /// <returns></returns> [HttpPost] public int SumService(int i, int j) { return testService.SumService(i,j); } /// <summary> /// 测试日志 /// </summary> /// <returns></returns> [HttpGet] public IActionResult LogTest() { _logger.Error(typeof(TestRepositoryController),"这是错误日志",new Exception("123")); _logger.Debug(typeof(TestRepositoryController),"这个是bug日志"); return Ok(); } } }
F5调试一下，请求成功日志也准确的记录了。
我们在新建一个全局异常过滤器，来看看日志的记录，在api层新建一个文件夹 Filter创建GlobalExceptionFilter.cs
代码如下
using Microsoft.AspNetCore.Http; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Mvc.Filters; using Microsoft.Extensions.Hosting; using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using WebApi.Core.Api.Log; namespace WebApi.Core.Api.Filter { public class GlobalExceptionFilter: IExceptionFilter { private readonly IHostEnvironment _env; private readonly ILoggerHelper _loggerHelper; public GlobalExceptionFilter(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; } } } }
我们在ConfigureServices 方法中 注入全局异常过滤器
我们来测试一下，在之前的Action中加抛出异常
F5调试一下，异常是抛出了，我们看一下日志文件里面 有没有记录到
可以看到日志已经被记录了，这样系统抛出的所有异常就可以都被记录下来
简单讲一下log4net 的结构吧，四种主要的组件，Logger（记录器）、Repository（库）、Appender（附着器）、Layout（布局）
Logger： 是应用程序需要交互的主要组件，用来产生日志消息的，继承自 ILog接口，
还有一个LogManager来管理Logger对象，有一个GetLogger（）静态方法来检索Logger对象，如果不存在则会创建一个Logger对象
通常会用（class）的类型（type）为参数来调用，以方便跟踪我们正在进行日志记录的类。可以使用typeif（classname）方法获得
Repository：logger 仓库，主要用于日志对象组织结构的维护，使用框架的话不需要知道，如果是扩展的话可以自行查找一下。
Appender：定义输出的介质，一个Appender对象缺省的将所有的日志事件传递到输出流，Appender Filters 可以按照不同的标准过滤日志事件
Layout：该组件用于向用户展示最后经过格式化的输出信息，输出的信息可以有多种格式，就是依赖采用的Layout组件类型。一般跟Appender一起出现，
一个Appender 只能对应一个Layout对象。
日志级别（Level）：由高到低 OFF > FATAL > ERROR > WARN > INFO > DEBUG > ALL