unity一键注释日志和反注释日志

news2024/10/1 19:08:11

开发背景：游戏中日志也是很大的开销，虽然有些日志不打印但是毕竟有字符串的开销，甚至有字符串拼接的开销，有些还有装箱和拆箱的开销，比如Debug.Log(1) 这种

因此需要注释掉，当然还需要提供反注释的功能，需要的时候能立马找回来。

也就是说我们只需要打包的时候处理即可。

1.先检测代码中是否存在不规范代码，类似if(a > 1) Debug.Log("11") 这种代码如果注释掉日志会引起业务逻辑问题需要先找出来，类似的不限于if else for foreach while这些 所以尽可能的要做这个检测，有这类问题直接报错。然后才可以进行后续流程

2.注释Debug.Log或者UnityEngine.Debug.Log，但是有一个问题就是注释之后再注释的问题，所以在调用这个接口前需要调用反注释然后调用注释，这样就可以保证注释是没有问题的。

3.需要提供反注释的代码，主要是配合2的功能

注意事项：大家写代码的过程中想打日志就打日志这个没有限制，打包的时候会自动处理日志。

如果是特别的日志可以打错误日志或者警告，或者自定义日志那种日志不去处理即可。

未来规划是用代码分析给日志加标签，平常开发还是按unity的习惯来我绝对不改变大家的unity标准，在做扩展的时候尽量做到神不知鬼不觉，不让大家有额外操作不让大家有压力。

接着上面扩展 ：如下图所示这种else日志不被允许

那么如何进行csharp的语法分析呢 ，我们建一个c#的控制台程序，使用nuget安装3个包

 Microsoft.CodeAnalysis.CSharp 和 Microsoft.CodeAnalysis.CSharp.Workspaces  和Microsoft.CodeAnalysis

分析c#代码检测是否存在if else for while foreach 后直接接Debug.Log或者UnityEngine.Debug.Log完整控制台程序如下

using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using Microsoft.CodeAnalysis.CSharp.Syntax;
namespace cs_test
{
    internal class Program
    {
        public static long getCurrentTimeMillis()
        {
            long milliseconds = System.DateTime.Now.Ticks / System.TimeSpan.TicksPerMillisecond;
            return milliseconds;
        }
        static long firstTime = 0;
        const float LogWritetimeOutTime = 2f;
        static List<string> strList = new List<string>();
        static void SetTimer(float time = LogWritetimeOutTime)
        {
            System.Timers.Timer timer = new System.Timers.Timer();
            timer.Interval = time;
            timer.AutoReset = false;
            timer.Enabled = true;
            
            timer.Elapsed += (a, b) =>
            {
                using (var fs = new FileStream(logPath, FileMode.Append,FileAccess.Write,FileShare.Write))
                {
                    using (var sw = new StreamWriter(fs, Encoding.UTF8))
                    {
                        lock (strList)
                        {
                            foreach (var item in strList)
                            {
                                sw.WriteLine(item);
                            }
                            strList.Clear();
                        }
                    }
                }
            };
        }
        static void Log(string str,bool useFileSystem = true)
        {
            if(useFileSystem && isLogToFile)
            {
                lock (strList)
                {
                    strList.Add(str);
                }
                if (firstTime == 0)
                {
                    firstTime = getCurrentTimeMillis();
                    SetTimer(LogWritetimeOutTime);
                    return;
                }
                if (getCurrentTimeMillis() - firstTime > LogWritetimeOutTime)
                {
                    firstTime = 0;
                    SetTimer(LogWritetimeOutTime);
                }
            }
            else
            {
                Console.WriteLine(str);
            }
        }
        public class LogStatementWalker : CSharpSyntaxWalker
        {
            public List<Issue> Issues { get; } = new List<Issue>();
            public override void VisitIfStatement(IfStatementSyntax node)
            {
                CheckBlockStatement(node.Statement, node.GetLocation());
                if (node.Else != null)
                {
                    CheckElseStatement(node.Else);
                }
                base.VisitIfStatement(node);
            }
            public override void VisitForStatement(ForStatementSyntax node)
            {
                CheckBlockStatement(node.Statement, node.GetLocation());
                base.VisitForStatement(node);
            }
            public override void VisitForEachStatement(ForEachStatementSyntax node)
            {
                CheckBlockStatement(node.Statement, node.GetLocation());
                base.VisitForEachStatement(node);
            }

