许可优化
许可优化
产品
产品
解决方案
解决方案
服务支持
服务支持
关于
关于
软件库
当前位置:服务支持 >  软件文章 >  Unity日志管理脚本分享,Debug输出规范化管理

Unity日志管理脚本分享,Debug输出规范化管理

阅读数 10
点赞 0
article_banner


日志优化前提,在我们制作的具体项目中会有很多日志的输出,但是到最后发版的时候又需要关掉一些普通的信息日志,只需要输出警告和错误日志即可。

同时需要注意,大量输出日志,会增加性能的消耗,并且还会增加大量的GC,因此在实际发布时,尽可能的减少日志输出

但是在研发的时候为了方便测试肯定会大量的增加日志输出,这就导致发布时要取消日志输出就需要一个个删掉或注释掉,发布完还得去取消注释或者增加日志,这么做就会特别麻烦。

那么Unity有没有自带的日志开关呢?有,但是只有一个控制全部的bool属性如下,设置false时就是关闭日志输出,为true时打开日志输出

代码块

UnityEngine.Debug.developerConsoleVisible = false;

那么如果需要直关闭Log日志,或者警告日志,报错日志还是开启呢,那么自带的控制方式,因此只能自行整理日志系统。

下面就直接放上我整理的日志脚本,可能后续会碰到问题再次优化,如果有优化再更新到文章中。下面的脚本,还包含了把日志导出成日志文件。

代码块

namespace TenderRain.Core
{
    [System.Flags]
    public enum LogType : byte
    {
        None = 0,
        Assert = 1 << 1,
        Log = 1 << 2,
        Warning = 1 << 3,
        Error = 1 << 4,
        Exception = 1 << 5,
        All = byte.MaxValue,
    }

    public static class Logger
    {
        /// <summary> 是否打印日志 </summary>
        public static LogType Type { get; private set; } = LogType.All;

        /// <summary> 是否导出日志 </summary>
        public static bool IsExportLogFile { get; private set; } = false;

        /// <summary> 日志路径 </summary>
        public static string ExportLogBaseFolder { get; private set; } = string.Empty;

        /// <summary> 本次日志完整路径 </summary>
        public static string LogFileFullPath { get; private set; } = string.Empty;

        /// <summary> 当日日志文件数量 </summary>
        public static int LogFileCount { get; private set; } = 0;

        /// <summary> 上一次日志文件位置 </summary>
        private static string LastLogFileFolder = string.Empty;

        /// <summary>
        /// 打印普通日志
        /// </summary>
        /// <param name="message"></param>
        public static void Log(object message)
        {
            if (HasLogType(LogType.Log))
            {
                Export(LogType.Log, message);
            }
        }

        /// <summary>
        /// 打印警告日志
        /// </summary>
        /// <param name="message"></param>
        public static void Warning(object message)
        {
            if (HasLogType(LogType.Warning))
            {
                Export(LogType.Warning, message);
            }
        }

        /// <summary>
        /// 打印错误日志
        /// </summary>
        /// <param name="message"></param>
        public static void Error(object message)
        {
            if (HasLogType(LogType.Error))
            {
                Export(LogType.Error, message);
            }
        }

        /// <summary>
        /// 打印Unity日志
        /// </summary>
        /// <param name="message"></param>
        public static void Assert(object message)
        {
            if (HasLogType(LogType.Assert))
            {
                Export(LogType.Assert, message);
            }
        }

        /// <summary>
        /// 打印Exception日志
        /// </summary>
        /// <param name="ex"></param>
        public static void Exception(System.Exception ex)
        {
            if (HasLogType(LogType.Exception))
            {
                Export(LogType.Exception, $"HResult = {ex.HResult} \n Message = {ex.Message} \n StackTrace = {ex.StackTrace} \n Source = {ex.Source} \n InnerException = {ex.InnerException} \n TargetSite = {ex.TargetSite} \n Data = {ex.Data} , HelpLink = {ex.HelpLink}");
            }
        }

