.NET Core技术研究-通过Roslyn代码分析技术规范提升代码质量

随着团队越来越多，越来越大，需求更迭越来越快，每天提交的代码变更由原先的2位数，暴涨到3位数，每天几百次代码Check In，补丁提交，大量的代码审查消耗了大量的资源投入。

如何确保提交代码的质量和提测产品的质量，这两个是非常大的挑战。

工欲善其事，必先利其器。在上述需求背景下，今年我们准备用工具和技术，全面把控并提升代码质量和产品提测质量。即：

1. 代码质量提升：通过自定义代码扫描规则，将有问题的代码、不符合编码规则的代码扫描出来，禁止签入

2. 产品提测质量：通过单元测试覆盖率和执行通过率，严控产品提交质量，覆盖率和通过率达不到标准，无法提交测试。

准备用2篇文章，和大家分享我们是如何提升代码质量和产品提测质量的。今天分享第一篇：通过Roslyn代码分析全面提升代码质量。

一、什么是Roslyn

  Roslyn 是微软开源的 .NET 编译平台(.NET Compiler Platform)。  编译平台支持 C# 和 Visual Basic 代码编译，并提供丰富的代码分析 API。

  利用Roslyn可以生成代码分析器和代码修补程序，从而发现和更正编码错误。 

  分析器不仅理解代码的语法和结构，还能检测应更正的做法。代码修补程序建议一处或多处修复，以修复分析器发现的编码错误。

  我们写下面一堆代码，Roslyn编译器会有如下提示： 

  

 通过编写分析器和代码修补程序，主要服务以下场景：  

  • 强制执行团队编码标准（Local）

  • 提供库包方面的指导约束（Nuget）

  • 提供代码分析器相关的VSIX扩展插件（Visual Studio Marketplace）

 Roslyn是如何做到代码分析的呢？这背后依赖于一套强大的语法分析和API：

 

  上图中：Language Service：语言层面的服务，可以简单理解为我们在VS中编码时,可以实现的语法高亮、查找所有引用、重命名、转到定义、格式化、抽取方法等操作

  Compiler API：编译器API，这里提供了Syntax Tree API代码语法树API，Symbol API代码符号API

  Binding and Flow Anllysis APIs绑定和流分析API（https://joshvarty.com/2015/02/05/learn-roslyn-now-part-8-data-flow-analysis/），

  Emit API编译反射发出API（https://joshvarty.com/2016/01/16/learn-roslyn-now-part-16-the-emit-api/）

  这里我们详细看一下语法树、符号、语义模型、工作区：

  1. 语法树是一种由编译器 API 公开的基础数据结构。 这些树表示源代码的词法和语法结构。其包含：  

  • 语法节点：是语法树的一个主要元素。这些节点表示声明、语句、子句和表达式等语法构造。

  • 语法标记：表示代码的最小语法片段。语法标记包含关键字、标识符、文本和标点。

  • 琐碎内容：对正常理解代码基本上没有意义的源文本部分，例如空格、注释和预处理器指令。

  • 范围：每个节点、标记或琐碎内容在源文本内的位置和包含的字符数。

  • 种类：标识节点、标记或琐碎内容所表示的确切语法元素。

  • 错误：表示源文本中包含的语法错误。

     看一张语法树的图：

  

  2. 符号：符号表示源代码声明的不同元素，或作为元数据从程序集中导出。每个命名空间、类型、方法、属性、字段、事件、参数或局部变量都由符号表示。

  3. 语义模型：语义模型表示单个源文件的所有语义信息。可使用语义模型查找到以下内容：   

  • 在源中特定位置引用的符号。

  • 任何表达式的结果类型。

  • 所有诊断（错误和警告）。

  • 变量流入和流出源区域的方式。

  • 更多推理问题的答案。

  4. 工作区：工作区是对整个解决方案执行代码分析和重构的起点。相关的API可以实现：

     将解决方案中项目的全部相关信息组织为单个对象模型，可让用户直接访问编译器层对象模型（如源文本、语法树、语义模型和编译），而无需分析文件、配置选项，或管理项目内依赖项。

   

  了解了Roslyn的大致情况之后，我们开始基于Roslyn做一些“不符合编程规范要求（团队自定义的）”的代码分析。

