写点什么

使用 Roslyn 构建 Visual Studio 扩展

  • 2011-11-05
  • 本文字数:1530 字

    阅读完需:约 5 分钟

之前我们报道了 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:392199
用户头像

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

关注

评论

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

星汉未来云原生基础治理平台SchedulX V1.1.0 重磅发布,助力企业降本增效

星汉未来

运维 云原生 k8s 智能运维 星汉未来

2021金九银十最新338道大厂Java架构面试高频题目+答案详解

爱好编程进阶

Java 面试 后端开发

Alibaba内部流行的“Java突击宝典”

爱好编程进阶

Java 面试 后端开发

Docker:第七章:Docker搭建私服-本地镜像库

爱好编程进阶

Java 面试 后端开发

教你轻松解决CSRF跨站请求伪造攻击

华为云开发者联盟

CSRF 信任 攻击 跨站请求伪造 跨站

53w字!阿里首推系统性能优化指南太香了,堪称性能优化最优解

爱好编程进阶

Java 面试 后端开发

Docker镜像超详细介绍

爱好编程进阶

Java 面试 后端开发

Ceph实战(一)-分布式存储介绍与原理架构概述

爱好编程进阶

Java 面试 后端开发

有道词典Android客户端包体积优化之路

有道技术团队

andiod Groovy

企业官网有啥用?一定要搭建官方网站吗?

源字节1号

微信小程序 网站开发

一文了解全面静态代码分析

龙智—DevSecOps解决方案

perforce Helix QAC

龙智被评估为CMMI [3] 级

龙智—DevSecOps解决方案

CMMI 龙智

2020年4面美团(多线程+redis

爱好编程进阶

Java 面试 后端开发

精彩联动!OpenMLDB Pulsar Connector原理和实操

第四范式开发者社区

机器学习 数据库 特征 特征平台 连接器

2021最新最全Java基础高频面试题汇总(1W字详细解析)

爱好编程进阶

Java 面试 后端开发

2022年4月中国数据库排行榜:春风拂面春意暖,分数回升四月天

墨天轮

数据库 opengauss 国产数据库 KingBase gbase8a

机器学习算法和架构在MLOps框架下的工程实践

博文视点Broadview

解决方案| 快对讲调度系统:高效协作

anyRTC开发者

音视频 调度 实时通讯 实时消息 对讲

最佳实践 | 通过使用 Jira Service Management 改进 HR 工作流程

龙智—DevSecOps解决方案

Atlassian jsm

IDEA中Maven依赖下载失败解决方案

爱好编程进阶

Java 面试 后端开发

剖析GPU未来发展方向

Finovy Cloud

人工智能 云服务器 GPU服务器 GPU算力

星环科技基础软件产品全面落地开花,为企业数字化转型带来“星”动能

星环科技

二进制文件版本控制工具选择难?看完这篇你会找到答案

龙智—DevSecOps解决方案

perforce Helix Core

Filter 过滤器和 Listener 监听器

爱好编程进阶

Java 面试 后端开发

InfoQ 入驻快讯

Apache IoTDB

Apache IoTDB

“如何实现集中管理、灵活高效的CI/CD”在线研讨会精彩内容分享

龙智—DevSecOps解决方案

CI/CD CloudBees

36天突击腾讯终拿Offer! Redis、高并发

爱好编程进阶

Java 面试 后端开发

阿里超大规模 Flink 集群运维体系介绍

Apache Flink

大数据 flink 编程 运维 实时计算

星汉未来成为FinOps产业推进方阵共建单位

星汉未来

运维 云原生 星汉未来 FinOps

中商惠⺠交易中台架构演进:对 Apache ShardingSphere 的应⽤

SphereEx

Apache 数据库 ShardingSphere SphereEx

研讨会回放视频:如何提升Jenkins能力,使其成为真正的DevOps平台

龙智—DevSecOps解决方案

CI/CD CloudBees

使用Roslyn构建Visual Studio扩展_.NET_Jonathan Allen_InfoQ精选文章