unity日志過濾器

背景：

?之前做游戲的時候和同組的同事聊過說日志過濾盡量不要限制大家怎么使用日志打印的接口，不要加額外的參數，比如多加一個標簽string,或者使用特定的接口，枚舉。最好就是日志大家還是用Debug.Log無感去用，然后通過勾選一些toggle去賽選你感興趣的日志。

原理：

通過分析堆棧，判斷當前日志所屬哪一個模塊，具體屬于哪一個模塊可以通過自定義模塊路徑配置來解決，比如LogFilter.json

如果你的日志來源于路徑manager/net那么該日志屬于網絡模塊，勾選網絡則只打印網絡日志，當然可以同時勾選多個日志，這取決于你上面配置了多少json數組。另外當你勾選了一些toggle之后如果希望保存，比如你只關心你的模塊但是不想每次都去勾選一堆的toggle，那么點擊Save tag可以保存你的修改，對應的配置路徑在

其json格式為：

運行截圖：

核心類：

#if DebugMod
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;

using HotFix.Manager;
using HotFix.UtilTool;
using Newtonsoft.Json;
using UnityEngine;

namespace HotFix.Helper.LogHelper
{

? ? public class LogHelper : SingletonMono<LogHelper>
{
public class Log
{
public enum _LogType
{
Assert = LogType.Assert,
Error = LogType.Error,
Exception = LogType.Exception,
Log = LogType.Log,
Warning = LogType.Warning,
}

? ? ? ??
public _LogType logType;
public string condition;
public string stacktrace;
public string time;
public string moduleName;

? ? ? ? ? ? public override string ToString()
{
return time + condition + "\n" + stacktrace;
}

public Log CreateCopy()
{
return (Log)this.MemberwiseClone();
}
public float GetMemoryUsage()
{
return (float)(sizeof(int) +
sizeof(_LogType) +
condition.Length * sizeof(char) +
stacktrace.Length * sizeof(char) +
sizeof(int));
}
}

? ? ? ? public List<Log> logs = new();
public Dictionary<string, string> fileModule = new();

? ? ? ? private Dictionary<string, HashSet<string>> customModuleMap;
public Dictionary<string, HashSet<string>> CustomModuleMap
{
get
{
#if UNITY_EDITOR
if(customModuleMap == null)
{
var sourceFile = proRoot + "/environment/LogFilter.json";
if (File.Exists(sourceFile))
{
if(File.Exists(persistentDataPath + "/LogFilter.json"))
{
File.Delete(persistentDataPath + "/LogFilter.json");
}
File.Copy(sourceFile, persistentDataPath + "/LogFilter.json");
}
}

#endif
if(customModuleMap == null && File.Exists(persistentDataPath + "/LogFilter.json"))
{
customModuleMap = JsonConvert.DeserializeObject<Dictionary<string, HashSet<string>>>(File.ReadAllText(persistentDataPath + "/LogFilter.json"));

}
return customModuleMap;
}

}
public Regex pattern = new Regex(@"\bat Assets/([^:]+)\.cs:\d+\b", RegexOptions.Compiled);
public string persistentDataPath = "";
public string proRoot;
public override void Init()
{
#if UNITY_EDITOR // debug模式不監聽因為需要正則處理堆棧信息?
Application.logMessageReceivedThreaded -= CaptureLogThread;
Application.logMessageReceivedThreaded += CaptureLogThread;
#endif
persistentDataPath = Application.persistentDataPath;
proRoot = Environment.CurrentDirectory;
}
string GetModuleName(string path, int level = 2)
{
if(CustomModuleMap != null && CustomModuleMap.Count > 0)
{
string matchKey = customModuleMap.FirstOrDefault(pair => pair.Value.Any(value => path.StartsWith(value))).Key;
if(matchKey != null)
{
return matchKey;
}

? ? ? ? ? ? }
return "other";
//int index = 0;
//int lastIndex = 0;
//int runLevel = 0;
//for (int i = path.Length - 1; i >= 0; --i)
//{
// ? ?if (path[i] == '/')
// ? ?{
// ? ? ? ?lastIndex = index;
// ? ? ? ?index = i;
// ? ? ? ?++runLevel;
// ? ? ? ?if (runLevel == level)
// ? ? ? ?{
// ? ? ? ? ? ?break;
// ? ? ? ?}
// ? ?}
//}
//int length = Math.Abs(index - lastIndex) - 1;
//length = Math.Max(0, length);
//var moduleName = path.Substring(index + 1, length);
//return moduleName;
}
void CaptureLogThread(string condition, string stacktrace, LogType type)
{

var arr = stacktrace.Split("\n");
string dir = null;
string csName = "";
string moduleName = "";
//逐行分析日志?
for (int i = 0; i < arr.Length; i++)
{
//有些日志屬于自定義日志或者封裝的日志接口這種需要過濾堆棧?
if (arr[i].StartsWith("HotFix.UtilTool.CommonUtils"))
{
continue;
}
if (pattern.IsMatch(arr[i]))
{
var group = pattern.Match(arr[i]);
dir = group.Groups[1].Value;
csName = dir.Substring(dir.LastIndexOf("/") + 1);
lock(fileModule)
{
if (!fileModule.ContainsKey(csName))
{
moduleName = GetModuleName(dir,2);
fileModule[csName] = moduleName;
}
else
{
moduleName = fileModule[csName];
}
}
Log log = new Log() { condition = condition, stacktrace = stacktrace, logType = (Log._LogType)type ,moduleName = moduleName,time = $"[{DateTime.Now.ToString("HH:mm:ss:fff")}]" };
lock (logs)?
{
logs.Add(log);
}
break;
}
}

}

? ? ? ??
}
}
#endif

