C#记录日志,记录本地日志,LogHelpter

目录

适用于.NET Core

适用于.NET Framework

 举例调用,记录日志,日志文件名时日期


日志文件支持写本地日志文件。日志文件自动删除历史较陈旧的,保留最近200个日志文件。

  • 日志文件自动删除历史较陈旧的
  • 默认保留最近200个日志文件,可修改;
  • 支持控制生成的单文件大小,默认文件最大253KB,可修改;
  • 支持自动记录日志的调用方法名、类名;
  • 自动记录日志时间,精确到毫秒;
  • 支持文件自定义前缀名称,以区分特征,比如error_order_2025-11-5_01.log;
  • 支持自定义日志文件存放文件夹;

适用于.NET Core

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;

namespace ConsoleApp1NET5
{
    /// <summary>
    /// 写本地日志。日志文件自动删除历史较陈旧的,保留最近200个日志文件。
    /// 支持文件前缀名,以区分功能或业务或类名标记,或自定义标记;
    /// </summary>
    public class LogHelpter
    {
        /// <summary>
        ///  最多记录200个日志文件,其他较陈旧的历史文件将被删除
        /// </summary>
        const int MAX_FILE_COUNT = 200;

        /// <summary>
        /// 文件保存的目录
        /// </summary>
        static string fileSaveDir = "";

        /// <summary>
        /// 限制文件生成大小,258000字节,大约253kb
        /// </summary>
        const long fileBytes = 258000;


        //日志文件保存根路径   
        const string saveFolder = "log";

        private readonly static object lockObj = new object();

        static LogHelpter()
        {
            //删除超过指定数量的历史文件    
            Task.Factory.StartNew(() =>
            {
                while (true)
                {
                    try
                    {
                        //Console.WriteLine("检查需要删除的文件...");
                        if (string.IsNullOrWhiteSpace(fileSaveDir))
                        {
                            goto DO_SELEEP;
                        }
                        //自动删除文件,
                        string[] filePathArr = System.IO.Directory.GetFileSystemEntries(fileSaveDir, "*.log");

                        if (filePathArr == null || filePathArr.Length == 0)
                        {
                            goto DO_SELEEP;
                        }
                        List<FileInfo> files = new List<FileInfo>();
                        foreach (var item in filePathArr)
                        {
                            //Console.WriteLine("日志文件:" + item);
                            System.IO.FileInfo fileInfo = new System.IO.FileInfo(item);
                            files.Add(fileInfo);
                        }
                        var del_files = files.OrderByDescending(g => g.LastWriteTime).Skip(MAX_FILE_COUNT);
                        if (del_files == null || del_files.Count() == 0)
                        {
                            goto DO_SELEEP;
                        }
                        Parallel.ForEach(del_files, file =>
                        {
                            try
                            {
                                if (file.Exists)
                                {
                                    file.Delete();
                                    //Console.WriteLine("删除日志文件:" + file.FullName);
                                }
                            }
                            catch (Exception)
                            {
                            }
                        });
                    }
                    catch (Exception ex)
                    {
                        Console.WriteLine("LogHelpter执行删除文件功能异常," + ex.Message);
                    }
                DO_SELEEP:
                    //Console.WriteLine("删除文件休眠30秒");
                    System.Threading.Thread.Sleep(30000);
                }
            }, TaskCreationOptions.LongRunning);

        }

        /// <summary>
        /// fileFolderPath为文件保存目录
        /// </summary>
        /// <param name="fileFolderPath">文件保存目录</param>
        /// <param name="fileNameNoExtension"></param>
        /// <param name="fileNamePrefix">文件名前缀</param>
        /// <returns></returns>
        static string GetNewFileName(string fileFolderPath, string fileNameNoExtension, string fileNamePrefix = null)
        {
            string fileName = string.Empty;

            //文件名前缀
            fileNamePrefix = string.IsNullOrWhiteSpace(fileNamePrefix) ? "" : fileNamePrefix;
            int index = 1;
            if (fileNameNoExtension.LastIndexOf('_') == -1)
            {
                // fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_" + index + ".log");
            }
            else
            {
                var arr = fileNameNoExtension.Split('_');
                int.TryParse(arr[arr.Length - 1], out index);
                if (index == 0 || index > 9999)
                {
                    index = 1;
                }
            }
            fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_" + index + ".log");
            while (File.Exists(fileName))
            {
                if (File.ReadAllBytes(fileName).Length < fileBytes)
                {
                    break;
                }
                index++;
                fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_" + index + ".log");
            }
            return fileName;
        }



