随着团队愈来愈多,愈来愈大,需求更迭愈来愈快,天天提交的代码变动由原先的2位数,暴涨到3位数,天天几百次代码Check In,补丁提交,大量的代码审查消耗了大量的资源投入。express
如何确保提交代码的质量和提测产品的质量,这两个是很是大的挑战。编程
工欲善其事,必先利其器。在上述需求背景下,今年咱们准备用工具和技术,全面把控并提高代码质量和产品提测质量。即:api
1. 代码质量提高:经过自定义代码扫描规则,将有问题的代码、不符合编码规则的代码扫描出来,禁止签入数据结构
2. 产品提测质量:经过单元测试覆盖率和执行经过率,严控产品提交质量,覆盖率和经过率达不到标准,没法提交测试。async
准备用2篇文章,和你们分享咱们是如何提高代码质量和产品提测质量的。今天分享第一篇:经过Roslyn代码分析全面提高代码质量。ide
1、什么是Roslyn工具
Roslyn 是微软开源的 .NET 编译平台(.NET Compiler Platform)。 编译平台支持 C# 和 Visual Basic 代码编译,并提供丰富的代码分析 API。oop
利用Roslyn能够生成代码分析器和代码修补程序,从而发现和更正编码错误。 性能
分析器不只理解代码的语法和结构,还能检测应更正的作法。 代码修补程序建议一处或多处修复,以修复分析器发现的编码错误。单元测试
咱们写下面一堆代码,Roslyn编译器会有以下提示:
经过编写分析器和代码修补程序,主要服务如下场景:
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作一些“不符合编程规范要求(团队自定义的)”的代码分析。
2、基于Roslyn进行代码分析
接下来说经过Show case的方法,经过实际的场景和你们分享。在咱们编写实际的代码分析器以前,咱们先把开发环境准备好 :
使用VS2017建立一个Analyzer with Code Fix工程
由于我本机的VS2019找了很久没找到对应的工程,这个章节,使用VS2017吧
建立完成会有两个工程:
其中,TeldCodeAnalyzer.Vsix工程,主要用以生成VSIX扩展文件
TeldCodeAnalyzer工程,主要用于编写代码分析器。
工程转换好以后,咱们开始编码吧。
1. catch 吞掉异常场景
问题:catch吞掉异常后,线上很难排查问题,同时肯定哪块代码有问题
示例代码:
try { var logService = HSFService.Proxy<ILogService>(); logService.SendMsg(new SysActionLog()); } catch (Exception ex) { }
需求:当开发人员在catch吞掉异常时,给与编程提示:异常吞掉时必须上报监控或者日志
明确了上述须要,咱们开始编写Roslyn代码分析器。ExceptionCatchWithMonitorAnalyzer
咱们详细解读一下:
① ExceptionCatchWithMonitorAnalyzer必须继承抽象类DiagnosticAnalyzer
② 重写方法SupportedDiagnostics,注册代码扫描规则:DiagnosticDescriptor
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
public override void Initialize(AnalysisContext context) { context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.Analyze | GeneratedCodeAnalysisFlags.None); context.EnableConcurrentExecution(); context.RegisterSyntaxNodeAction(AnalyzeDeclaration, SyntaxKind.CatchClause); }
④ 实现语法分析AnalyzeDeclaration,检查对catch语句中代码实现
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。你们能够根据本身的须要写一下。
实际的效果:
还有几个代码检查场景,基本都是一样的实现思路,再次不一一罗列了。
在这里还能够自动完成代理修补程序,这个地方咱们还在研究中,可能每一个业务代码的场景不一样,很难给出一个通用的改进代码,因此这个地方等后续咱们完成后,再和你们分享。
3、经过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代码分析全面提高代码质量的一些具体实践,分享给你们。
周国庆
2020/5/2