优化 ConsoleDebugger 的内存开销

Author: Jiang Yin

Scripts/Runtime/Debugger/DebuggerComponent.ConsoleWindow.LogNode.cs

@@ -16,10 +16,10 @@ namespace UnityGameFramework.Runtime
     public partial class DebuggerComponent
     {
         [Serializable]
-        private sealed partial class ConsoleWindow : IDebuggerWindow
+        private partial class ConsoleWindow : IDebuggerWindow
         {
             private SettingComponent m_SettingComponent = null;
-            private Queue<LogNode> m_Logs = new Queue<LogNode>();
+            private Queue<LogNode> m_LogNodes = new Queue<LogNode>();
             private Vector2 m_LogScrollPosition = Vector2.zero;
             private Vector2 m_StackScrollPosition = Vector2.zero;
             private int m_InfoCount = 0;
@@ -325,9 +325,9 @@ public void OnDraw()
                     m_LogScrollPosition = GUILayout.BeginScrollView(m_LogScrollPosition);
                     {
                         bool selected = false;
-                        foreach (LogNode i in m_Logs)
+                        foreach (LogNode logNode in m_LogNodes)
                         {
-                            switch (i.LogType)
+                            switch (logNode.LogType)
                             {
                                 case LogType.Log:
                                     if (!m_InfoFilter)
@@ -354,12 +354,12 @@ public void OnDraw()
                                     }
                                     break;
                             }
-                            if (GUILayout.Toggle(m_SelectedNode == i, GetLogString(i)))
+                            if (GUILayout.Toggle(m_SelectedNode == logNode, GetLogString(logNode)))
                             {
                                 selected = true;
-                                if (m_SelectedNode != i)
+                                if (m_SelectedNode != logNode)
                                 {
-                                    m_SelectedNode = i;
+                                    m_SelectedNode = logNode;
                                     m_StackScrollPosition = Vector2.zero;
                                 }
                             }
@@ -400,7 +400,7 @@ public void OnDraw()
 
             private void Clear()
             {
-                m_Logs.Clear();
+                m_LogNodes.Clear();
             }
 
             public void RefreshCount()
@@ -409,9 +409,9 @@ public void RefreshCount()
                 m_WarningCount = 0;
                 m_ErrorCount = 0;
                 m_FatalCount = 0;
-                foreach (LogNode i in m_Logs)
+                foreach (LogNode logNode in m_LogNodes)
                 {
-                    switch (i.LogType)
+                    switch (logNode.LogType)
                     {
                         case LogType.Log:
                             m_InfoCount++;
@@ -429,17 +429,65 @@ public void RefreshCount()
                 }
             }
 
+            public void GetRecentLogs(List<LogNode> results)
+            {
+                if (results == null)
+                {
+                    Log.Error("Results is invalid.");
+                    return;
+                }
+
+                results.Clear();
+                foreach (LogNode logNode in m_LogNodes)
+                {
+                    results.Add(logNode);
+                }
+            }
+
+            public void GetRecentLogs(List<LogNode> results, int count)
+            {
+                if (results == null)
+                {
+                    Log.Error("Results is invalid.");
+                    return;
+                }
+
+                if (count <= 0)
+                {
+                    Log.Error("Count is invalid.");
+                    return;
+                }
+
+                int position = m_LogNodes.Count - count;
+                if (position < 0)
+                {
+                    position = 0;
+                }
+
+                int index = 0;
+                results.Clear();
+                foreach (LogNode logNode in m_LogNodes)
+                {
+                    if (index++ < position)
+                    {
+                        continue;
+                    }
+
+                    results.Add(logNode);
+                }
+            }
+
             private void OnLogMessageReceived(string logMessage, string stackTrace, LogType logType)
             {
                 if (logType == LogType.Assert)
                 {
                     logType = LogType.Error;
                 }
 
-                m_Logs.Enqueue(new LogNode(logType, logMessage, stackTrace));
-                while (m_Logs.Count > m_MaxLine)
+                m_LogNodes.Enqueue(ReferencePool.Acquire<LogNode>().Fill(logType, logMessage, stackTrace));
+                while (m_LogNodes.Count > m_MaxLine)
                 {
-                    m_Logs.Dequeue();
+                    ReferencePool.Release(m_LogNodes.Dequeue());
                 }
             }
 

Scripts/Runtime/Debugger/DebuggerComponent.ConsoleWindow.cs

@@ -0,0 +1,74 @@
+//------------------------------------------------------------
+// Game Framework v3.x
+// Copyright © 2013-2018 Jiang Yin. All rights reserved.
+// Homepage: http://gameframework.cn/
+// Feedback: mailto:[email protected]
+//------------------------------------------------------------
+
+using GameFramework;
+using System;
+using UnityEngine;
+
+namespace UnityGameFramework.Runtime
+{
+    public partial class DebuggerComponent
+    {
+        public sealed class LogNode : IReference
+        {
+            private DateTime m_LogTime;
+            private LogType m_LogType;
+            private string m_LogMessage;
+            private string m_StackTrack;
+
+            public LogNode Fill(LogType logType, string logMessage, string stackTrack)
+            {
+                m_LogTime = DateTime.Now;
+                m_LogType = logType;
+                m_LogMessage = logMessage;
+                m_StackTrack = stackTrack;
+
+                return this;
+            }
+
+            public DateTime LogTime
+            {
+                get
+                {
+                    return m_LogTime;
+                }
+            }
+
+            public LogType LogType
+            {
+                get
+                {
+                    return m_LogType;
+                }
+            }
+
+            public string LogMessage
+            {
+                get
+                {
+                    return m_LogMessage;
+                }
+            }
+
+            public string StackTrack
+            {
+                get
+                {
+                    return m_StackTrack;
+                }
+            }
+
+            public void Clear()
+            {
+                m_LogTime = default(DateTime);
+                m_LogType = default(LogType);
+                m_LogMessage = default(string);
+                m_StackTrack = default(string);
+            }
+        }
+    }
+}

Scripts/Runtime/Debugger/DebuggerComponent.LogNode.cs

@@ -284,6 +284,25 @@ public bool SelectDebuggerWindow(string path)
             return m_DebuggerManager.SelectDebuggerWindow(path);
         }
 
+        /// <summary>
+        /// 获取记录的全部日志。
+        /// </summary>
+        /// <param name="results">要获取的日志。</param>
+        public void GetRecentLogs(List<LogNode> results)
+        {
+            m_ConsoleWindow.GetRecentLogs(results);
+        }
+
+        /// <summary>
+        /// 获取记录的最近日志。
+        /// </summary>
+        /// <param name="results">要获取的日志。</param>
+        /// <param name="count">要获取最近日志的数量。</param>
+        public void GetRecentLogs(List<LogNode> results, int count)
+        {
+            m_ConsoleWindow.GetRecentLogs(results, count);
+        }
+
         private void DrawWindow(int windowId)
         {
             GUI.DragWindow(m_DragRect);