为 Sora Editor 对接 LSP - 一剪沐橙の小窝

什么是 LSP (Language Server Protocol)?#

语言服务器协议 (Language Server Protocol 即 LSP) 定义了编辑器或 IDE 与语言服务器之间使用的协议，该语言服务器提供自动完成、跳转到定义、查找所有引用等语言功能。语言服务器索引格式 (LSIF，发音类似“else if”) 的目标是在开发工具或 Web UI 中支持丰富的代码导航，而无需源代码的本地副本。

更多信息详见：Language Server Protocol

说人话就是一个标准协议，实现了客户端（IDE）的代码自动补全，引用跳转等智能功能。

为什么要使用 LSP?#

首先，一个所谓的真正的 IDE，不能仅仅有基础的代码补全（关键字补全，常用函数补全等），还需要有智能补全。智能补全即实现了跳转到定义，上下文推断补全等。

实现上述步骤并不是只有 LSP 才能做到，有人说我可以自己使用现成的 Parser，对每个文件进行语法分析。然后自己写一套上下文补全。这确实可以，但是很费时间。

LSP 有着开箱即用的特点：无需关注其内部实现，而 IDE 只需要根据它定义的标准进行通信，即可实现目的。

其次，LSP 的产生也是为了解决协议不一致问题。在 LSP 出现以前，每个 IDE 的补全核心实现都不一致。我的 IDE 中转到定义可能是需要十个参数，你的可能是五个参数，并且参数类型各不相同。这就导致重复开发，要费太多时间了。

随着 LSP 的诞生，定义了一套标准协议。现在大家就照这个协议去做就可以，大家都能受益。

LSP 的实现有哪些？#

LSP 并不是只能用一个特定语言实现，而是可以多种。 Language Server Protocol Implementations 给出了各类语言的 LSP 实现以及其实现所使用的语言。

了解了这些以后我们就可以开始正式为 Sora Editor 对接 LSP 了。

如何为 Sora Editor 对接 LSP?#

首先先编译你自己的 LSP Server 软件，然后我们可以使用 ProcessBuilder 去运行它。由于大部分 LSP 都是通过 stdio 和 stdout 进行通信，因此我们需要向 ProcessBuilder 产生的 Process 写入协议内容。 Sora Editor 已经为我们内置好了相关接口，我们可以通过继承 StreamConnectionProvider 类来处理相关逻辑。你可以参考如下源码（这里以 TypeScript Language Server 为例）：

1
class ProcessStreamConnectionProvider(val context: Context) : StreamConnectionProvider {
2

3
    // 这里创建我们的 ProcessBuilder, 指定需要运行的 LSP 服务器软件为 /data/user/0/你的包名/files/usr/bin/typescript-language-server
4
    private val processBuilder = ProcessBuilder(context.filesDir.resolve("usr/bin").resolve("typescript-language-server").absolutePath, "--stdio")
5
        .apply {
6
            // 这里设置默认的进程环境，并向 PATH、LD_LIBRARY_PATH 设置 typescript-language-server 当前文件夹路径和所需库文件路径
7
            val env = environment()
8
            env.putAll(System.getenv())
9
            env["PATH"] = "${System.getenv("PATH")}:${context.filesDir.resolve("usr/bin")}"
10
            env["LD_LIBRARY_PATH"] = "${System.getenv("LD_LIBRARY_PATH")}:${context.filesDir.resolve("usr/lib")}"
11
            env["OPENSSL_CONF"] = ""
12
        }
13
        // 重定向 stderr 到 stdout
14
        .redirectErrorStream(true)
15

16
    private lateinit var process: Process
17

18
    override val inputStream: InputStream
19
        get() = process.inputStream
20

21
    override val outputStream: OutputStream
22
        get() = process.outputStream
23

24
    override fun start() {
25
        process = processBuilder.start()
26
    }
27

28
    override fun close() {
29
        process.destroy()
30
    }
31

32
}

接下来是注册主题和语言配置，你可以在 Application 中完成配置：

