一种Unity日志拓展实现思路及方案(附源码

---

title: Unity真机关闭部分日志的实践
date: 2023-01-27 20:41:36
categories:

• 心得 | 分享
• 优雅代码
  tags:
• Unity

---

Unity真机关闭部分日志的实践

背景

Unity在打包时关闭Log的方案有许多，但许多方案都存在问题。

具体可以参见How to use Debug Log in Unity (without affecting performance) - Game Dev Beginner

一些解决方案的问题

常见的问题有：

• 字符串的GC没有考虑

  Log.Instance.Log("A="+a);
  

  比如上面这段代码，“A=”+a的拼接是在传参之前的，这部分开销不合理。

  隐式装箱也很可怕。

• 没有做好宏定义控制，带来if判断的开销。

  部分框架在引入自己的封装Logger时并没有用宏定义来做条件判断，只是简单地用了if判断。

  /// <summary>
  /// info Log
  /// </summary>
  /// <param name="log">Log.</param>
  public void info(object log)
  {
      // 这里有问题，这个if判断的开销依旧可以优化掉。
      if (LogLevel > INFO)
      {
          return;
      }
     	Debug.Log(log);
  }
  

  如上面的例子所示，用if并不是个好选择。

• 用宏定义做了过滤级别的判断，但依然不够好。

  public static class GameLog
  {
      public static void LogMessage(string message)
      {
          #if UNITY_EDITOR
          Debug.Log(message);
          #endif
      }
      public static void LogWarning(string message)
      {
          #if UNITY_EDITOR
          Debug.LogWarning(message);
          #endif
      }
      public static void LogError(string message)
      {
          #if UNITY_EDITOR
          Debug.LogWarning(message);
          #endif
      }
  }
  

  

  虽然没有Debug.Log的开销，但是封装的GameLog.Log的开销依旧存在。

• 关闭UnityLog或者是使用logger.filterLogType = LogType.Log;

  

  这种方案实际上还是会有函数的开销和字符串的开销。

  

  结论

  为了干掉Log的字符串拼接的开销，唯一的办法是用Optional特性。

  若添加了Conditional特性打包时又不满足宏定义，那么打包时该方法的调用会被移除。

  比如说

  [System.Diagnostics.Conditional("UNITY_EDITOR")]
  public static void LogMessage(string message)
  {
      Debug.Log(message);
  }
  

  若我们调用

  LogMessage("msg:"+111);
  

  这一段代码是不会被执行的，包括字符串拼接也不会被执行。

参考

How to use Debug Log in Unity (without affecting performance) - Game Dev Beginner