二、基于Roslyn进行代码分析

  接下来讲通过Show case的方法，通过实际的场景和大家分享。在我们编写实际的代码分析器之前，我们先把开发环境准备好  ：

    使用VS2017创建一个Analyzer with Code Fix工程

    因为我本机的VS2019找了好久没找到对应的工程，这个章节，使用VS2017吧

    创建完成会有两个工程：

    

    其中，TeldCodeAnalyzer.Vsix工程，主要用以生成VSIX扩展文件

   TeldCodeAnalyzer工程，主要用于编写代码分析器。

    工程转换好之后，我们开始编码吧。

 1. catch 吞掉异常场景

  问题：catch吞掉异常后，线上很难排查问题，同时确定哪块代码有问题

  示例代码：

1

2

3

4

5

6

7

8

9

try

{

     var logService = HSFService.Proxy<ILogService>();

     logService.SendMsg(new SysActionLog());

}

catch (Exception ex)

{

                 

}

  需求：当开发人员在catch吞掉异常时，给与编程提示：异常吞掉时必须上报监控或者日志

  明确了上述需要，我们开始编写Roslyn代码分析器。ExceptionCatchWithMonitorAnalyzer

  

  我们详细解读一下：

  ① ExceptionCatchWithMonitorAnalyzer必须继承抽象类DiagnosticAnalyzer

  ② 重写方法SupportedDiagnostics，注册代码扫描规则：DiagnosticDescriptor    

1

2

3

4

internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category,

            DiagnosticSeverity.Warning, isEnabledByDefault: true, description: Description);

 

public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

　③ 重写方法Initialize，注册Microsoft.CodeAnalysis.SyntaxNode完成Catch语句的语义分析后的事件Action

1

2

3

4

5

public override void Initialize(AnalysisContext context)

{           context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.None);

            context.EnableConcurrentExecution();

            context.RegisterSyntaxNodeAction(AnalyzeDeclaration, SyntaxKind.CatchClause);

}

　④ 实现语法分析AnalyzeDeclaration，检查对catch语句中代码实现   

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

private void AnalyzeDeclaration(SyntaxNodeAnalysisContext context)

{

            var catchClause = (CatchClauseSyntax)context.Node;

            var block = catchClause.Block;

            foreach (var statement in block.Statements)

            {

                if (statement is ThrowStatementSyntax)

                {

                    return;

                }

            }

 

 

            if (Common.IsReallyContains(block, "MonitorClient") == false)

            {

                context.ReportDiagnostic(Diagnostic.Create(Rule, block.GetLocation()));

            }

}

　　代码实现后的效果（直接调试VSIX工程即可）

  

代码编译后也有对应Warnning提示

 2. 在For循环中进行服务调用

  问题：for循环中调用RPC服务，每次访问都会发起一次RPC请求，如果循环次数太多，性能很差，建议使用批量处理的RPC方法

  示例代码：


foreach (var item in items)

{

      var logService = HSFService.Proxy<ILogService>();

      logService.SendMsg(new SysActionLog());

}　　

  需求：当开发人员在For循环中调用HSF服务时，给与编程提示：不建议在循环中调用HSF服务, 建议调用批量处理方法.

  明确了上述需要，我们开始编写Roslyn代码分析器。HSFForLoopAnalyzer  


[DiagnosticAnalyzer(LanguageNames.CSharp)]

public sealed class HSFForLoopAnalyzer : DiagnosticAnalyzer

{

    public const string DiagnosticId = "TA001";

    internal const string Title = "增加循环中HSF服务调用检查";

