前言

也许是国内很少有IDE开发的项目，所以在寻找特定语法服务支持的相关资料会比较少，本篇文章的目的是想记录并分享一下在.Net Core环境开发的IDE语法服务支持方案。目前暂时研究方案支持的语法服务分为两类，一类是微软Roslyn本身支持的C#和VB，这一块只需要引入Roslyn的组件调用即可，本文不重点描述。另一类是通过LSP语法服务协议的语法服务器进行支持，目前支持C#的LSP客户端选用的是Omnisharp团队提供的，下面将描述如何通过该方案实现TypeScript,JavaScript,Html,Css等语言的语法服务支持。

---

应用场景

适用于.Net Core开发的编译器，需要对各类语言的语法服务进行支持，本文主要描述.Net Core中对LSP协议语法服务器的运用。

LSP(语法服务协议)

---

一、添加Omnisharp Client组件

1.通过NuGet包管理界面安装Omnisharp.Extensions.LanguageClient组件包

二、找到需要支持的语法服务器

LSP中有提供各类语法服务的支持列表，可以在官方找到你需要的语法服务器，这里我们用html的语法服务作为示例。

下载后的源码目录大概是这样的:

1.语法服务器包还原

在语法服务器的源代码目录下，一般会有client和server，我们只需要用到server，所以在主目录下和server目录下执行包还原指令，等待正常安装完成即可。

安装失败的话根据提示判断问题所在，大部分原因是因为网络代理问题

npm install

2.编译

一般情况下项目的package.json里面会配置好整个项目的编译指令，所以直接执行

npm run build

或者可以对指令目录进行编译，打开server目录可以看到里面有个tsconfig.json的文件，这个就是TypeScript代码的编译配置文件，在这个目录下执行编译指令也可以。

tsc -b

编译完成后你就可以看到server/out/下面有你已经编译好的文件啦，这个htmlServerMain就是入口文件

3.测试一下

通过命令行使用node启动一下这个入口文件，执行指令node htmlServerMain.js --stdio，看看反应，html的语法服务器没有报错表示正在监听中，当然不同的语法服务器表现形式不一样，由他们的代码决定的。

3.Omnisharp Client连接Html Server(重点来了)

客户端准备好了，服务端也OK了，接下来就要开始连接操作了(敲黑板)。

using OmniSharp.Extensions.LanguageServer.Client; using OmniSharp.Extensions.LanguageServer.Protocol; using OmniSharp.Extensions.LanguageServer.Protocol.Client; using OmniSharp.Extensions.LanguageServer.Protocol.Document; using OmniSharp.Extensions.LanguageServer.Protocol.Models; using System; using System.Collections.Generic; using System.Diagnostics; using System.IO.Pipelines; using System.Text; using System.Threading; using System.Threading.Tasks; namespace ConsoleApp3 { public class Connect { private Process _process; public ILanguageClient Client{ get; set; } /// <summary> /// 启动Server服务器 /// </summary> public void StartupServer() { //这边路径自己补全成绝对路径， --stdio表示标准输入输出的方式启动 var args = "htmlServerMain.js --stdio"; var info = new ProcessStartInfo("node", args) { RedirectStandardInput = true, RedirectStandardOutput = true, RedirectStandardError = true, CreateNoWindow = true, UseShellExecute = false }; _process = new Process() { StartInfo = info, EnableRaisingEvents = true }; _process.Start(); } public void ClientConnect() { //设定输入输出管道流 var pipeReader = PipeReader.Create(_process.StandardOutput.BaseStream); var pipeWriter = PipeWriter.Create(_process.StandardInput.BaseStream); var clientOption = new Action<LanguageClientOptions>(option => { }); //做一些html语法服务器的基本设定 Client = LanguageClient.PreInit(options => { options.WithInput(pipeReader).WithOutput(pipeWriter); options.InitializationOptions = new { embeddedLanguages = new { css = true, javascript = true, html = true } }; clientOption(options); }); } private async Task InitiazationServerAsync(CancellationToken cancellationToken) { await Client.Initialize(cancellationToken); } /// <summary> /// 调用快速信息的语法服务示例，文件路径和光标的坐标根据实际填一下 /// response就是语法服务器给回的内容，包含信息和起始位置 /// </summary> /// <returns></returns> public async Task UseHoverServiceAsync() { var fileName = "需要语法服务支持的html文件路径"; var response = await Client.TextDocument.RequestHover( new HoverParams() { TextDocument = new TextDocumentIdentifier { Uri = DocumentUri.FromFileSystemPath(fileName) }, Position = new Position(0, 0) }) ; } } }

这个类包括了三个方法: 1.启动服务器，语法服务器的入口文件需要自己补上绝对路径. 2.连接语法服务器。 3.初始化语法服务器。 4.调用一个快速信息的服务。

顺序调用这三个方法，Client这个对象就可以直接使用啦，然后调用快速信息的语法服务，可以接收到服务器返回的结果。其他语法服务实现原理是一样的，直接看Client.TextDocument里面的请求方法内容，不过前提是语法服务器支持的服务才有相应，否则提示服务不支持。

总结

通过这种方法可以实现LSP上支持的所有语法服务，编译器最核心的支持功能之一，当然对于某些特定的语言有更加优秀的解决方案，但是这种方法只需要实现一套流程，剩下的只需要对接语法服务器即可。

网络上目前很多都只有对LSP原理进行阐述，但是具体的实现在.Net Core平台还没有看到，这个东西当时研究了挺久的流程，这边就简单讲流程方法写下来给有需要的人参考，毕竟做这一方面的还是比较少数，在这个过程中会有很多细节的问题，由于环境之类的因素影响，但是总体的流程已经全部描述清楚了，如果有问题的话请给作者留言，可以分享一些开发中的经验，可能可以帮助你解决问题。

本文原创，如需转载请附上链接。