            public override void VisitWhileStatement(WhileStatementSyntax node)
            {
                CheckBlockStatement(node.Statement, node.GetLocation());
                base.VisitWhileStatement(node);
            }

            private void CheckElseStatement(ElseClauseSyntax elseClause)
            {
                if (elseClause.Statement is IfStatementSyntax)
                {
                    // Skip checking if it's an "else if" statement
                    return;
                }
                CheckBlockStatement(elseClause.Statement, elseClause.GetLocation());
            }
            private void CheckBlockStatement(StatementSyntax statement, Location location)
            {
                if (statement is BlockSyntax)
                {
                    return;
                }
                var logStatements = statement.DescendantNodes()
                                             .OfType<InvocationExpressionSyntax>()
                                             .Where(inv => inv.Expression is MemberAccessExpressionSyntax memberAccess &&
                                                           (memberAccess.Name.ToString() == "Log" || memberAccess.Name.ToString() == "Debug.Log"))
                                             .ToList();
                foreach (var logStatement in logStatements)
                {
                    var lineSpan = logStatement.GetLocation().GetLineSpan();
                    Issues.Add(new Issue
                    {
                        LineNumber = lineSpan.StartLinePosition.Line + 1,
                        Message = $"Debug.Log or UnityEngine.Debug.Log found in a single-line {statement.Kind()} statement without braces."
                    });
                }
            }
        }
        public class Issue
        {
            public int LineNumber { get; set; }
            public string Message { get; set; }
        }
        static string unityRoot;
        static string logPath = "D:/tempLog.txt";
        static bool isLogToFile = true;
        static void Main(string[] args)
        {
            List<string> pathList = new List<string>();
            if (args == null || args.Length == 0)
            {
                var path = System.Environment.CurrentDirectory;
                path = path.Substring(0, path.IndexOf("tools"));
                path = path.Replace("\\", "/");
                args = new string[]
                {
                     path + "Assets/HotUpdate"
                };
            }
            unityRoot = args[0].Substring(0, args[0].IndexOf("Assets"));
            logPath = unityRoot + "tools/tempLog.txt";
            if(File.Exists(logPath))
            {
                File.Delete(logPath);
            }
            pathList.AddRange(args);
            isLogToFile = bool.Parse(pathList[pathList.Count - 1]);
            pathList.RemoveAt(pathList.Count - 1);
            List<string> allCsharpFiles = new List<string>();
            foreach(var path_item in pathList)
            {
                allCsharpFiles.AddRange(Directory.GetFiles(path_item, "*.cs", SearchOption.AllDirectories));
            }
            bool hasInsue = false;
            strList.Clear();
            foreach(var item in allCsharpFiles)
            {
                string sourceCode = File.ReadAllText(item);
                SyntaxTree tree = CSharpSyntaxTree.ParseText(sourceCode);
                CompilationUnitSyntax root = tree.GetCompilationUnitRoot();
                var diagnostics = tree.GetDiagnostics();
                if (diagnostics.Any(d => d.Severity == DiagnosticSeverity.Error))
                {
                    Log("Syntax errors found in the source code.");
                    return;
                }
                var walker = new LogStatementWalker();
                walker.Visit(root);
                foreach (var issue in walker.Issues)
                {
                    hasInsue = true;
                    var itemName = item.Substring(item.IndexOf("Assets"));
                    Log($"请使用括号封装你的日志！ at line {issue.LineNumber}: {itemName}");
                }
            }
            if(!hasInsue)
            {
                Log("未发现不规范代码");
            }
        }
        /// <summary>
        /// 检测判断if语句后面是否带花括号，由于在for循环中经常会遇到if不带花括号的情况，故这个检测暂时放弃 不然
        /// 会有非常多的代码提示 
        /// 这里的代码暂时封存 
        /// </summary>
        /// <param name="args"></param>
        static void Main2(string[] args)
        {

            if(File.Exists(logPath))
            {
                File.Delete(logPath);
            }
            File.Create(logPath).Dispose();
            string directoryPath = "D:\\qiangsheng_wx\\Assets\\HotUpdate"; // 替换为你的目录路径
            // 获取目录中的所有 .cs 文件
            string[] files = Directory.GetFiles(directoryPath, "*.cs", SearchOption.AllDirectories);
            foreach (string filePath in files)
            {
                Log($"Processing file: {filePath}");
                string code = File.ReadAllText(filePath);
                SyntaxTree tree = CSharpSyntaxTree.ParseText(code);
                var root = tree.GetRoot();
                var walker = new IfElseSyntaxWalker();
                walker.Visit(root);
            }
            Console.ReadLine();
        }
        class IfElseSyntaxWalker : CSharpSyntaxWalker
        {
            public override void VisitIfStatement(IfStatementSyntax node)
            {
                base.VisitIfStatement(node);

                // 检查 if 语句是否有花括号
                if (node.Statement is BlockSyntax) { }
                else
                {
                    var str = $"警告: if 语句 at line {node.GetLocation().GetLineSpan().StartLinePosition.Line + 1} does not use 花括号";
                    Log(str);
                }
                // 检查 else 语句是否有花括号
                if (node.Else != null)
                {
                    if (node.Else.Statement is BlockSyntax) { }
                    else
                    {
                        var str = $"警告: else 语句 at line {node.Else.GetLocation().GetLineSpan().StartLinePosition.Line + 1} does not use 花括号";
                        Log(str);
                    }
                }
            }
        }
    }
}
控制台程序做完之后还需要对接到unity项目中，我是直接将微信api的代码分析回调日志直接写入了某个文件，让unity调用这个exe文件，你可以封装成bat将参数传给exe执行，unity那边读取文件将文本内容Debug.LogError输出即可。

