志日志存储与上传日志开关日志双击溯源

message!);注这里特别说一下Console窗口有个Error

Pause按钮意思是如果输出了Error日志则暂停运行有时候策划会跑过来说他的Unity运行游戏的时候突然卡死了感觉就像发现了什么惊天大BUG其实是他点了Error

事实上Debug.Log的参数是object即System.Object

Debug.cspublic

//TestClass事实上它是先执行了对象的ToString()方法然后再输出日志的我们override重写类的ToString()方法就可以自定义输出啦比如

public

string.Format(a:{0}\nb:{1}\nc:{2},

c);}

如果你看Debug类的源码就会发现它有一个接收两个参数的Debug.Log方法这第二个参数context可以帮我们定位到物体的实例

Debug.cspublic

如果你的物体是一个还没实例化的预设的引用则它会直接定位到Project视图中的资源我们来做下实验。

NewBehaviourScript.cs脚本代码如下

using

Camera上把Cube.prefab预设拖给脚本的cubePrefab成员如下

运行测试效果如下

我们上面打印出来的日志都是默认的颜色白色事实上我们可以打印出彩色的日志

Debug.LogFormat(This

实际项目中我们一般是需要把日志写成文件方便出错时通过日志来定位问题。

Unity提供了一个事件Application.logMessageReceived方便我们来监听日志打印这样我们就可以把日志的文本内容写到文件里存起来啦~

1、打印日志事件

我们一般在游戏启动的入口脚本的Awake函数中去监听Application.logMessageReceived事件如下

Awake()

监听日志回调Application.logMessageReceived

OnLogCallBack;

Unity提供了一个可读写的路径给我们访问Application.persistentDataPath我们可以把日志文件存到这个路径下。

注Application.persistentDataPath在不同平台下的路径

WindowsC:/Users/用户名/AppData/LocalLow/CompanyName/ProductName

Mac/Users/用户名/Library/Caches/CompanyName/ProductName

iOS/var/mobile/Containers/Data/Application/APP名称/Documents

需要注意iOS的需要越狱并且使用Filza软件才能查看文件路径哦

using

使用StringBuilder来优化字符串的重复构造StringBuilder

m_logStr

System.DateTime.Now.ToString(yyyyMMddhhmmss);m_logFileSavePath

string.Format({0}/output_{1}.log,

Application.persistentDataPath,

t);Debug.Log(m_logFileSavePath);Application.logMessageReceived

OnLogCallBack;Debug.Log(日志存储测试);}///

summary///

type){m_logStr.Append(condition);m_logStr.Append(\n);m_logStr.Append(stackTrace);m_logStr.Append(\n);if

(m_logStr.Length

(!File.Exists(m_logFileSavePath)){var

File.Create(m_logFileSavePath);fs.Close();}using

(var

File.AppendText(m_logFileSavePath)){sw.WriteLine(m_logStr.ToString());}m_logStr.Remove(0,

m_logStr.Length);}

}我们可以在Application.persistentDataPath路径下看到日志文件

3、日志上传到服务器

上传文件我们可以使用UnityWebRequest来处理这里需要注意我们的日志文件可能很小也可能很大正常情况下都比较小但是有时候报错了是会循环打印日志的导致日志文件特别大所以我们要考虑到大文件读取的情况否则读取日志文件时会很卡建议使用字节流读取。

byte[]

塞入描述字段字段名与服务端约定好form.AddField(desc,

test

塞入日志字节流字段字段名与服务端约定好form.AddBinaryData(logfile,

data,

使用UnityWebRequestUnityWebRequest

request

(!string.IsNullOrEmpty(request.error)){GameLogger.LogError(request.error);}else{GameLogger.Log(日志上传完毕,

服务器返回信息:

request.downloadHandler.text);}request.Dispose();

}调用

StartCoroutine(HttpPost(http://你的web服务器,

data));四、日志开关

实际项目中我们可能需要做日志开关比如开发阶段日志开启正式发布后则关闭日志。

Unity并没有给我们提供一个日志开关的功能那我们就自己封装一下吧~

using

return;Debug.LogWarning(message,

context);}public

}我们所有使用Debug打印日志的地方都是改用GameLogger来打印这样就可以统一通过GameLogger来开关日志的打印了~不过这里会有一个问题就是我们在Console日志窗口双击日志的时候它只会跳转到GameLogger里而不是跳转到我们调用GameLogger的地方。

Test.cs

Start(){GameLogger.Log(哈哈哈哈哈);}

}看它是跳到GameLogger里而不是跳到我们的Test脚本了这个是显然的但我们能不能让它跳到Test脚本里呢

