深入理解Microsoft语言服务器协议中的LSIF格式-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00860/article/details/148393505

深入理解Microsoft语言服务器协议中的LSIF格式

language-server-protocol Defines a common protocol for language servers. 项目地址: https://gitcode.com/gh_mirrors/la/language-server-protocol

什么是LSIF格式

LSIF（Language Server Index Format，发音类似"else if"）是微软语言服务器协议（LSP）生态中的重要组成部分，它为开发者提供了一种全新的代码导航体验。想象一下，当你在代码审查或浏览代码库时，无需下载完整的源代码到本地，就能获得智能的代码导航功能——这正是LSIF要实现的愿景。

传统的开发流程中，开发者需要：

克隆代码仓库到本地
打开开发工具
才能开始阅读和导航代码

LSIF的出现改变了这一现状，它允许开发工具或Web界面在不持有本地源代码的情况下，依然能提供丰富的代码导航功能，包括：

悬停提示（Hover Information）
跳转到定义（Go to Definition）
查找所有引用（Find All References）

LSIF与LSP的关系

LSIF与LSP有着紧密的联系，但解决的问题不同：

LSP（语言服务器协议）：

专注于提供丰富的代码编辑功能
需要本地源代码文件
通常需要构建完整的语法树
功能包括自动补全、格式化等

LSIF（语言服务器索引格式）：

专注于代码导航功能
不需要本地源代码
预计算并存储代码分析结果
扩展了LSP的能力边界

LSIF复用LSP定义的数据类型，这使得它能够无缝集成到已经支持LSP的工具链中。这种设计保持了与LSP的一致性，同时解决了不同场景下的需求。

LSIF技术原理详解

核心设计思想

LSIF的核心是预计算并持久化语言服务器对代码的分析结果。它采用图结构来表示代码元素之间的关系：

顶点（Vertices）：表示文档、代码范围或请求结果等实体
边（Edges）：表示这些实体之间的关系或LSP请求

这种图结构设计具有以下优势：

灵活性：可以轻松扩展新的请求类型或结果
高效性：支持流式处理，避免内存占用过高
精确性：准确表达代码元素间的复杂关系

实际案例分析

让我们通过一个TypeScript示例来理解LSIF的工作原理：

function bar(): void {
}

当用户悬停在bar()上时，开发工具会显示函数的签名信息。在LSP中，这通过Hover类型表示：

interface Hover {
    contents: MarkupContent | MarkedString | MarkedString[];
    range?: Range;
}

对应的实际值可能是：

{
  contents: [
    { language: "typescript", value: "function bar(): void" }
  ]
}

在LSIF中，这个信息会被表示为图结构：

// 文档顶点
{ id: 1, type: "vertex", label: "document", uri: "file:///sample.ts", languageId: "typescript" }

// 代码范围顶点（bar标识符的范围）
{ id: 4, type: "vertex", label: "range", start: { line: 0, character: 9}, end: { line: 0, character: 12 } }

// 包含关系边
{ id: 5, type: "edge", label: "contains", outV: 1, inV: 4}

// 悬停结果顶点
{ id: 6, type: "vertex", label: "hoverResult",
  result: {
    contents: [
      { language: "typescript", value: "function bar(): void" }
    ]
  }
}

// 悬停请求边
{ id: 7, type: "edge", label: "textDocument/hover", outV: 4, inV: 6 }

对应的图结构可视化如下：

文档顶点 (1)
  |
  | contains
  v
范围顶点 (4) - textDocument/hover -> 悬停结果顶点 (6)

非位置相关请求的处理

LSIF不仅处理位置相关的请求（如悬停提示），还能处理文档级别的请求。例如，折叠范围（Folding Range）请求：

function bar(): void {
  console.log('Hello World!');
}

对应的LSIF表示：

// 文档顶点
{ id: 1, type: "vertex", label: "document", uri: "file:///sample.ts", languageId: "typescript" }

// 折叠结果顶点
{ id: 2, type: "vertex", label: "foldingRangeResult", 
  result: [ { startLine: 0, startCharacter: 20, endLine: 2, endCharacter: 1 } ] 
}

// 折叠请求边
{ id: 3, type: "edge", label: "textDocument/foldingRange", outV: 1, inV: 2 }