写点什么

使用Roslyn构建Visual Studio扩展

2011 年 11 月 05 日

之前我们报道了 Roslyn 编译器和工作空间 API(Workspace API)。现在让我们来看下 Roslyn 的服务 API,以及我们能够如何使用它来扩展 Visual Studio。我们在本文中要查看的扩展包括代码问题报告、快速修正、代码重构、自动完成提供程序以及大纲视图。

和所有最新的 Visual Studio 扩展一样,服务 API(Service API)也是使用 MEF 注册的。这意味着开发者只需要实现特定的接口,并包含相符的 MEF 样式的属性就可以,与之前版本的 Visual Studio 相比,这项改变受到了大家的欢迎,之前我们需要使用代码签名以及 COM 注册才可以。

代码问题报告

代码问题报告(Code Issue)扩展让开发者可以编写自己的编译器警告和错误。在 CTP 版本中包含的实例为我们展示了,如何在语法树中出现字母“a”的地方显示警告。正如你在下面的图中所看到的,它很好地整合到 Visual Studio 的总体工作流程之中。

ICodeIssueProvider 接口非常简单,它只包含了 GetIssues 方法的三种重载。每种重载方法都会接受 IDocument 参数,其中包含了所有与正在处理的文件相关的信息,包括原始文本、语法树、语义模型以及指向所包含项目的反向引用。其中还包含了一个取消令牌(cancellation token),以防备 IDE 需要取消分析操作,原因可能是因为用户对某个文件进行了编辑。

三种重载方法还会接受三种语法类型中的一种: 节点(node)、令牌(token)或者琐碎内容(trivia)。大多数分析工作都是在节点级别上完成的。琐碎内容代表的是编译器不需要的信息,像空格、注释以及缺少上下文的令牌。另一方面,节点表示的内容很广泛,从最顶级的命名空间声明,一直到最小的表达式都可以表示。

当检测到错误的时候,它就会以 CodeIssue 列表的形式返回给 IDE。CodeIssue 中会包含严重等级(信息、警告还是错误)、表示错误发生位置的 Span 对象以及对错误的描述。

快速修正

代码问题报告中可能还包含一个或多个 ICodeAction 对象。这些对象让开发者可以提供自动修正的选择,就像下图所显示的这样。

创建 ICodeAction 并与 ICodeActionEdit 匹配要比创建代码问题报告困难得多。我们需要学习如何编辑语法树,并通过 IWorkstation 接口来发布所做的变更。Roslyn 站点上提供了编写快速修正的简单教程

代码重构

对代码重构的支持看起来和修正代码问题的“快速修正”功能很类似,但是它应用于文本级别。使用ICodeRefactoringProvider 的时候要提供一个文档和TextSpan 对象,并且要返回CodeRefactoring 对象。这个对象只是包含了ICodeAction 对象的集合,就像上面所讨论的CodeIssue 对象一样。

为代码重构所提供的项目模板中并没有包含可用的演示程序,但是在此我们可以使用快速修正教程中所展示的相同技术。

自动完成提供程序

ICompletionProvider 接口中仅有一个叫做 GetItems 的方法。它会接受一个 IDocument 类型的参数和一个整型的 position 参数。并返回 CompletionItem 的列表。每个 CompletionItem 都需要提供要显示的文本。开发者可能还会在其中包含图标、描述和(或)要插入的替换文本。(对于 insertionText,如何不提供的话,默认就是要显示的文本。)

尽管它不像其它提供程序那样有用,但是我们还是可以做一些有趣的操作,像构建对于一般的代码片段结构过于复杂的模板等。

大纲视图

最后一个项目模板是语法大纲视图(Syntax Outliner),这是通过 ISyntaxOutliner 接口暴露出来的。我们可以使用它在文本编辑器中创建可折叠的大纲视图,就像我们可以折叠区域、类和方法一样。接口会接受一个语法节点(Syntax node)作为参数,并要返回一个 OutliningSpan 对象列表,其中每个对象都拥有所要包含的 TextSpan、HintSpan(用于鼠标悬停时显示文本)、标题文本以及自动折叠的选项。

查看英文原文: Building Visual Studio Extensions with Roslyn

2011 年 11 月 05 日 23:391209
用户头像

发布了 340 篇内容, 共 111.3 次阅读, 收获喜欢 2 次。

关注

评论

发布
暂无评论
发现更多内容

深入剖析Netty

elfkingw

「架构师训练营」第 9 周作业 - JVM

森林

「架构师训练营」第 9 周作业 - 总结

森林

架构师训练营——第9周学习总结

jiangnanage

架构师必备的那些分布式事务解决方案!!

架构师修行之路

分布式 分布式事务 架构师

设计一个秒杀系统的挑战和问题

任小龙

JVM回收原理

李白

架构师训练营Week9总结

Frank Zeng

LeetCode题解:189. 旋转数组,环状替换,JavaScript,详细注释

Lee Chen

LeetCode 前端进阶训练营

webRTC中timing信息的使用

fumingwang

音视频 WebRTC 同步

作业 - 第9周

Happy-Coming

【架构师训练营】第 9 周总结

花生无翼

week 9 总结 JVM原理,编程优化

a晖

第9周作业

王鑫龙

Java ThreadLocal

陈皮

【个推CTO谈数据智能】之本质及技术体系要求

个推CTO 安森

数据治理 数据资产 数据智能

Week9

丿淡忘

JVM回收原理

LEAF

JVM原理

LEAF

架构师训练营week09作业

Frank Zeng

java垃圾回收原理

elfkingw

架构师训练营——第9周作业

jiangnanage

week9 作业

a晖

架构师课作业 - 第九周

Tulane

架构师训练营第九周作业

Geek_2dfa9a

架构师培训第9周习题

小蚂蚁

第九周课程总结

考尔菲德

架构师第九周

Tulane

垃圾回收算法及收集器介绍

考尔菲德

XSKY星辰天合全新发布X3DS立体数据管理系统

XSKY融合存储

Typora 完美结合 PicGo,写作体验更佳!

逆锋起笔

程序员 写作 Typora markdown 图床

2021年,算法还“香”吗?

2021年,算法还“香”吗?

使用Roslyn构建Visual Studio扩展-InfoQ