        /// <summary>  
        /// 日志记录,在程序执行的根目录,写入txt文件,文件固定大小,超过限定大小自动创建新日志文件
        /// </summary>  
        /// <param name="msg">记录内容</param>  
        /// <param name="storeDir">文件保存文件夹</param>  
        /// <param name="fileNamePrefix">文件名前缀_</param>  
        /// <returns></returns>  
        public static void AddLog(string msg, string storeDir = null, string fileNamePrefix = null)
        {
            lock (lockObj)
            {
                try
                {
                    // 获取调用堆栈
                    StackTrace stackTrace = new StackTrace();
                    // 获取调用者方法(ParentMethod)的堆栈帧
                    StackFrame callerFrame = stackTrace.GetFrame(1); // 0 是当前方法,1 是调用者

                    // 获取调用者方法名
                    string callerMethodName = callerFrame.GetMethod().Name;

                    // 获取调用者类名(可能是父类)
                    Type callerType = callerFrame.GetMethod().DeclaringType;
                    string callerClassName = callerType.FullName;//调用者完整类名:命名空间.类名
                    // string parentClassName = callerType.BaseType?.Name; // 如果是继承关系

                    string msgDebug = $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")} 类={callerClassName},方法={callerMethodName}:{msg}";
                    Console.WriteLine(msgDebug);
                    System.Diagnostics.Debug.WriteLine(msgDebug);



                    //文件名前缀
                    fileNamePrefix = string.IsNullOrWhiteSpace(fileNamePrefix) ? "" : fileNamePrefix + "_";

                    string fileFolderPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, saveFolder);
                    if (!string.IsNullOrWhiteSpace(storeDir))
                    {
                        fileFolderPath = Path.Combine(fileFolderPath, storeDir);
                    }
                    if (Directory.Exists(fileFolderPath) == false)
                    {
                        Directory.CreateDirectory(fileFolderPath);
                    }
                    fileSaveDir = fileFolderPath;
                    string fileName = string.Empty;

                    string[] files = Directory.GetFiles(fileFolderPath, "*.log");
                    if (files.Length == 0)
                    {
                        fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_1.log");
                        goto DO_WRITE;
                    }
                    //string[] files2 = files.OrderByDescending(x => x).ToArray();
                    //string[] files2 = files.OrderByDescending(x => int.Parse(x.Substring(x.LastIndexOf("_")).Split("_")[1].Split(".")[0])).ToArray();
                    string[] files2 = files.OrderByDescending(x => Regex.Matches(x, "_\\d*").Last().Value).ToArray();

                    FileInfo fileInfo = new FileInfo(files2[0]);
                    string fileNameNoExtension = Path.GetFileNameWithoutExtension(fileInfo.Name);
                    fileName = GetNewFileName(fileFolderPath, fileNameNoExtension, fileNamePrefix);

                DO_WRITE:
                    FileStream fs = new FileStream(fileName, FileMode.Append, FileAccess.Write, FileShare.Write);
                    string msg299 = $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")}>类={callerClassName},方法={callerMethodName}:{msg}{System.Environment.NewLine}";
                    byte[] logBytes = UTF8Encoding.UTF8.GetBytes(msg299);
                    fs.Write(logBytes, 0, logBytes.Length);
                    fs.Flush();
                    fs.Close();
                    fs.Dispose();
                    //  tishiMsg = "写入日志成功"; 
                }
                catch (Exception ex)
                {
                    Console.WriteLine("LogHelpter日志写入异常:" + ex.ToString());
                }
            }/* lock结束 */
        }

    }
}