1
class AppContext : Application() {
2

3
    companion object {
4

5
        lateinit var instance: AppContext
6
            private set
7

8
    }
9

10
    override fun onCreate() {
11
        super.onCreate()
12
        // ... 其它代码
13

14
        // 添加 AssetsFileResolver，便于直接引用 assets 中的文件
15
        FileProviderRegistry.addProvider(AssetsFileResolver(assets))
16

17
        // 从 assets 中加载主题
18
        ThemeRegistry.loadTheme(ThemeModel(ThemeSource("theme/quietlight.json", "quietlight")))
19

20
        // 向 Monarch 注册表加载支持语言的语法配置
21
        MonarchGrammarRegistry.INSTANCE.loadGrammars(monarchLanguages {
22
            language("typescript") {
23
                monarchLanguage = TypescriptLanguage
24
                scopeName = "source.ts"
25
                languageConfiguration = "textmate/typescript/language-configuration.json"
26
            }
27
        })
28

29
        // ... 其它代码
30
    }
31

32
}

接下来只需要应用主题、配置默认语言就行：

1
val codeEditor = CodeEditor(context).apply {
2
    // 设置 Jetbrains 等宽字体，你也可以换成你自己喜欢的
3
    val typeface =
4
        Typeface.createFromAsset(context.assets, "font/JetBrainsMono-Regular.ttf")
5

6
    // 给编辑器行号和内容进行应用
7
    typefaceLineNumber = typeface
8
    typefaceText = typeface
9

10
    // 设置编辑器配色方案
11
    colorScheme = MonarchColorScheme.create(ThemeRegistry.currentTheme)
12
}

最后一步，连接 LSP：

1
// 启动一个 Kotlin 协程
2
CoroutineScope(Dispatchers.IO).launch {
3

4
    // 可以切换到主线程做一些准备工作
5
    withContext(Dispatchers.Main) {
6
        context.toast("(Kotlin Activity) Starting Language Server...")
7
        codeEditor.isEditable = false
8
    }
9

10
    // 创建 LanguageServerDefinition
11
    val serverDefinition =
12
        object : CustomLanguageServerDefinition(
13
            "ts", // 这里指定你的目标语言
14
            ServerConnectProvider {
15
                ProcessStreamConnectionProvider(context) // 这个是之前配置的 ProcessStreamConnectionProvider
16
            }
17
        ) {}
18

19
    val typescriptLspDemoFolder = context.filesDir.resolve("typescript-lsp-demo")
20
    val mainFile = typescriptLspDemoFolder.resolve("index.ts")
21
    val lspProject = LspProject(typescriptLspDemoFolder.absolutePath)
22
    lspProject.addServerDefinition(serverDefinition)
23
    var lspEditor: LspEditor
24
    withContext(Dispatchers.Main) {
25
        // 创建 LspEditor
26
        lspEditor = lspProject.createEditor(mainFile.absolutePath)
27
        lspEditor.wrapperLanguage = MonarchLanguage.create("source.ts", true)
28
        lspEditor.editor = codeEditor
29
        lspEditor.isEnableInlayHint = true // 是否启用镶嵌提示
30
        lspEditor.isEnableHover = true // 是否启用悬停
31
        lspEditor.isEnableSignatureHelp = true // 是否启用签名提示
32
    }
33

34
    // connectWithTimeout() 在 10s 内尝试连接（失败会重试），如果超时会抛出异常
35
    try {
36
        lspEditor.connectWithTimeout()
37

38
        // 给 LSP Server 指定切换工作目录
39
        lspEditor.requestManager.didChangeWorkspaceFolders(
40
            DidChangeWorkspaceFoldersParams().apply {
41
                this.event = WorkspaceFoldersChangeEvent().apply {
42
                    added =
43
                        listOf(
44
                            WorkspaceFolder(
45
                                "file://${typescriptLspDemoFolder}",
46
                                "typescript-lsp-demo"
47
                            )
48
                        )
49
                }
50
            }
51
        )
52
        isLspConnected = true
53
    } catch (e: Exception) {
54
        isLspConnected = false
55
        e.printStackTrace()
56
    }
57

58
    // 连接成功或失败后进行一些工作
59
    withContext(Dispatchers.Main) {
60
        if (isLspConnected) {
61
            context.toast("Initialized Language server")
62
        } else {
63
            context.toast("Unable to connect language server")
64
        }
65
        codeEditor.editable = true
66
    }
67
}

TypeScript LSP Demo#

你可以在这个仓库中查看本 Demo 的所有代码：

mucute-qwq

TypeScript-LSP-Demo

Waiting for api.github.com...

00K

Waiting...