    public const string MessageFormat = "不建议在循环中调用HSF服务, 建议调用批量处理方法.";

    internal const string Category = "CodeSmell";

 

    internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category,

        DiagnosticSeverity.Warning, isEnabledByDefault: true);

 

    public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);

 

    public override void Initialize(AnalysisContext context)

    {

        context.RegisterSyntaxNodeAction(AnalyzeMethodForLoop, SyntaxKind.InvocationExpression);

    }

 

    private static void AnalyzeMethodForLoop(SyntaxNodeAnalysisContext context)

    {

        var expression = (InvocationExpressionSyntax)context.Node;

        string exressionText = expression.ToString();

        if (Common.IsReallyContains(expression, "HSFService.Proxy<"))

        {

            var loop = expression.Ancestors().FirstOrDefault(p => p is ForStatementSyntax || p is ForEachStatementSyntax || p is DoStatementSyntax || p is WhileStatementSyntax);

            if (loop != null)

            {

                var diagnostic = Diagnostic.Create(Rule, expression.GetLocation());

                context.ReportDiagnostic(diagnostic);

                return;

            }

 

            if (Common.IsReallyContains(expression, ">.") == false)

            {

                var syntax = expression.Ancestors().FirstOrDefault(p => p is LocalDeclarationStatementSyntax);

                if (syntax != null)

                {

                    var declaration = (LocalDeclarationStatementSyntax)syntax;

                    var variable = declaration.Declaration.Variables.SingleOrDefault();

                   

 

                    var method = declaration.Ancestors().First(p => p is MethodDeclarationSyntax);

                    var expresses = method.DescendantNodes().Where(p => p is InvocationExpressionSyntax);

                    foreach (var express in expresses)

                    {

                        loop = express.Ancestors().FirstOrDefault(p => p is ForStatementSyntax || p is ForEachStatementSyntax || p is DoStatementSyntax || p is WhileStatementSyntax);

                        if (loop != null)

                        {

                            var diagnostic = Diagnostic.Create(Rule, expression.GetLocation());

                            context.ReportDiagnostic(diagnostic);

                            return;

                        }

                    }

                }

            }

        }

    }

}

　　基本的实现方式，和上一个差不多，唯一不同的逻辑是在实际的代码分析过程中，AnalyzeMethodForLoop。大家可以根据自己的需要写一下。

       实际的效果：

       

       还有几个代码检查场景，基本都是同样的实现思路，再次不一一罗列了。

       在这里还可以自动完成代理修补程序，这个地方我们还在研究中，可能每个业务代码的场景不同，很难给出一个通用的改进代码，所以这个地方等后续我们完成后，再和大家分享。

三、通过Roslyn实现静态代码扫描

  线上很多代码已经写完了，发布上线了，对已有的代码进行代码扫描也是非常重要的。因此，我们对catch吞掉异常的代码进行了一次集中扫描和改进。

  那么基于Roslyn如何实现静态代码扫描呢？主要的步骤有：

  ① 创建一个编译工作区MSBuildWorkspace.Create()

  ② 打开解决方案文件OpenSolutionAsync(slnPath);  

  ③ 遍历Project中的Document

  ④ 拿到代码语法树、找到Catch语句CatchClauseSyntax

  ⑤ 判断是否有throw语句，如果没有，收集数据进行通知改进

  看一下具体代码实现：

  先看一下Nuget引用：

  Microsoft.CodeAnalysis

  Microsoft.CodeAnalysis.Workspaces.MSBuild

  

  代码的具体实现：

      