        private static void Export(LogType type, object message)
        {
            var exportMessage = $"[ {nameof(Logger)} => {type.ToString()} ({System.DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss.fffffff")}) ] => Log: {message}";

            switch (type)
            {
                case LogType.Assert:
                    {
                        UnityEngine.Debug.LogAssertion(exportMessage);
                    }
                    break;
                case LogType.Log:
                    {
                        UnityEngine.Debug.Log(exportMessage);
                    }
                    break;
                case LogType.Warning:
                    {
                        UnityEngine.Debug.LogWarning(exportMessage);
                    }
                    break;
                case LogType.Error:
                    {
                        UnityEngine.Debug.LogError(exportMessage);
                    }
                    break;
                case LogType.Exception:
                    {
                        UnityEngine.Debug.LogError(exportMessage);
                    }
                    break;
                default:
                    {
                        exportMessage = $"Unknow Log:{exportMessage}";

                        UnityEngine.Debug.LogWarning(exportMessage);
                    }
                    break;
            }

            //TODO:将日志导出成文件

            if (IsExportLogFile)
            {
                RefreshLogFilePath();
                AppendLogFile(exportMessage);
            }
        }

        public static void EnableExportLogFile(string baseLogFolder = RuntimeCore.Empty)
        {
            IsExportLogFile = true;

            ExportLogBaseFolder = baseLogFolder;

            RefreshLogFilePath();
        }

        public static void DisableExportLogFile()
        {
            IsExportLogFile = false;
        }

        private static void RefreshLogFile()
        {
            if (IsExportLogFile)
            {
                AppendLogFile(string.Empty);
                AppendLogFile($"******************************  Start Record Log {System.DateTime.Now.ToString()} ******************************");
                AppendLogFile(string.Empty);
                AppendLogFile($"设备名称: {UnityEngine.SystemInfo.deviceName}");
                AppendLogFile($"操作系统:  {UnityEngine.SystemInfo.operatingSystem}");
                AppendLogFile($"系统内存大小:  {UnityEngine.SystemInfo.systemMemorySize}");
                AppendLogFile($"设备模型:  {UnityEngine.SystemInfo.deviceModel}");
                AppendLogFile($"设备唯一标识符:  {UnityEngine.SystemInfo.deviceUniqueIdentifier}");
                AppendLogFile($"处理器数量:  {UnityEngine.SystemInfo.processorCount}");
                AppendLogFile($"处理器类型:  {UnityEngine.SystemInfo.processorType}");
                AppendLogFile($"显卡标识符:  {UnityEngine.SystemInfo.graphicsDeviceID}");
                AppendLogFile($"显卡名称:  {UnityEngine.SystemInfo.graphicsDeviceName}");
                AppendLogFile($"显卡标识符:  {UnityEngine.SystemInfo.graphicsDeviceVendorID}");
                AppendLogFile($"显卡厂商:  {UnityEngine.SystemInfo.graphicsDeviceVendor}");
                AppendLogFile($"显卡版本:  {UnityEngine.SystemInfo.graphicsDeviceVersion}");
                AppendLogFile($"显存大小:  {UnityEngine.SystemInfo.graphicsMemorySize}");
                AppendLogFile($"显卡着色器级别:  {UnityEngine.SystemInfo.graphicsShaderLevel}");
                AppendLogFile($"是否支持内置阴影:  {UnityEngine.SystemInfo.supportsShadows}");
                AppendLogFile(string.Empty);
                AppendLogFile($"****************************** Record Log List {System.DateTime.Now.ToString()} ******************************");
                AppendLogFile(string.Empty);
            }
        }

        private static void RefreshLogFilePath()
        {
            if (string.IsNullOrEmpty(ExportLogBaseFolder)) ExportLogBaseFolder = UnityEngine.Application.persistentDataPath;

            var date = $"{System.DateTime.Now.Year.ToString("0000")}{System.DateTime.Now.Month.ToString("00")}{System.DateTime.Now.Day.ToString("00")}";
            var logFileFolder = System.IO.Path.Combine(ExportLogBaseFolder, date);

            if (!System.IO.Directory.Exists(logFileFolder))
            {
                System.IO.Directory.CreateDirectory(logFileFolder);
            }

            var fileList = System.IO.Directory.GetFiles(logFileFolder);

            if (LastLogFileFolder != logFileFolder)
            {
                LogFileCount = fileList != null && fileList.Length > 0 ? fileList.Length + 1 : 1;
            }

            LastLogFileFolder = logFileFolder;

            LogFileFullPath = $"{logFileFolder}/{date}_{LogFileCount}.log";

            if (!System.IO.File.Exists(LogFileFullPath))
            {
                RefreshLogFile();
            }
        }

        private static void AppendLogFile(string content)
        {
            if (IsExportLogFile && !string.IsNullOrEmpty(LogFileFullPath))
            {
                using (System.IO.FileStream nFile = new System.IO.FileStream(LogFileFullPath, System.IO.FileMode.Append, System.IO.FileAccess.Write, System.IO.FileShare.ReadWrite, 2048))
                {
                    using (System.IO.StreamWriter sWriter = new System.IO.StreamWriter(nFile))
                    {
                        //写入数据
                        sWriter.Write($"{content}\n");
                    }
                }
            }
        }

        #region Enum Functioin

        /// <summary>
        /// 开启日志打印
        /// </summary>
        public static void EnableLogger()
        {
            Type = LogType.All;
        }

        /// <summary>
        /// 关闭日志打印
        /// </summary>
        public static void DisableLogger()
        {
            Type = LogType.None;
        }

        /// <summary>
        /// 判断是否包含改枚举值
        /// </summary>
        /// <param name="logType"></param>
        /// <returns></returns>
        public static bool HasLogType(LogType logType)
        {
            return (Type & logType) != 0;
        }

        /// <summary>
        /// 增加枚举值
        /// </summary>
        /// <param name="logType"></param>
        /// <returns></returns>
        public static LogType AddLogType(LogType logType)
        {
            return Type | logType;
        }
        /// <summary>
        /// 减少枚举值
        /// </summary>
        /// <param name="logType"></param>
        /// <returns></returns>
        public static LogType RemoveLogType(LogType logType)
        {
            return Type & ~logType;
        }

        #endregion

    }
}



免责声明:本文系网络转载或改编,未找到原创作者,版权归原作者所有。如涉及版权,请联系删

相关文章
技术文档
QR Code
微信扫一扫,欢迎咨询~
customer

online

联系我们
武汉格发信息技术有限公司
湖北省武汉市经开区科技园西路6号103孵化器
电话:155-2731-8020 座机:027-59821821
邮件:tanzw@gofarlic.com
Copyright © 2023 Gofarsoft Co.,Ltd. 保留所有权利
遇到许可问题?该如何解决!?
评估许可证实际采购量? 
不清楚软件许可证使用数据? 
收到软件厂商律师函!?  
想要少购买点许可证,节省费用? 
收到软件厂商侵权通告!?  
有正版license,但许可证不够用,需要新购? 
联系方式 board-phone 155-2731-8020
close1
预留信息,一起解决您的问题
* 姓名:
* 手机:

* 公司名称:

姓名不为空

姓名不为空

姓名不为空
手机不正确

手机不正确

手机不正确
公司不为空

公司不为空

公司不为空