适用于.NET Framework

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Text;
using System.Text.RegularExpressions;
using System.Threading.Tasks;

namespace FrmClassLibraryTool
{
    /// <summary>
    /// 写本地日志。日志文件自动删除历史较陈旧的,保留最近200个日志文件。
    /// 支持文件前缀名,以区分功能或业务或类名标记,或自定义标记;
    /// </summary>
    public class LogHelpter
    {
        /// <summary>
        /// 最多记录200个日志文件,其他较陈旧的历史文件将被删除
        /// </summary>
        const int MAX_FILE_COUNT = 200;

        /// <summary>
        /// 文件保存的目录
        /// </summary>
        private static string fileSaveDir = "";

        /// <summary>
        /// 限制文件生成大小,258000字节,大约253kb
        /// </summary>
        const long fileBytes = 258000;

        //日志文件保存根路径   
        const string saveFolder = "log";

        private readonly static object lockObj = new object();

        static LogHelpter()
        {
            //删除超过指定数量的历史文件
            Task.Factory.StartNew(
                () =>
            {
                while (true)
                {
                    try
                    {
                        if (string.IsNullOrWhiteSpace(fileSaveDir))
                        {
                            goto DO_SELEEP;
                        }
                        //自动删除文件,
                        string[] filePathArr = System.IO.Directory.GetFileSystemEntries(fileSaveDir,"*.log");

                        if (filePathArr == null || filePathArr.Length == 0)
                        {
                            goto DO_SELEEP;
                        }
                        List<FileInfo> files = new List<FileInfo>();
                        foreach (var item in filePathArr)
                        {
                            //Console.WriteLine("日志文件:" + item);
                            System.IO.FileInfo fileInfo = new System.IO.FileInfo(item);
                            files.Add(fileInfo);
                        }
                        var del_files = files.OrderByDescending(g => g.LastWriteTime).Skip(MAX_FILE_COUNT);
                        if (del_files == null || del_files.Count() == 0)
                        {
                            goto DO_SELEEP;
                        }
                        Parallel.ForEach(del_files, file =>
                        {
                            try
                            {
                                if (file.Exists)
                                {
                                    file.Delete();
                                }
                            }
                            catch (Exception)
                            {
                            }
                        });
                    }
                    catch (Exception ex)
                    {
                        Console.WriteLine("LogHelpter执行删除文件功能异常," + ex.Message);
                    }
                DO_SELEEP:
                    System.Threading.Thread.Sleep(30000);
                }
            }

            , TaskCreationOptions.LongRunning);
        }

        /// <summary>
        /// fileFolderPath为文件保存目录
        /// </summary>
        /// <param name="fileFolderPath">文件保存目录</param>
        /// <param name="fileNameNoExtension"></param>
        /// <param name="fileNamePrefix">文件名前缀</param>
        /// <returns></returns>
        static string GetNewFileName(string fileFolderPath, string fileNameNoExtension, string fileNamePrefix = null)
        {
            string fileName = string.Empty;

            //文件名前缀
            fileNamePrefix = string.IsNullOrWhiteSpace(fileNamePrefix) ? "" : fileNamePrefix;
            int index = 1;
            if (fileNameNoExtension.LastIndexOf('_') == -1)
            {
                // fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_" + index + ".log");
            }
            else
            {
                var arr = fileNameNoExtension.Split('_');
                int.TryParse(arr[arr.Length - 1], out index);
                if (index == 0 || index > 9999)
                {
                    index = 1;
                }
            }
            fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_" + index + ".log");
            while (File.Exists(fileName))
            {
                if (File.ReadAllBytes(fileName).Length < fileBytes)
                {
                    break;
                }
                index++;
                fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_" + index + ".log");
            }
            return fileName;
        }

