net core Webapi基础工程搭建(四)——日志功能log4net

  • 时间:
  • 浏览:0

前言

有5个 完全的项目工程离不开日志文件的记录,而记录文件的土法律妙招完全前会全都,还才能当事人通过Stream去实现文件的读写来完成日志记录,全都我将会有个好的封装类库,那为有哪些不去用呢?

.net日志记录,NLog,log4都还才能,用有哪些都还才能,根据当事人喜好,我常用log4,全都这里还是介绍Log4的引用及用法。

log4net

这个 log4从开发到现在,从netframework结束了了英语 了了用,有5个 config文件就够了,NLog没用过,全都愿意完全前会大差不差,毕竟名字都没人累似 嘛(手动滑稽)

依然是,NuGet引用第三方类库

工具->NuGet包管理器->管理出理 方案的NuGet应用线程池池包…

在浏览中查找"log4",选取项目工程,点击安装。



安装完成后,依然是来Startup.cs,这次在构造函数直接声明实例化。

        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;

            repository = LogManager.CreateRepository("AprilLog");

            XmlConfigurator.Configure(repository, new FileInfo("Config/log4net.config"));//配置文件路径还才能自定义
            BasicConfigurator.Configure(repository);
        }

        //log4net日志
        public static ILoggerRepository repository { get; set; }

配置文件的创建还才能在工程目录下新建有5个 config文件,配置信息如下,才能标注的信息基本上完全前会文件注释中,不太大阐述:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <!-- This section contains the log4net configuration settings -->
  <log4net debug="false">
    <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" /><!--很关键的一句,让日志文件不被占用-->
      <file value="logs/" /> <!-- 日志生成文件路径 -->
      <appendToFile value="true" /> 
      <rollingStyle value="Composite" />
      <staticLogFileName value="false" />
      <datePattern value="yyyyMMdd'.log'" /> <!-- 日志文件名称格式 -->
      <maxSizeRollBackups value="10" />
      <maximumFileSize value="10MB" /> <!-- 最大文件大小,达到后生成新文件 -->
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" /> <!-- 生成日志格式 -->
      </layout>
    </appender>

    <!-- Setup the root category, add the appenders and set the default level -->
    <root>
      <level value="ALL" />  <!-- 日志等级 -->
      <appender-ref ref="RollingLogFileAppender" /> 
    </root>

  </log4net>
</configuration>

创建完成后,还是要对比下你的配置文件目录与实际目录不是一致。



OK,完全确认完成后,还才能在才能用到Log的地方,加上以下代码:

    private ILog log = LogManager.GetLogger(Startup.repository.Name, "Name");
    …
    log.Info("测试");

累似 大伙儿继续拿Values这个 控制器开刀。

写好之前 大伙儿运行代码,运行后大伙儿还才能看一遍工程目录将会有了logs这个 文件夹,打开日志文件。



原来大伙儿就还才能在日常使用中记录日志,方便调试记录,追踪间题所在。

整合LogUtil

我这个 人比较懒,全都我我全都我才能关心它是在哪运行,我只愿意记录的之前 调用下土法律妙招,全都对日志记录做了封装调整。

首先,新建类库工程,Apirl.Util(这个 工程应该刚结束了了英语 了了都创建的-,-||)。



类库工程新建完成的第一件事,干掉Class.cs(你还才能要这示例有何用)

将log4net通过NuGet引入Util工程,过程不太大说了,引用的介绍将会还非要。

引用完成后,在WebApi工程引入Util。



选中Util这个 类库工程。

题外话,觉得NuGet引入第三方类库在有5个 项目工程即可,一点工程只要引用对应的项目工程,也还才能使用对应的第三方类库,即我在Util引入log4,你还才能没必要在WebApi工程再引入,这里全都我为了讲解说明。

新建LogUtil这个 类,代码如下。

    public class LogUtil
    {
        private static readonly ILog log = LogManager.GetLogger("AprilLog", typeof(LogUtil));

        /// <summary>
        /// 调试日志
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="obj"></param>
        public static void Debug(string msg, object obj = null)
        {
            if (log.IsDebugEnabled && !string.IsNullOrEmpty(msg))
            {
                if (obj == null)
                {
                    log.Debug(msg);
                }
                else
                {
                    log.DebugFormat(msg, obj);
                }
            }
        }
        /// <summary>
        /// 日常日志
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="obj"></param>
        public static void Info(string msg, object obj = null)
        {
            if (log.IsInfoEnabled && !string.IsNullOrEmpty(msg))
            {
                if (obj == null)
                {
                    log.Info(msg);
                }
                else
                {
                    log.InfoFormat(msg, obj);
                }
            }
        }
        /// <summary>
        /// 错误日志
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="obj"></param>
        public static void Error(string msg, object obj = null)
        {
            if (log.IsErrorEnabled && !string.IsNullOrEmpty(msg))
            {
                if (obj == null)
                {
                    log.Error(msg);
                }
                else
                {
                    log.ErrorFormat(msg, obj);
                }
            }
        }
        /// <summary>
        /// 重要日志
        /// </summary>
        /// <param name="msg"></param>
        /// <param name="obj"></param>
        public static void Fatal(string msg, object obj = null)
        {
            if (log.IsFatalEnabled && !string.IsNullOrEmpty(msg))
            {
                if (obj == null)
                {
                    log.Fatal(msg);
                }
                else
                {
                    log.FatalFormat(msg, obj);
                }
            }
        }

    }

下完之前 ,继续ValuesController(Why总爱是这),更改代码如下:



运行看下效果。

小结

封装的好处是为了省事,哪才都可不可不能能写(点)哪里,咳咳,日志的重要性在代码上端难能可贵,没人日志的工程是不健全的,应用线程池池猿还才能前会写逻辑,不去考虑架构,不去优化性能,全都我日志的记录,代码的注释是不可或缺的,毕竟将会想活着,这有5个 地方还是多注意吧。

下一节,结束了了英语 了了缓存机制