上诉工作做完了之后就可以提供注释和反注释的代码接口了，将下述代码封装到你的编辑器工具类中或者某个编辑器类下的对象中 

 private const string LogPattern = @"(?s)(Debug\.Log\s*\(.*?\);|UnityEngine\.Debug\.Log\s*\(.*?\);)";
    private const string unLogPattern = @"(?s)/\*(\s*Debug\.Log\s*\(.*?\);\s*|UnityEngine\.Debug\.Log\s*\(.*?\);\s*)\*/";

    public static void ForbidLog(string filePath)
    {
        
        string fileContent = File.ReadAllText(filePath,Encoding.UTF8);

     // 正则表达式匹配 Debug.Log 调用及其相关代码
     string pattern = LogPattern;
        string replacement = @"/*$1*/";

     if(!Regex.IsMatch(fileContent, pattern))
     {
         return;
     }
        string newContent = Regex.Replace(fileContent, pattern, replacement);

     using (StreamWriter writer = new StreamWriter(filePath, false, new UTF8Encoding(false)))
     {
         writer.Write(newContent);
     }
 }

    public static void UnForbidLog(string filePath)
    {
        
        string fileContent = File.ReadAllText(filePath, Encoding.UTF8);

     // 正则表达式匹配被注释的 Debug.Log 调用及其相关代码
     string pattern = unLogPattern;
        string replacement = @"$1";

     if (!Regex.IsMatch(fileContent, pattern))
     {
         return;
     }

     string newContent = Regex.Replace(fileContent, pattern, replacement);

     using (StreamWriter writer = new StreamWriter(filePath, false, new UTF8Encoding(false)))
     {
         writer.Write(newContent);
     }
     
    }
    [MenuItem("Tools/日志/注释所有日志", priority = -1999)]
 public static void ReMoveLog()
 {
     
     var listFolder = new List<string>();
     listFolder.Add(System.Environment.CurrentDirectory + "/Assets/HotUpdate");
        listFolder.Add(System.Environment.CurrentDirectory + "/Assets/SDKTool");
        listFolder.Add(System.Environment.CurrentDirectory + "/Assets/DevWork");
     var allCsharpFiles = new List<string>();    
     foreach(string folder in listFolder)
     {
         allCsharpFiles.AddRange(Directory.GetFiles(folder, "*.cs",SearchOption.AllDirectories));
     }
     string[] filters = new string[]
     {
         "InitCtrl.cs",
         "Global.cs",
         "LoginPanel.cs",
         "LoginCode.cs",
         "ProductModel.cs",
     };
     foreach(string csFile in allCsharpFiles)
     {
         var filename = Path.GetFileName(csFile);
         if(filters.Contains(filename))
         {
             Debug.Log("跳过过滤文件" + csFile);
             continue;
         }
ForbidLog(csFile);
        }
        allCsharpFiles.Clear();
        listFolder.Clear();
        listFolder = null;
        allCsharpFiles = null;
        AssetDatabase.SaveAssets();
        AssetDatabase.Refresh();
    }
    [MenuItem("Tools/日志/反注释所有日志", priority = -1999)]
    public static void UnReMoveLog()
    {
        var listFolder = new List<string>();
        listFolder.Add(System.Environment.CurrentDirectory + "/Assets/HotUpdate");
        listFolder.Add(System.Environment.CurrentDirectory + "/Assets/SDKTool");
        listFolder.Add(System.Environment.CurrentDirectory + "/Assets/DevWork");
        var allCsharpFiles = new List<string>();
        foreach (string folder in listFolder)
        {
allCsharpFiles.AddRange(Directory.GetFiles(folder, "*.cs", SearchOption.AllDirectories));
        }
        foreach (string csFile in allCsharpFiles)
        {
UnForbidLog(csFile);
        }
     allCsharpFiles.Clear();
     listFolder.Clear();
     listFolder = null;
     allCsharpFiles = null;
     AssetDatabase.SaveAssets();
        AssetDatabase.Refresh();
    }