public async Task<List<CodeCheckResult>> CheckSln(string slnPath)

       {

           var slnFile = new FileInfo(slnPath);

           var results = new List<CodeCheckResult>();         

           var solution = await MSBuildWorkspace.Create().OpenSolutionAsync(slnPath);           

 

           if (solution.Projects != null && solution.Projects.Count() > 0)

           {

               foreach (var project in solution.Projects.ToList())

               {

                   var documents = project.Documents.Where(x => x.Name.Contains(".cs"));

 

                   foreach (var document in documents)

                   {

                       var tree = await document.GetSyntaxTreeAsync();

                       var root = tree.GetCompilationUnitRoot();

                       if (root.Members == null || root.Members.Count == 0) continue;

                       //member

                       var firstmember = root.Members[0];

                       //命名空间Namespace

                       var namespaceDeclaration = (NamespaceDeclarationSyntax)firstmember;

 

                       foreach (var classDeclare in namespaceDeclaration.Members)

                       {

                           var programDeclaration = classDeclare as ClassDeclarationSyntax;

 

                           foreach (var method in programDeclaration.Members)

                           {

 

                               //方法 Method

                               var methodDeclaration = (MethodDeclarationSyntax)method;

 

                               var catchNode = methodDeclaration.DescendantNodes().FirstOrDefault(i => i is CatchClauseSyntax);

                               if (catchNode != null)

                               {

                                   var catchClause = catchNode as CatchClauseSyntax;

                                   if (catchClause != null || catchClause.Declaration != null)

                                   {

                                       if (catchClause.DescendantNodes().OfType<ThrowStatementSyntax>().Count() == 0)

                                       {

                                           results.Add(new CodeCheckResult()

                                           {

                                               Sln = slnFile.Name,

                                               ProjectName = project.Name,

                                               ClassName = programDeclaration.Identifier.Text,

                                               MethodName = methodDeclaration.Identifier.Text,

                                           });

                                       }

                                   }

                               }

                           }

                       }

                   }

               }

           }

 

           return results;

       }　　

     以上是通过Roslyn代码分析全面提升代码质量的一些具体实践，分享给大家。

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

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

相关文章

FATE HDU - 2159（二维完全背包）

FATE HDU - 2159（二维完全背包）

限制条件&#xff1a; 1.忍耐度 m 2.杀怪个数 s 构造&#xff1a; dp[m][s] 得到的经验值 Time limit 1000 ms Memory limit 32768 kB OS Windows Source 2008信息工程学院集训队——选拔赛 最近xhd正在玩一款叫做FATE的游戏&#xff0c;为了…
阅读更多...
mysql数据库check命令_利用mysqlcheck命令快速修复mysql数据库

mysql数据库check命令_利用mysqlcheck命令快速修复mysql数据库

表索引异常,修复msql表索引(表引擎:myisam)myisamchk --safe-recover /usr/local/mysql/data/ename_news/dede_arccacherepair table customerquestion;Error infos: Table ./ename_news/dede_arccache is marked as crashed and should be repairedmyisamchk -r data/ename_ne…
阅读更多...
python中类变量的访问方式_在Python中，如何访问类方法中的“静态”类变量

python中类变量的访问方式_在Python中，如何访问类方法中的“静态”类变量

就像所有的好例子一样&#xff0c;你简化了你实际想要做的事情。这很好&#xff0c;但值得注意的是&#xff0c;python在类和实例变量方面有很大的灵活性。方法也是如此。为了获得很好的可能性&#xff0c;我建议阅读Michael Ftsch new-style classes introduction&#xff0c;…
阅读更多...
[PAT乙级]1009 说反话

[PAT乙级]1009 说反话

给定一句英语&#xff0c;要求你编写程序&#xff0c;将句中所有单词的顺序颠倒输出。 输入格式&#xff1a; 测试输入包含一个测试用例&#xff0c;在一行内给出总长度不超过 80 的字符串。字符串由若干单词和若干空格组成&#xff0c;其中单词是由英文字母&#xff08;大小写…
阅读更多...
Cheapest Palindrome POJ - 3280（动态规划*）

Cheapest Palindrome POJ - 3280（动态规划*）