下面我就来给大家表演一下请往下看~

方法二通过反射分析日志窗口的堆栈拦截Unity日志窗口的打开文件事件跳转到我们指定的代码行处。

方一、GameLogger编译为dll

事实上我们写的C#代码都会被Unity编译成dll放在工程中默认是Assembly-CSharp.dll

注ILSpy反编译工具可以从GitHub下载https://github.com/icsharpcode/ILSpy

不过我们看到这个dll包含了其他的C#代码我们能不能专门只为GameLogger生成一个dll呢可以滴只需要把GameLogger.cs单独放在一个子中就可以看到生成了一个GameLogger.dll啦

把它剪切到Unity工程的Plugins目录中把我们的GameLogger.cs脚本删掉或是移动到工程外备份Assembly

Definition文件也删掉如下

这样就大功告成了我们测试一下日志双击溯源如下可以看到现在可以正常跳转到我们想要的地方了。

方二、详见

GameLogger.cs封装Debug日志打印实现日志开关控制、彩色日志打印、日志文件存储等功能LogUploader.cs实现日志上传到服务器的功能Main.cs程序入口脚本同时实现UI界面交互。

原理我上文都有讲这里就不赘述代码细节了可以看注释我都写得比较详细。

2.1、GameLogger.cs代码

封装Debug日志打印实现日志开关控制、彩色日志打印、日志文件存储等功能

///

博客https://blog.csdn.net/linxinfa

///

使用StringBuilder来优化字符串的重复构造private

static

初始化在游戏启动的入口脚本的Awake函数中调用GameLogger.Init///

/summarypublic

System.DateTime.Now.ToString(yyyyMMddhhmmss);s_logFileSavePath

string.Format({0}/output_{1}.log,

Application.persistentDataPath,

t);Application.logMessageReceived

OnLogCallBack;}///

