SourceKit-LSP 中的 BSP 协议扩展详解

SourceKit-LSP 中的 BSP 协议扩展详解

sourcekit-lsp Language Server Protocol implementation for Swift and C-based languages 项目地址: https://gitcode.com/gh_mirrors/so/sourcekit-lsp

前言

SourceKit-LSP 作为苹果推出的语言服务器协议实现，在支持基础 LSP 功能的同时，还针对 Swift 和 C 语言家族提供了更强大的支持。本文将深入解析 SourceKit-LSP 对 Build Server Protocol (BSP) 的扩展，帮助开发者理解这些扩展如何增强开发体验。

BSP 协议概述

BSP 协议是构建服务器与语言服务器之间的通信标准，它允许语言服务器获取构建系统的详细信息，如编译参数、依赖关系等。SourceKit-LSP 通过扩展 BSP 协议，实现了更精细的构建系统集成。

核心扩展功能

1. 构建初始化扩展

在 build/initialize 请求中，SourceKit-LSP 增加了 sourceKit 类型的响应数据：

interface SourceKitInitializeBuildResponseData {
  indexDatabasePath?: string;    // 索引数据库存储路径
  indexStorePath?: string;       // 构建时索引存储路径
  outputPathsProvider?: boolean; // 是否支持输出路径
  prepareProvider?: boolean;     // 是否支持准备构建目标
  sourceKitOptionsProvider?: boolean; // 是否支持获取编译选项
  watchers?: FileSystemWatcher[]; // 需要监视的文件列表
}

这些扩展使得 SourceKit-LSP 能够：

• 管理专属的索引数据库
• 监控构建系统生成的索引存储
• 支持更高效的增量构建

2. 构建目标准备机制

buildTarget/prepare 是一个关键扩展，它允许客户端请求构建服务器为特定目标做好编辑准备：

interface PrepareParams {
  targets: BuildTargetIdentifier[]; // 需要准备的目标列表
  originId?: string;               // 客户端生成的唯一标识
}

这个请求会触发构建系统执行必要的准备工作（如生成依赖模块、运行代码生成脚本等），但可以跳过非必要的构建步骤（如目标文件生成）。Swift Package Manager 通过 swift build --experimental-prepare-for-indexing 命令实现这一功能。

3. 源代码项元数据

在 buildTarget/sources 请求中，SourceKit-LSP 扩展了源代码项的元数据：

interface SourceKitSourceItemData {
  language?: string;      // 源代码语言
  kind?: "source" | "header" | "doccCatalog"; // 文件类型
  outputPath?: string;    // 索引输出路径
}

这些元数据帮助 SourceKit-LSP 更精确地处理不同类型的源代码文件，特别是对于跨平台项目和混合语言项目。

4. 编译选项查询

textDocument/sourceKitOptions 请求允许客户端查询特定文件在特定目标中的编译选项：

interface TextDocumentSourceKitOptionsRequest {
  textDocument: TextDocumentIdentifier; // 文档标识
  target: BuildTargetIdentifier;        // 目标标识
  language: string;                     // 文档语言
}

interface TextDocumentSourceKitOptionsResult {
  compilerArguments: string[];  // 编译参数
  workingDirectory?: string;    // 工作目录
  data?: any;                   // 额外数据
}

这个扩展对于支持多目标项目和复杂构建配置至关重要，它确保了代码分析和补全的准确性。

5. 构建目标分类

SourceKit-LSP 扩展了构建目标的分类标签：

enum BuildTargetTag {
  Dependency = "dependency",     // 项目依赖目标
  NotBuildable = "not-buildable" // 不可构建目标
}

此外，构建目标数据可以包含工具链信息：

interface SourceKitBuildTarget {
  toolchain?: string;  // 目标使用的工具链路径
}

这些扩展帮助 SourceKit-LSP 正确处理不同类型的构建目标，特别是对于 Swift Package Manager 项目中的依赖和特殊目标（如包清单）。

实用功能扩展

1. 构建任务进度通知

build/taskStart 通知支持通过 workDoneProgressTitle 键在客户端显示构建进度，改善了用户体验。

2. 文件变更通知

workspace/didChangeWatchedFiles 通知允许构建系统监控文件变更，SourceKit-LSP 会发送可能超出构建系统请求范围的文件变更通知，构建系统需要自行过滤。

3. 构建系统同步

workspace/waitForBuildSystemUpdates 请求允许客户端等待构建系统完成更新，这在需要确保构建信息最新的场景下非常有用。

总结

SourceKit-LSP 通过这些 BSP 协议扩展，实现了与构建系统更紧密的集成，提供了更准确的代码分析、更高效的构建支持和更流畅的开发体验。理解这些扩展对于开发基于 SourceKit-LSP 的工具或构建系统集成非常有帮助。

对于构建系统开发者来说，实现这些扩展可以显著提升与 SourceKit-LSP 的协作效率；对于工具开发者来说，了解这些扩展有助于更好地利用 SourceKit-LSP 提供的功能。

sourcekit-lsp Language Server Protocol implementation for Swift and C-based languages 项目地址: https://gitcode.com/gh_mirrors/so/sourcekit-lsp