运行截图：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2182971.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

数据结构-链表笔记

数据结构-链表笔记

移除节点 203. 移除链表元素 - 力扣&#xff08;LeetCode&#xff09; /*** Definition for singly-linked list.* public class ListNode {* int val;* ListNode next;* ListNode() {}* ListNode(int val) { this.val val; }* ListNode(int val, ListN…
阅读更多...
windows上安装mingw教程及mingw64国内下载地址汇总

windows上安装mingw教程及mingw64国内下载地址汇总

​ 首先进去官方官网地址&#xff1a;https://www.mingw-w64.org&#xff0c;注意如果下载不了或者下载慢可以使用下面提供国内下载地址&#xff0c;可以满速下载。 进入官网后&#xff0c;直接在左侧点击Downloads即可。 点击Sources选项   点击Downloads后&#xff0c;在右…
阅读更多...
qfluentwidgets组件库的配置与使用

qfluentwidgets组件库的配置与使用

文章目录 前言一、安装1 安装conda环境2 配置designer和pyuic3 查看是否成功二、简单使用前言 这篇博客用来记录qfluentwidgets组件库的基本使用。 如果你愿意花200块钱去官网github地址买一份作者的组件库，添加到了designer中了。那么本博客前面的所有配置对你都是没有用的，…
阅读更多...
Chromium 用户数据目录User Data 初始化过程c++

Chromium 用户数据目录User Data 初始化过程c++

一、先说结论 User Data 路径优先级如下&#xff1a; 1、注册表中策略配置的路径。 计算机\HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Chromium UserDataDir"xx_path" 2、命令行中的路径。 --user-data-dir"xx_path" 3、默认用户路径 %LOCALAPPDATA%/Chrom…
阅读更多...
在使用visual studio 2022，运行程序时弹窗：“ 此任务要求应用程序具有提升的权限“