题意&#xff1a; 给出一个字符串&#xff0c;要求将其修改成一个回文字符串&#xff0c;给出修改某种字母&#xff08;添加或删除&#xff09;的价值&#xff0c;求最小使其成为回文字符串的价值。 题解&#xff1a; 感觉是求最长回文子序列的变形&#xff0c;然而刚开始想着…
阅读更多...
Blazor Blazor Blazor

Blazor Blazor Blazor

Blazor 项目现在可以说是整个 .NET 社区最火的项目&#xff0c;但是它的起源却非常有趣&#xff0c;也可以说是见证了 .NET 社区的发展。2017年4月&#xff0c;一位英国光头小哥哥开始思考在 WebAssembly 下运行 .NET 的方法&#xff0c;这时他碰巧发现一个之前从未见过的 .NET…
阅读更多...
C++函数模板机制结论

C++函数模板机制结论

函数模板机制结论: 编译器并不是把函数模板处理成能够处理任何类型的函数函数模板通过具体类型产生不同的函数编译器会对函数模板进行两次编译&#xff0c;在声明的地方对模板代码本身进行编译&#xff0c;在调用的地方对参数替换后的代码进行编译。
阅读更多...
python最大堆heapq_Python-堆的实现与heapq(最小堆库函数)

python最大堆heapq_Python-堆的实现与heapq(最小堆库函数)

目录简介堆是一个二叉树&#xff0c;它的每个父节点的值都只会小于或大于所有孩子节点(的值)。它使用了数组来实现&#xff1a;从零开始计数&#xff0c;对于所有的 k &#xff0c;都有 heap[k] < heap[2*k1] 和 heap[k] < heap[2*k2]。 为了便于比较&#xff0c;不存在的…
阅读更多...
深入浅出 ASP.NET Core 与 Docker 入门课程说明

深入浅出 ASP.NET Core 与 Docker 入门课程说明

点击蓝字“角落的白板报”关注我哟加个“星标★”&#xff0c;好文必达&#xff01;深入浅出 ASP.NET Core 与 Docker 入门课程说明《深入浅出 ASP.NET Core 与 Docker 》是一门新的课程&#xff0c;本课程所有的内容全部免费&#xff0c;以图文配合视频的形式呈现。课程完整视…
阅读更多...
UVA10129 Play on Words （并查集判连通+欧拉回路）

UVA10129 Play on Words （并查集判连通+欧拉回路）

题目解析&#xff1a; 输入一些英文单词&#xff0c;根据该单词的首尾字母&#xff0c;判断所有单词能不能连成一串&#xff0c; 类似于成语接龙的意思。同样如果有多个重复的单词时&#xff0c;也必须满足这样的条件才能通过&#xff0c; 否则都是不可能的情况。输入包括若干…
阅读更多...
[PAT乙级]1010 一元多项式求导

[PAT乙级]1010 一元多项式求导

设计函数求一元多项式的导数。&#xff08;注&#xff1a;x​n​​&#xff08;n为整数&#xff09;的一阶导数为nx​n−1​​。&#xff09; 输入格式: 以指数递降方式输入多项式非零项系数和指数&#xff08;绝对值均为不超过 1000 的整数&#xff09;。数字间以空格分隔。 …
阅读更多...
python注入进程_向进程中注入Python代码

python注入进程_向进程中注入Python代码

我想把Python代码注入到一个进程中&#xff0c;当它注入时&#xff0c;它似乎会使我的进程崩溃。我没有在我自己的程序中得到任何错误&#xff0c;但目标进程停止工作。被调用的非托管api没有给我任何错误&#xff0c;并且似乎已经正确地执行了它们的执行。在[DllImport("…
阅读更多...
微软将在新西兰建设其第一个数据中心区域

微软将在新西兰建设其第一个数据中心区域