核心gui類：

部分接口請參考github實現。

#if DebugMod
using UnityEditor;
using UnityEngine;
using System.Collections.Generic;
using HotFix.Helper.LogHelper;
using Newtonsoft.Json;
using HotFix.UtilTool;
using System.IO;
using System.Text;

//作為loghelper的顯示窗口不打算做到包體內部
// 先在編輯器上測試?

public class LogHelperWindow : EditorWindow
{

public class ShowControlInfo
{
public ShowControlInfo()
{
isShowLog = false;
Color = new Color(1, 1, 1, 1);
showDebugTrace = false;
}
public bool showDebugTrace; // 是否顯示堆棧?

public int color_r = 255;
public int color_g = 255;
public int color_b = 255;
[JsonIgnore]
public Color _color;
[JsonIgnore]
private bool isColorCtor = false;
[JsonIgnore]
public Color Color
{
set
{
_color = value;
color_r = UnityEngine.Mathf.CeilToInt( _color.r * 255);
color_g = UnityEngine.Mathf.CeilToInt(_color.g * 255);
color_b = UnityEngine.Mathf.CeilToInt(_color.b * 255);
}
get
{
if(!isColorCtor)
{
isColorCtor = true;
_color = new Color(color_r / 255f, color_g / 255f, color_b / 255f, 1f);
}
return _color;
}
}
public bool isShowLog;
}
// 滾動視圖的位置
private Vector2 scrollPosition;
private bool isShow = false;
public Dictionary<string, ShowControlInfo> allTags = new Dictionary<string, ShowControlInfo>();
private bool isAllSelected = false; // 全選狀態
private Vector2 tagScrollPosition; // 標簽滾動視圖位置

private bool isInited = false;
private GUIStyle customLogStyle;
// 繪制錯誤圖標
private Texture2D errorIcon;?
[InitializeOnLoadMethod]
static void Initialize()
{
if( EditorPrefs.GetBool("customlog"))
{
// 訂閱播放模式狀態改變事件
EditorApplication.playModeStateChanged += OnPlayModeStateChanged;
}

}
private static void OnPlayModeStateChanged(PlayModeStateChange state)
{
if (state == PlayModeStateChange.EnteredPlayMode)
{
// 當進入播放模式時，打開自定義控制臺窗口
ShowWindow();
}
else if(state == PlayModeStateChange.ExitingPlayMode)
{
CloseWindow();
}
}

? ? public static void ShowWindow()
{
// 獲取或創建自定義控制臺窗口實例
LogHelperWindow window = GetWindow<LogHelperWindow>(false,"Custom Console",true);
window.Show();
window.OnShow();
}

? ? public static void CloseWindow()
{
LogHelperWindow window = GetWindow<LogHelperWindow>(false, "Custom Console", true);
window.OnRelease();
}
private void OnShow()
{
isShow = true;
}
private void OnRelease()
{
isShow = false;
isInited = false;
}

? ? // 繪制窗口內容
private void OnGUI()
{
if (!Application.isPlaying || !isShow) return;

? ? ? ? if(!isInited)
{
isAllSelected = false;
isInited = true;
errorIcon = EditorGUIUtility.Load("icons/d_console.erroricon.sml.png") as Texture2D;
if (errorIcon == null)
{
errorIcon = new Texture2D(16, 16);
Color[] pixels = new Color[16 * 16];
for (int i = 0; i < pixels.Length; i++)
{
pixels[i] = Color.red; // 紅色感嘆號
}
errorIcon.SetPixels(pixels);
errorIcon.Apply();
}

customLogStyle = new GUIStyle(EditorStyles.label);
// 設置選中時的背景顏色
Texture2D selectedBackground = new Texture2D(1, 1);
selectedBackground.SetPixel(0, 0, Color.blue); // 這里將選中背景顏色設為紅色
selectedBackground.Apply();
//customLogStyle.normal.background = selectedBackground;
customLogStyle.onFocused.background = selectedBackground;

? ? ? ? ? ? ReadTagConfig();
}

// --- 整體橫向布局 ----
EditorGUILayout.BeginHorizontal(GUILayout.ExpandHeight(true));

? ? ? ? // ----------- 左側：日志滾動區（自動填充剩余空間） ------------
scrollPosition = EditorGUILayout.BeginScrollView(
scrollPosition,
GUILayout.ExpandWidth(true), GUILayout.ExpandHeight(true)
);
{

var logs = LogHelper.Instance.logs;
foreach (var item in LogHelper.Instance.fileModule.Values)
{
if (!allTags.ContainsKey(item))
allTags.Add(item, new ShowControlInfo());
}
Color consoleColor = GUI.color;
foreach (var log in logs)
{
var tagInfo = allTags[log.moduleName];
if (!tagInfo.isShowLog) continue;

? ? ? ? ? ? ? ? GUI.color = tagInfo.Color;
EditorGUILayout.BeginVertical("box");
string content = "";
if (tagInfo.showDebugTrace)
{
content = $"{log.time}{log.condition}\n{log.stacktrace}";
}
else
{
content = $"{log.time}{log.condition}";
}

? ? ? ? ? ? ? ? if(log.logType == LogHelper.Log._LogType.Error)
{
EditorGUILayout.BeginHorizontal();
{
GUILayout.Label(new GUIContent(errorIcon), GUILayout.Width(16), GUILayout.Height(16)); // 顯示圖標

? ? ? ? ? ? ? ? ? ? ? ? var height = Mathf.Max(20, GUI.skin.label.CalcHeight(new GUIContent(content), position.width - 240)); //留出右側寬度
EditorGUILayout.SelectableLabel(content, customLogStyle, GUILayout.Height(height));
EditorGUILayout.EndHorizontal();
}

}
else
{
var height = Mathf.Max(20, GUI.skin.label.CalcHeight(new GUIContent(content), position.width - 240)); //留出右側寬度
EditorGUILayout.SelectableLabel(content, customLogStyle, GUILayout.Height(height));
}

EditorGUILayout.EndVertical();
}
GUI.color = consoleColor;
EditorGUILayout.EndScrollView();
}

? ? ? ? // ----------- 右側：標簽篩選區（固定寬度，豎直鋪滿） ------------
EditorGUILayout.BeginVertical("box", GUILayout.Width(400), GUILayout.ExpandHeight(true));
{
EditorGUILayout.LabelField("標簽篩選", EditorStyles.boldLabel);

? ? ? ? ? ? // 標簽滾動部分-豎直鋪滿
tagScrollPosition = EditorGUILayout.BeginScrollView(tagScrollPosition, GUILayout.ExpandHeight(true));
{
foreach (var tag in allTags)
{
GUILayout.BeginHorizontal();
{
bool newValue = GUILayout.Toggle(tag.Value.isShowLog,tag.Key);
if (newValue != tag.Value.isShowLog)
allTags[tag.Key].isShowLog = newValue;

? ? ? ? ? ? ? ? ? ? ? ? GUILayout.Space(5);

? ? ? ? ? ? ? ? ? ? ? ? bool showTrace = GUILayout.Toggle(tag.Value.showDebugTrace,"堆棧" );
if (showTrace != tag.Value.showDebugTrace)
allTags[tag.Key].showDebugTrace = showTrace;
GUILayout.Space(5);
GUILayout.Label("顏色", GUILayout.Width(40));
Color newColor = EditorGUILayout.ColorField(tag.Value.Color, GUILayout.Width(60));
if (newColor != tag.Value.Color)
tag.Value.Color = newColor;

? ? ? ? ? ? ? ? ? ? ? ? GUILayout.EndHorizontal();
}

}
}
EditorGUILayout.EndScrollView();

? ? ? ? ? ? // 全選/取消全選
EditorGUILayout.Space();
if (GUILayout.Button(isAllSelected ? "取消全選" : "全選"))
{
isAllSelected = !isAllSelected;
var keys = new List<string>(allTags.Keys);
foreach (var key in keys)
allTags[key].isShowLog = isAllSelected;
}
}
EditorGUILayout.EndVertical();

? ? ? ? // --- End橫向大布局
EditorGUILayout.EndHorizontal();

? ? ? ? // ------ 下方操作按鈕區（單獨一行） ------
EditorGUILayout.BeginHorizontal();
if (GUILayout.Button("save tag"))
SaveLogTag();
if (GUILayout.Button("copy log"))
CopyLog();
if (GUILayout.Button("Clear Logs"))
ClearLogs();
EditorGUILayout.EndHorizontal();
}
private void ReadTagConfig()
{
allTags?.Clear();
var path = tagPath;
path = CommonUtils.GetLinuxPath(path);
var content = File.ReadAllText(path);
allTags = JsonConvert.DeserializeObject<Dictionary<string, ShowControlInfo>>(content);
}
void CopyLog()
{
StringBuilder sb = new();
var logs = LogHelper.Instance.logs;
foreach(var log in logs)
{
if(allTags[log.moduleName].isShowLog)
{
sb.AppendLine(log.ToString());
}
}

? ? ? ? GUIUtility.systemCopyBuffer = sb.ToString();

? ? }

? ? private string tagPath = System.Environment.CurrentDirectory + "/environment/log.json";

private void SaveLogTag()
{
var settings = new JsonSerializerSettings
{
Formatting = Formatting.Indented, // 格式化輸出，使生成的 JSON 有縮進
};
var json = JsonConvert.SerializeObject(allTags, settings);
var path = tagPath;
path = CommonUtils.GetLinuxPath(path);
EasyUseEditorFuns.CreateDir(path);
File.WriteAllText(path, json);
this.ShowNotification(new GUIContent($"保存日志tag成功{path}"));
} ? ?

// 清空日志的方法
private void ClearLogs()
{
LogHelper.Instance.logs?.Clear();
}
}
#endif