在使用visual studio 2022，运行程序时弹窗：“ 此任务要求应用程序具有提升的权限“

系列文章目录 文章目录 系列文章目录前言一、问题原因二、解决方法1.第一种解决方法2.第二种解决方法 前言 在使用visual studio 2022&#xff0c;运行程序时弹窗&#xff1a;" 此任务要求应用程序具有提升的权限"&#xff0c;每次都要再次点击“使用其他凭证重新启…
阅读更多...
【LeetCode HOT 100】详细题解之二叉树篇

【LeetCode HOT 100】详细题解之二叉树篇

【LeetCode HOT 100】详细题解之二叉树篇 94 二叉树的中序遍历方法一&#xff1a;递归方法二&#xff1a;迭代 104 二叉树的最大深度方法一&#xff1a;递归方法二&#xff1a;迭代 226 翻转二叉树方法一&#xff1a;递归方法二&#xff1a;迭代 101 对称二叉树方法一&#xff…
阅读更多...
麦克斯韦方程组的独立方程与辅助方程

麦克斯韦方程组的独立方程与辅助方程

第四个方程可以由第一个方程得到。注意哈密顿算符求散度是对空间求偏导&#xff0c;也就是xyz&#xff0c;而麦克斯韦方程组中的矢量除了xyz还有t也是自变量。 方程1推出方程4&#xff08;用到求微分的换顺序&#xff09; 方程2推出方程3&#xff0c;用到电流面密度和电荷体密…
阅读更多...
python调用opencv报错“module ‘cv2‘ has no attribute ‘namedWindow‘”

python调用opencv报错“module ‘cv2‘ has no attribute ‘namedWindow‘”

之前电脑上使用pip install安装过opencv相关的python模块&#xff0c;不过后续学习opencv时主要使用OpenCVSharp在VS2022中创建项目测试。今天学习过程中突然想用python试试&#xff0c;不过运行下面代码时报错“module ‘cv2’ has no attribute namedWindow”。 import cv2c…
阅读更多...
单调队列与单调栈＜2＞——单调栈

单调队列与单调栈＜2＞——单调栈

单调栈的定义 单调递增栈 栈中元素从栈底到栈顶是递增的。 单调递减栈 栈中元素从栈底到栈顶是递减的。 单调栈的核心内容 我们从左到右遍历元素&#xff0c;构造单调栈&#xff08;从栈顶到栈底递增或减&#xff09;&#xff1a;在 i 从左往右遍历的过程中&#xff0c;我…
阅读更多...
【高频SQL基础50题】16-20

【高频SQL基础50题】16-20

day by day. 目录 1.进店却未进行过交易的顾客 2.项目员工 I 3.销售分析III 4. 判断三角形 5. 电影评分 1.进店却未进行过交易的顾客 连接题。 思路&#xff1a;根据trans表中的visit_id号在 visits表中排除&#xff0c;再将剩下的合并相同客户&#xff08;累加visit…
阅读更多...
300Kg载重履带式无人车底盘定制开发技术详解

300Kg载重履带式无人车底盘定制开发技术详解

关于300Kg载重履带式无人车底盘的定制开发技术&#xff0c;可以从以下几个方面进行详细解析&#xff1a; 一、总体设计思路 300Kg载重履带式无人车底盘的定制开发&#xff0c;旨在打造一款承载能力强、行驶稳定、适应复杂地形的无人运输平台。设计过程中需充分考虑动力系统的…
阅读更多...
【C++ 前缀和 数论】1590. 使数组和能被 P 整除|2038

【C++ 前缀和 数论】1590. 使数组和能被 P 整除|2038

本文涉及的基础知识点 C算法&#xff1a;前缀和、前缀乘积、前缀异或的原理、源码及测试用例 包括课程视频 质数、最大公约数、菲蜀定理 LeetCode 1590. 使数组和能被 P 整除 给你一个正整数数组 nums&#xff0c;请你移除 最短 子数组&#xff08;可以为 空&#xff09;&am…
阅读更多...
麒麟系统文件扩展名所表示的文件种类