type){s_logStr.Append(condition);s_logStr.Append(\n);s_logStr.Append(stackTrace);s_logStr.Append(\n);if

(s_logStr.Length

(!File.Exists(s_logFileSavePath)){var

File.Create(s_logFileSavePath);fs.Close();}using

(var

File.AppendText(s_logFileSavePath)){sw.WriteLine(s_logStr.ToString());}s_logStr.Remove(0,

static

desc){LogUploader.StartUploadLog(s_logFileSavePath,

desc);}///

nameargs可变参数根据format的格式传入匹配的参数例a,

b/parampublic

return;Debug.Log(FmtColor(color,

message),

return;Debug.Log(FmtColor(green,

message),

return;Debug.Log(FmtColor(yellow,

message),

return;Debug.Log(FmtColor(#00ffff,

message),

return;Debug.LogFormat((string)FmtColor(color,

format),

return;Debug.LogWarning(message,

context);}///

string.Format(color{0}{1}/color,

color,

string.Format(color{0}{1}/color,

color,

string.Format(color{0}{1}/color{2},

color,

UNITY_EDITOR[UnityEditor.Callbacks.OnOpenAssetAttribute(0)]static

bool

(!string.IsNullOrEmpty(stackTrace)

stackTrace.Contains(GameLogger:Log)){//

matches

System.Text.RegularExpressions.Regex.Match(stackTrace,

\(at

(.)\),System.Text.RegularExpressions.RegexOptions.IgnoreCase);string

pathLine

(!pathLine.Contains(GameLogger.cs)){int

splitIndex

System.Convert.ToInt32(pathLine.Substring(splitIndex

1));string

Application.dataPath.Substring(0,

Application.dataPath.LastIndexOf(Assets));fullPath

fullPath

跳转到目标代码的特定行UnityEditorInternal.InternalEditorUtility.OpenFileAtLineExternal(fullPath.Replace(/,

\\),

typeof(UnityEditor.EditorWindow).Assembly.GetType(UnityEditor.ConsoleWindow);//

获取窗口实例var

ConsoleWindowType.GetField(ms_ConsoleWindow,System.Reflection.BindingFlags.Static

|System.Reflection.BindingFlags.NonPublic);var

consoleInstance

((object)UnityEditor.EditorWindow.focusedWindow

consoleInstance){//

ConsoleWindowType.GetField(m_ActiveText,System.Reflection.BindingFlags.Instance

|System.Reflection.BindingFlags.NonPublic);//

activeText

fieldInfo.GetValue(consoleInstance).ToString();return

activeText;}}return

博客https://blog.csdn.net/linxinfa

///

http://127.0.0.1:7890/upload_log.php;public

static

go.AddComponentLogUploader();bhv.StartCoroutine(bhv.UploadLog(logFilePath,

LOG_UPLOAD_URL,

Path.GetFileName(logFilePath);var

data

ReadLogFile(logFilePath);WWWForm

form

塞入描述字段字段名与服务端约定好form.AddField(desc,

desc);//

塞入日志字节流字段字段名与服务端约定好form.AddBinaryData(logfile,

data,

使用UnityWebRequestUnityWebRequest

request

(!string.IsNullOrEmpty(request.error)){GameLogger.LogError(request.error);}else{GameLogger.Log(日志上传完毕,

服务器返回信息:

request.downloadHandler.text);}request.Dispose();}private

byte[]

File.OpenRead(logFilePath)){int

index

监听日志输出到logText中Application.logMessageReceived

(string

(!GameLogger.s_warningLogEnable)

return;}break;case

;uploadBtn.onClick.AddListener(()

{GameLogger.UploadLog(上传日志测试);});logBtn.onClick.AddListener(()

{GameLogger.Log(打印一行日志);});logEnableTgl.onValueChanged.AddListener((v)

v;});GameLogger.Log(大家好我是林新发);GameLogger.LogCyan(我的CSDN博客https://blog.csdn.net/linxinfa);GameLogger.LogYellow(欢迎关注、点赞感谢支持~);GameLogger.LogRed(❤❤❤❤❤❤❤❤❤❤❤);}

}3、挂Main脚本

给MainPanel.prefab预设挂上Main.cs脚本并赋值UI成员如下

4、Web服务器

我们的日志要上传到Web服务器所以我们需要搭建一个Web服务器。

简单的做法是使用PHP小皮~

4.1、Web服务器

关于小皮可以看我之前写的这篇文章https://blog.csdn.net/linxinfa/article/details/103033142

我们设置一下端口号比如7890

这样我们就已经启动了一个Web服务器了通过http://127.0.0.1:7890即可访问

我们打开Web服务器的根中创建一个upload_log.php

php代码如下

Assets/Scripts/GameLogger/GameLogger.cs:72)

Main:Start

Assets/Scripts/Main.cs:70)color#00ffff我的CSDN博客https://blog.csdn.net/linxinfa/color

GameLogger:LogCyan

Assets/Scripts/GameLogger/GameLogger.cs:131)

Main:Start

Assets/Scripts/Main.cs:71)coloryellow欢迎关注、点赞感谢支持~/color

GameLogger:LogYellow

Assets/Scripts/GameLogger/GameLogger.cs:122)

Main:Start

Assets/Scripts/Main.cs:72)colorred❤❤❤❤❤❤❤❤❤❤❤/color

GameLogger:LogRed

Assets/Scripts/GameLogger/GameLogger.cs:104)

Main:Start

Assets/Scripts/Main.cs:73)打印一行日志

GameLogger:Log

Assets/Scripts/GameLogger/GameLogger.cs:72)

Main/c:Startb__5_1

UnityEngine.EventSystems.EventSystem:Update

(at

Library/PackageCache/com.unity.ugui1.0.0/Runtime/EventSystem/EventSystem.cs:501)打印一行日志

GameLogger:Log

Assets/Scripts/GameLogger/GameLogger.cs:72)

Main/c:Startb__5_1

UnityEngine.EventSystems.EventSystem:Update

(at

Library/PackageCache/com.unity.ugui1.0.0/Runtime/EventSystem/EventSystem.cs:501)打印一行日志

GameLogger:Log

Assets/Scripts/GameLogger/GameLogger.cs:72)

Main/c:Startb__5_1

UnityEngine.EventSystems.EventSystem:Update

(at

Library/PackageCache/com.unity.ugui1.0.0/Runtime/EventSystem/EventSystem.cs:501)打印一行日志

GameLogger:Log

Assets/Scripts/GameLogger/GameLogger.cs:72)

Main/c:Startb__5_1

UnityEngine.EventSystems.EventSystem:Update

(at

Library/PackageCache/com.unity.ugui1.0.0/Runtime/EventSystem/EventSystem.cs:501)打印一行日志

GameLogger:Log

Assets/Scripts/GameLogger/GameLogger.cs:72)

Main/c:Startb__5_1

UnityEngine.EventSystems.EventSystem:Update

(at

Library/PackageCache/com.unity.ugui1.0.0/Runtime/EventSystem/EventSystem.cs:501)6、工程源码

本文工程源码我一上传到CODE