Unity-自定义Debug｜默然的博客

初衷

1. 在Runtime下可以控制日志是否打印，方便后期调试;
2. 在C#中添加dump方法，可以像lua一样对class,Array,IList,dict,string,值类型的信息查看;
3. 打印带颜色日志麻烦。

代码如下：

using System.Collections;
using System.Reflection;
using System.Text;
using UnityEngine;
using UObject = UnityEngine.Object;

public class Log
{
    // 日志等级
    public static LevelEum Level = LevelEum.All;

    #region API
    /// <summary>
    /// 普通日志
    /// </summary>
    static public void Info(object message, UObject context = null)
    {
        if ((int)Level > 0)
            Debug.Log(message, context);
    }

    static public void Info(object message, Color color, UObject context = null)
    {
        Info($"<color=#{getColorHex(color)}>{message}</color>", context);
    }

    static public void RedInfo(object message, UObject context = null)
    {
        Info($"<color=red>{message}</color>", context);
    }

    static public void GreenInfo(object message, UObject context = null)
    {
        Info($"<color=green>{message}</color>", context);
    }

    /// <summary>
    /// 警告消息
    /// </summary>
    static public void Warning(object message, UObject context = null)
    {
        if ((int)Level >= 2)
            Debug.LogWarning(message, context);
    }

    /// <summary>
    /// 错误消息
    /// </summary>
    static public void Error(object message, UObject context = null)
    {
        if ((int)Level >= 1)
            Debug.LogError(message, context);
    }


    static public void Dump(object obj, int maxLayer = 5)
    {
        mMaxLayer = maxLayer;
        builder.Remove(0, builder.Length);
        builder.AppendLine("dump info ");
        dumpHandler(obj, 1);

        Info(builder.ToString());
    }

    #endregion

    #region privite

    private const string SPACE = " ";
    private static readonly StringBuilder builder = new StringBuilder("", 1024);
    private static int mMaxLayer = 5;

    static private void dumpHandler(object obj, int layer)
    {
        if (obj == null)
        {
            builder.Append("null");
            return;
        }

        System.Type t = obj.GetType();

        if (obj is string)
        {
            builder.Append("\"");
            builder.Append(obj);
            builder.Append("\",");
        }
        else if (t.IsValueType)
        {
            builder.Append(obj);
            builder.Append(",");
        }

        else if (obj is IList list)
        {
            builder.AppendLine("[");
            if (layer <= mMaxLayer)
            {
                for (int i = 0; i < list.Count; i++)
                {
                    appendSpace(layer);
                    builder.Append(i);
                    builder.Append(":");
                    dumpHandler(list[i], layer + 1);
                    builder.AppendLine();
                }
            }
            else
            {
                builder.Append("List Data...");
            }

            builder.Append("]");
        }
        else if (obj is IDictionary dict)
        {
            builder.AppendLine("{");
            if (layer <= mMaxLayer)
            {
                foreach (var key in dict.Keys)
                {
                    builder.Append(key.ToString());
                    builder.AppendLine(":");
                    dumpHandler(dict[key], layer + 1);
                    builder.AppendLine();
                }
            }
            else
            {
                builder.Append("Dictionary Data...");
            }

            builder.AppendLine("}");
        }
        else if (t.IsArray)
        {
            System.Array array = obj as System.Array;
            builder.Append("[");
            if (layer <= mMaxLayer)
            {
                for (int i = 0; i < array.Length; i++)
                {
                    builder.Append(i);
                    builder.Append(" : ");
                    dumpHandler(array.GetValue(i), layer + 1);
                }
            }
            else
            {
                builder.Append("Array Data...");
            }

            builder.Append("]");
        }
        else if (t.IsClass)
        {
            builder.AppendLine("{");
            var fields = t.GetFields(BindingFlags.Public | BindingFlags.Instance);
            appendSpace(layer);
            builder.AppendLine("// 字段如下：");
            if (fields.Length > 0)
            {
                if (layer <= mMaxLayer)
                {
                    foreach (FieldInfo info in fields)
                    {
                        appendSpace(layer);
                        builder.Append(info.Name);
                        builder.Append(" : ");
                        object value = info.GetValue(obj);
                        dumpHandler(value, layer + 1);
                        builder.AppendLine();
                    }
                }
                else
                {
                    builder.Append("Class...");
                }
            }

            builder.AppendLine();
            appendSpace(layer);
            builder.AppendLine("// 属性如下：");
            var properties = t.GetProperties(BindingFlags.Public | BindingFlags.Instance);
            if (properties.Length > 0)
            {
                if (layer <= mMaxLayer)
                {
                    foreach (PropertyInfo info in properties)
                    {
                        builder.Append(info.Name);
                        builder.Append(" : ");
                        object value = info.GetGetMethod().Invoke(obj, null);
                        dumpHandler(value, layer + 1);
                        builder.AppendLine();
                    }
                }
                else
                {
                    builder.Append("Class...");
                }
            }
            builder.Append("}");
        }
        else
        {
            RedInfo("unsupport type:" + t.FullName);
            builder.Append(t.FullName);
            builder.Append(",");
        }
    }

    // 缩进
    static private void appendSpace(int layer)
    {
        for (int i = 0, iMax = layer * 3; i < iMax; i++)
        {
            builder.Append(SPACE);
        }
    }

    // UnityColor to hex
    static private string getColorHex(Color color)
    {
        // 这里用ToHtmlStringRGB竟然不行
        return ColorUtility.ToHtmlStringRGBA(color);
    }
    #endregion

    public enum LevelEum
    {
        None = 0, // 不打印日志
        OnlyError = 1, // 只显示Error
        Error_Warn = 2, // Error和警告
        All = 3, // 所有日志
    }
}

解决双击日志跳转到Log文件的问题

上面代码如果直接放到工程中使用，双击打印的日志会直接进入Log文件，而不是我们调用的地方。解决方案就是把Log类打包成dll然后放到u3d的Plugins目录下。

啥？你不会搞Unity中可以用的类库？

1. VS打开Unity工程，在解决方案资源管理器->解决方案目录下右击->添加->新建项目
2. 选择类库(.Net Framework)进行创建。
3. 右击创建的类库->属性->用程序->目标框架选择Unity 3.5 .net Subset Base Class Libraries，保存即可。(要是没这个选项就是你创建的类库类型不对，回第二部重新来过)
4. 在应用程序->生成事件中生成事件后命令行中填入直接复制到工程的命令：

:: 下面是我的路径
copy $(TargetPath) $(TargetDir)..\..\..\UnityClient\Assets\Plugins\NDebug.dll

5. 给库添加UnityEngine.dll的引用。（有需要的话）
6. 直接成成解决方案，就会生成dll,并复制到指定目录下。

相关阅读

• 目录及资源路径规范整理(03)
• 设计模式-单例模式