C#中Roslyn分析器开发_C#代码分析诊断教程【高级】

尼克

尼克

2026-05-14

771人浏览

原创

roslyn分析器必须在语义模型就绪后才能获取符号信息,registersemanticmodelaction是唯一安全入口;语法节点分析无法获取类型信息,且需显式判空、配置构建管道与vsix兼容性。

c#中roslyn分析器开发_c#代码分析诊断教程【高级】

Roslyn 分析器不是“写个正则找 if 里写了 null”就能上线的东西;它必须在语义就绪后才能判断类型、符号、调用链,否则 GetSymbolInfo()GetTypeInfo() 全是 null,诊断永远不触发。

RegisterSemanticModelAction 是语义分析的唯一入口

很多新手在 RegisterSyntaxNodeAction<binaryexpressionsyntax></binaryexpressionsyntax> 里直接调 semanticModel.GetSymbolInfo(node),结果始终返回 null——因为此时 SemanticModel 还没构造完成,语法节点虽已解析,但类型绑定尚未发生。

正确做法只有一处:必须用 context.RegisterSemanticModelAction() 注册回调,在该回调中才可安全使用 semanticModel

  • RegisterSyntaxNodeAction 只能做纯语法层面的事,比如检查节点结构、文本内容、是否含特定关键字
  • RegisterSemanticModelAction 才能拿到完整语义模型,进而查 ISymbolITypeSymbol、调用链、泛型实参等
  • 若需同时响应语法结构 + 语义信息(如检测某个方法调用是否传了非字符串字面量),得注册两个 action,并靠 AnalysisContext.Options 或自定义上下文缓存共享状态

获取 Symbol 时必须逐层判空,不能链式调用

semanticModel.GetSymbolInfo(expression).Symbol?.ContainingType?.SpecialType 看起来简洁,但在用户编辑中途(如刚敲完 str. 还没输方法名)会直接抛 NullReferenceException,导致整个分析器崩溃静默失效。

Roslyn 明确要求所有语义查询结果都视为可能为 null,尤其在 IDE 实时分析场景下。

C函数速查手册(CHM版)
C函数速查手册(CHM版)

C函数速查手册(CHM版)

下载
  • 必须拆解判断:var symbol = semanticModel.GetSymbolInfo(node).Symbol; → 检查 symbol != null → 再取 symbol.ContainingType → 再判空 → 最后比 SpecialType
  • 对泛型类型(如 List<string></string>),SpecialTypeNone,得改用 symbol.Type?.IsString()symbol.Type?.ToString() == "string"(后者慎用于泛型上下文)
  • C# 8+ 推荐用空合并与模式匹配组合:if (symbol is { ContainingType.SpecialType: SpecialType.System_String }),但注意这仍会触发 ContainingType 的 getter,内部可能 throw,所以最稳仍是显式判空

dotnet build 不报错?你没让分析器进编译管道

本地 VS 里灯泡亮、波浪线有,但 dotnet build 或 CI 流水线完全没警告——这是最常被忽略的部署盲点。

Roslyn 分析器默认只在 Visual Studio 设计时启用,dotnet build 默认跳过所有 analyzer,除非显式开启。

  • 必须在项目文件(.csproj)中添加:<enablenetanalyzers>true</enablenetanalyzers>
  • 若引用的是第三方 analyzer NuGet 包(如 SonarAnalyzer.CSharp),还需确认其 PrivateAssets="all" 没误锁住分析器资产
  • 旧项目(TargetFramework 小于 net5.0)需额外加 <analysismode>AllEnabledByDefault</analysismode>,否则即使启用也只跑极少数规则
  • CI 中建议加 /p:AnalysisLevel=latest 防止因 SDK 版本差异漏规则

调试时实验实例不加载你的 Analyzer?检查 VSIX 清单和目标框架

F5 启动实验实例后,测试项目里完全看不到波浪线或灯泡——大概率是 VSIX 清单没配对,或目标框架不兼容。

模板生成的 .vsixmanifest 默认声明支持 [17.0,18.0),但如果你用的是 VS 2022 17.12 或 VS 2026 预览版,版本范围不匹配就会静默禁用。

  • 打开 source.extension.vsixmanifest,检查 <installationtarget></installationtarget>Version 是否覆盖当前 VS 版本(可用 devenv /rootsuffix Exp 查实验实例版本)
  • Analyzer 项目目标框架必须是 netstandard2.0 或更高(net6.0 也可,但会限制 VS 版本兼容性);netstandard1.3 已被 VS 2022+ 拒绝加载
  • 确保 Microsoft.CodeAnalysis.CSharpMicrosoft.VisualStudio.LanguageServices 版本与当前 VS SDK 匹配;混用 4.x 和 5.x 的 Roslyn 包会导致 AssemblyLoadException

真正卡住人的从来不是“怎么写一个诊断”,而是“为什么它在某个环节突然不工作”——语义时机、判空逻辑、构建管道开关、VSIX 兼容性,四者任一出错,分析器就变成不可见的幽灵。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1105

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

2072

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1185

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

8820

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

1479

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

1552

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

881

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

531

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1111

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
RabbitMQ 教程手册
RabbitMQ 教程手册

共0课时 | 0人学习

Linux man-pages 项目
Linux man-pages 项目

共0课时 | 0人学习

C# 教程
C# 教程

共94课时 | 20.2万人学习