昨天新西兰各IT群都被一条消息刷屏了&#xff1a;详情可见&#xff1a;https://news.microsoft.com/en-nz/2020/05/06/aotearoa-disclosure/NZ的第一个Azure region region 是云计算的一个术语&#xff0c;也就是各大云运营商机房部署的位置。目前微软、亚马逊、谷歌等比较大的…
阅读更多...
Sorting It All Out （易错题+拓扑排序+有向图（判环+判有序）优先级）

Sorting It All Out （易错题+拓扑排序+有向图（判环+判有序）优先级）

这道题目考察了拓扑排序的基本思想&#xff1a;每一步寻找一个入度为0的结点&#xff0c;然后 删除之。将这个结点指向的结点入度减1。删除从这个结点出发的所有边 同时考察了对于一个有向图是否有环、是否严格有序的判断。&#xff08;当发现多个结点的度 为0时&#xff0c;则…
阅读更多...
[PAT乙级]1011 A+B 和 C

[PAT乙级]1011 A+B 和 C

给定区间 [−2​31​​,2​31​​] 内的 3 个整数 A、B 和 C&#xff0c;请判断 AB 是否大于 C。 输入格式&#xff1a; 输入第 1 行给出正整数 T (≤10)&#xff0c;是测试用例的个数。随后给出 T 组测试用例&#xff0c;每组占一行&#xff0c;顺序给出 A、B 和 C。整数间以…
阅读更多...
用python输出12和8的最大公_重点汇总-python常见问题1

用python输出12和8的最大公_重点汇总-python常见问题1

1. 简述函数式编程解释一&#xff1a; 在函数式编程中&#xff0c;函数是基本单位&#xff0c;变量只是一个名称&#xff0c;而不是一个存储单元。除了匿名函数外&#xff0c;Python还使fliter(),map(),reduce(),apply()函数来支持函数式编程。解释二&#xff1a; 廖---函数是P…
阅读更多...
A Simple Problem with Integers POJ - 3468（线段树+区间查询+区间修改+建树+懒惰标记模板）+（树状数组）

A Simple Problem with Integers POJ - 3468（线段树+区间查询+区间修改+建树+懒惰标记模板）+（树状数组）

题意&#xff1a; 有一个数组&#xff0c;有两种操作。1: Q a b 求[a,b]的和 2&#xff1a;C a b c 给[a,b] 的所有元素都加上c。 题目&#xff1a; You have N integers, A1, A2, ... , AN. You need to deal with two kinds of operations. One type of operation is to a…
阅读更多...
使用 kind 快速搭建一个 Kubernetes 测试环境

使用 kind 快速搭建一个 Kubernetes 测试环境

使用 kind 快速搭建一个 Kubernetes 测试环境Introkind&#xff08;Kubernetes IN Docker&#xff09; 是一个基于 docker 构建 Kubernetes 集群的工具&#xff0c;非常适合用来在本地搭建基于 Kubernetes 的开发/测试环境。想写一篇 kind 的文章很久了&#xff0c;但是之前的 …
阅读更多...
[PAT乙级]1013 数素数

[PAT乙级]1013 数素数

令 P​i​​ 表示第 i 个素数。现任给两个正整数 M≤N≤10​4​​&#xff0c;请输出 P​M​​ 到 P​N​​ 的所有素数。 输入格式&#xff1a; 输入在一行中给出 M 和 N&#xff0c;其间以空格分隔。 输出格式&#xff1a; 输出从 P​M​​ 到 P​N​​ 的所有素数&#xf…
阅读更多...
D. 关灯问题（规律或二分）

D. 关灯问题（规律或二分）

题目描述 今年就这么结束了, zdw感到十分失望 蓝桥杯写错签到题, cf rating狂掉, 最后区域赛打铜, 还突然变成JBer了 失落的zdw准备睡觉(真咸鱼), 他想关灯, 然而发现开关坏了 zdw愤怒地敲击着开关, 然后发现一个很神奇的事情: 如果灯之前已经关过了xx次, 那么下一次打开它…
阅读更多...
最新文章

Copyright @ 2022~2023