麒麟系统文件扩展名所表示的文件种类

图 1 .conf 配置文件&#xff0c;如图2&#xff1b; 图 2 .Deb 安装包&#xff0c;如图3&#xff1b; 图 3 .sh 可执行程序&#xff0c;如图4&#xff1b; 图 4 .tar或者.gz 压缩包&#xff0c;如图5&#xff1b; 图 5 .bin 二进制文件&#xff0c;如图6&#xff1b; 图 6…
阅读更多...
android compose ScrollableTabRow indicator 指示器设置宽度

android compose ScrollableTabRow indicator 指示器设置宽度

.requiredWidth(30.dp) Box(modifier Modifier.background(Color.LightGray).fillMaxWidth()) {ScrollableTabRow(selectedTabIndex selectedTabIndex, // 默认选中第一个标签containerColor ColorPageBg,edgePadding 1.dp, // 内容与边缘的距离indicator { tabPositions…
阅读更多...
房地产政策持续利好，龙湖“好房子”新品观萃入市受市场认可

房地产政策持续利好，龙湖“好房子”新品观萃入市受市场认可

《港湾商业观察》王璐 经过疫情以来持续调整的房地产市场&#xff0c;外界预期&#xff0c;在政策利好效应带动下&#xff0c;行业将稳健向前。 9月26日&#xff0c;中央政治局会议对房地产的表述内容释放出极强的政策宽松信号。会议首次明确提出&#xff0c;“要促进房地产市…
阅读更多...
解决QWidget及内部控件只能放大不能缩小的问题

解决QWidget及内部控件只能放大不能缩小的问题

在设计可缩放控件的时候&#xff0c;你可能会与到这种情况&#xff1a; 缩放 控件只能放大&#xff0c;不能缩小。。。是不是很头痛&#xff1f;让我来猜猜原因&#xff1a;你是不是让子类控件的大小设置地跟父类控件大小一样大&#xff1f;没错这就是原因所在。 用上面一行替换…
阅读更多...
pdf怎么盖章不覆盖文字

pdf怎么盖章不覆盖文字

pdf怎么盖章不覆盖文字&#xff1f;在PDF上盖章而不覆盖文字&#xff0c;可以按照以下步骤操作&#xff1a; 使用福昕PDF编辑器 下载安装&#xff1a;从福昕软件官网下载并安装福昕PDF编辑器。打开文档&#xff1a;用福昕PDF编辑器打开需要盖章的PDF文档。访问图章工具&#…
阅读更多...
[网络]抓包工具介绍 tcpdump

[网络]抓包工具介绍 tcpdump

一、tcpdump tcpdump是一款基于命令行的网络抓包工具&#xff0c;可以捕获并分析传输到和从网络接口流入和流出的数据包。 1.1 安装 tcpdump 通常已经预装在大多数 Linux 发行版中。如果没有安装&#xff0c;可以使用包管理器 进行安装。例如 Ubuntu&#xff0c;可以使用以下…
阅读更多...
Ps：将画板导出到 PDF

Ps：将画板导出到 PDF

菜单&#xff1a;文件/导出/将画板导出到 PDF Export/Artboards to PDF 将画板导出到 PDF Artboards to PDF命令用于将 Photoshop 的画板导出为 PDF 文件&#xff0c;提供了多种导出选项&#xff0c;可以控制文件的压缩、是否嵌入颜色配置文件、文件命名以及页面顺序等。它适用…
阅读更多...
电力、电子、电气、电器，怎么说明白？

电力、电子、电气、电器，怎么说明白？

从学科划分的角度讲 电力、电子和电器都属于电气工程学科。电气工程一词来源于日本&#xff0c;其中的“气”来源于西方外文翻译&#xff08;西方工业之初&#xff0c;动力机械均由蒸汽轮机驱动,后来用与发电&#xff0c;故"电气"开始乏指工业动力&#xff0c;现在电…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023