【Unity】使用代码分析（Roslyn Analyzers）实现自动代码审查（Code Review）

神码编程

已于 2024-04-29 18:31:10 修改

阅读量3.3k

点赞数 13

于 2024-04-29 18:27:08 首次发布

本文链接：https://blog.csdn.net/qq992817263/article/details/138311483

版权

Unity 同时被 3 个专栏收录

170 篇文章

订阅专栏

Unity Editor Develop

101 篇文章

订阅专栏

Unity HTFramework

66 篇文章

订阅专栏

本文介绍了如何使用RoslynAnalyzers在Unity开发环境中实现自动代码审查，包括公共和私有权限字段命名规则、代码优化建议、避免直接继承MonoBehaviour等，并展示了如何编写一个基础的类名长度检查分析器。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Roslyn Analyzers

Roslyn Analyzers是.NET编译平台的代码分析程序，用以检查 C# 或 Visual Basic 代码的样式、质量、可维护性、设计及其他问题。

Code Review

虽然人工Code Review能检查出100%（取决于Reviewer的水平）的代码问题，但很多简单明了的设计或性能上的优化改进意见，我们依然想要它在程序员编码时便实时提醒出来，所以我们需要自动Code Review。

自动 Code Review 案例

例如，目前我们的自动Code Review系统包含但不仅限于如下这些案例：

1.public、internal权限的字段建议以大写字母开头。

ID：D0001
类型：Design（设计改进意见）
级别：警告（不影响程序执行）
在这里插入图片描述

2.private、protected权限的字段建议以下划线+小写字母开头。

ID：D0002
类型：Design（设计改进意见）
级别：警告（不影响程序执行）
在这里插入图片描述

3.不建议直接继承 MonoBehaviour，建议继承至 HTBehaviour。

ID：D0007
类型：Design（设计改进意见）
级别：警告（不影响程序执行）
在这里插入图片描述

4.不建议使用 Input 判断输入或获取鼠标位置，建议使用 Main.m_Input 替代。

ID：O0001
类型：Optimize（代码优化意见）
级别：警告（不影响程序执行）
在这里插入图片描述

5.不建议在 Update、FixedUpdate、OnUpdateFrame 等帧执行方法中调用 GetComponent 方法，建议将组件缓存。

ID：O0002
类型：Optimize（代码优化意见）
级别：警告（不影响程序执行）
在这里插入图片描述

6.多个字符串串联（3个或以上）建议使用【$语法】或【string.Format】或【StringBuilder】替代。

ID：O0003
类型：Optimize（代码优化意见）
级别：警告（不影响程序执行）
在这里插入图片描述

7.float类型不建议使用 == 判断相等，建议使用 Mathf.Approximately 判断约等。

ID：O0004
类型：Optimize（代码优化意见）
级别：警告（不影响程序执行）
在这里插入图片描述

8.类必须添加XML文档注释。

ID：F0001
类型：Force（强制规范）
级别：错误（编译级错误，影响程序执行）
在这里插入图片描述

9.public、internal权限的方法必须添加XML文档注释。

ID：F0002
类型：Force（强制规范）
级别：错误（编译级错误，影响程序执行）
在这里插入图片描述

反馈至Unity编辑器

自动Code Review会以其对应的级别（警告还是错误）同步反馈至Unity编辑器的Console窗口，如果是错误级别，则编辑器将无法播放，必须解决掉该优化改进意见。
在这里插入图片描述

实现步骤

开发环境

Visual Studio 2022（社区版）
Unity 2022.3.17

一、新建VS工程

新建一个VS工程，模板为类库（且为面向.NET Standard，以兼容Unity），工程名称为CodeReview：
在这里插入图片描述

二、管理NuGet程序包

鼠标右击解决方案，选择管理NuGet程序包：
在这里插入图片描述

三、安装Microsoft.CodeAnalysis.CSharp包

搜索并安装Microsoft.CodeAnalysis.CSharp包，3.8.0版本（Unity官方文档要求为该版本）：
在这里插入图片描述

四、编写分析器程序

1.新建类DiagnosticAnalyzer01

新建类DiagnosticAnalyzer01，继承至DiagnosticAnalyzer：

namespace CodeReview
{
    public class DiagnosticAnalyzer01 : DiagnosticAnalyzer
    {
        
    }
}

2.实现抽象方法

实现该类的抽象方法：（该类将用于实现一个检测类名不能过短的分析器）

namespace CodeReview
{
    /// <summary>
    /// T001:类名定义不能过短。
    /// </summary>
    [DiagnosticAnalyzer(LanguageNames.CSharp)]
    public class DiagnosticAnalyzer01 : DiagnosticAnalyzer
    {
        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => throw new NotImplementedException();

        public override void Initialize(AnalysisContext context)
        {
            context.EnableConcurrentExecution();
            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
            //注册类定义语法回调
            context.RegisterSyntaxNodeAction(OnSyntaxNodeAction, SyntaxKind.ClassDeclaration);
        }

		//当任意类定义语法编译时，将回调此方法
        private void OnSyntaxNodeAction(SyntaxNodeAnalysisContext context)
        {
           
        }
    }
}

3.编写分析器代码

接下来就是在回调方法中编写分析器代码：

namespace CodeReview
{
    /// <summary>
    /// T001:类名定义不能过短。
    /// </summary>
    [DiagnosticAnalyzer(LanguageNames.CSharp)]
    public class DiagnosticAnalyzer01 : DiagnosticAnalyzer
    {
        public DiagnosticDescriptor Rule
        {
            get
            {
                if (_descriptor == null)
                {
                    _descriptor = new DiagnosticDescriptor(
                    "T001",
                    "类名定义不能过短。",
                    "类名定义不能过短。",
                    "Test",
                    DiagnosticSeverity.Error,
                    true);
                }
                return _descriptor;
            }
        }
        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

        private DiagnosticDescriptor _descriptor;

        public override void Initialize(AnalysisContext context)
        {
            context.EnableConcurrentExecution();
            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.ReportDiagnostics);
            context.RegisterSyntaxNodeAction(OnSyntaxNodeAction, SyntaxKind.ClassDeclaration);
        }

        private void OnSyntaxNodeAction(SyntaxNodeAnalysisContext context)
        {
            ClassDeclarationSyntax classDeclaration = (ClassDeclarationSyntax)context.Node;
            //发现类名过短
            if (classDeclaration.Identifier.ToString().Length <= 3)
            {
                //上报分析器
                context.ReportDiagnostic(Diagnostic.Create(Rule, classDeclaration.Identifier.GetLocation()));
            }
        }
    }
}