        /// <summary>  
        /// 日志记录,在程序执行的根目录,写入txt文件,文件固定大小,超过限定大小自动创建新日志文件
        /// </summary>  
        /// <param name="msg">记录内容</param>  
        /// <param name="storeDir">文件保存文件夹</param>  
        /// <param name="fileNamePrefix">文件名前缀_</param>  
        /// <returns></returns>  
        public static void AddLog(string msg, string storeDir = null, string fileNamePrefix = null)
        {

            lock (lockObj)
            {
                try
                {
                    // 获取调用堆栈
                    StackTrace stackTrace = new StackTrace();
                    // 获取调用者方法(ParentMethod)的堆栈帧
                    StackFrame callerFrame = stackTrace.GetFrame(1); // 0 是当前方法,1 是调用者

                    // 获取调用者方法名
                    string callerMethodName = callerFrame.GetMethod().Name;

                    // 获取调用者类名(可能是父类)
                    Type callerType = callerFrame.GetMethod().DeclaringType;
                    string callerClassName = callerType.FullName;//调用者完整类名:命名空间.类名
                                                                 // string parentClassName = callerType.BaseType?.Name; // 如果是继承关系

                    string msgDebug = $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")} 类={callerClassName},方法={callerMethodName}:{msg}";
                    Console.WriteLine(msgDebug);
                    System.Diagnostics.Debug.WriteLine(msgDebug);

                    //文件名前缀
                    fileNamePrefix = string.IsNullOrWhiteSpace(fileNamePrefix) ? "" : fileNamePrefix + "_";

                    string fileFolderPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, saveFolder);
                    if (!string.IsNullOrWhiteSpace(storeDir))
                    {
                        fileFolderPath = Path.Combine(fileFolderPath, storeDir);
                    }
                    if (Directory.Exists(fileFolderPath) == false)
                    {
                        Directory.CreateDirectory(fileFolderPath);
                    }
                    fileSaveDir = fileFolderPath;
                    string fileName = string.Empty;

                    string[] files = Directory.GetFiles(fileFolderPath,"*.log");
                    if (files==null || files.Length == 0)
                    {
                        fileName = Path.Combine(fileFolderPath, fileNamePrefix + DateTime.Now.ToString("yyyy-MM-dd") + "_1.log");
                        goto DO_WRITE;
                    }
                    //string[] files2 = files.OrderByDescending(x => x).ToArray();
                    //string[] files2 = files.OrderByDescending(x => int.Parse(x.Substring(x.LastIndexOf("_")).Split("_")[1].Split(".")[0])).ToArray();
                    //string[] files2 = files.OrderByDescending(x => Regex.Matches(x, "_\\d*").Cast<string>().Last()).ToArray();
                    string[] files2 = files.OrderByDescending(x =>
                    {
                        //文件名后缀提取
                        var regList = Regex.Matches(x, "_\\d*");
                        if (regList == null || regList.Count == 0)
                        {
                            return null;
                        }
                        return regList.Cast<Match>().Last().Value.TrimStart('_');
                    }).ToArray();

                    FileInfo fileInfo = new FileInfo(files2[0]);
                    string fileNameNoExtension = Path.GetFileNameWithoutExtension(fileInfo.Name);
                    fileName = GetNewFileName(fileFolderPath, fileNameNoExtension, fileNamePrefix);

                DO_WRITE:
                    FileStream fs = new FileStream(fileName, FileMode.Append, FileAccess.Write, FileShare.Write);
                    string msg299 = $"{DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fff")}>类={callerClassName},方法={callerMethodName}:{msg}{System.Environment.NewLine}";
                    byte[] logBytes = UTF8Encoding.UTF8.GetBytes(msg299);
                    fs.Write(logBytes, 0, logBytes.Length);
                    fs.Flush();
                    fs.Close();
                    fs.Dispose();
                    //  tishiMsg = "写入日志成功"; 
                }
                catch (Exception ex)
                {
                    Console.WriteLine("LogHelpter日志写入异常:" + ex.ToString());
                }
            } /* lock结束 */
        }

    }
}

 举例调用,记录日志,日志文件名时日期

LogHelpter.AddLog("获取到的ContentTypeId=" + _ContentTypeId);

如果要以自定义字符串作为文件名前缀,方便区分:

LogHelpter.AddLog("上传的文件大小:",null,"Upload");

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

王焜棟琦

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值