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

  • 时间:
  • 浏览:1

前言

一一八个多完正的项目工程离不开日志文件的记录,而记录文件的土办法回会一些一些,也能所有人 通过Stream去实现文件的读写来完成日志记录,一些一些可能有个好的封装类库,那为哪些地方不去用呢?

.net日志记录,NLog,log4都也能,用哪些地方都也能,根据所有人 喜好,我常用log4,一些一些这里还是介绍Log4的引用及用法。

log4net

这人 log4从开发到现在,从netframework结束英语 用,一一八个多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; }

配置文件的创建也能在工程目录下新建一一八个多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引入第三方类库在一一八个多项目工程即可,一些工程假如引用对应的项目工程,也也能使用对应的第三方类库,即我在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突然是这),更改代码如下:



运行看下效果。

小结

封装的好处是为了省事,哪也还可否写(点)哪里,咳咳,日志的重要性在代码里面之一些一些,那么日志的工程是不健全的,线程猿也能不需要写逻辑,不去考虑架构,不去优化性能,一些一些日志的记录,代码的注释是不可或缺的,毕竟可能想活着,这人及多地方还是多注意吧。

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