💻 欢迎参加 6 月 3 日 MS Build 上的 VS Code 直播活动。

语言服务器扩展指南

正如您在程序化语言功能主题中所见，可以通过直接使用 languages.* API 来实现语言功能。然而，语言服务器（Language Server）扩展提供了一种实现此类语言支持的替代方案。

本主题

为什么需要语言服务器？

语言服务器是一种特殊的 Visual Studio Code 扩展，它为许多编程语言提供了编辑功能支持。通过语言服务器，您可以实现 VS Code 支持的自动补全、错误检查（诊断）、跳转到定义以及许多其他语言功能。

然而，在 VS Code 中实现语言功能支持时，我们发现了三个常见问题：

首先，语言服务器通常是用其原生编程语言实现的，这给将其集成到基于 Node.js 运行时的 VS Code 中带来了挑战。

此外，语言功能往往非常消耗资源。例如，为了正确验证文件，语言服务器需要解析大量文件、构建抽象语法树并进行静态程序分析。这些操作可能会导致巨大的 CPU 和内存开销，我们需要确保 VS Code 的性能不受影响。

最后，将多种语言工具与多个代码编辑器集成可能需要付出巨大的努力。从语言工具开发者的角度来看，他们需要适配具有不同 API 的代码编辑器；从代码编辑器的角度来看，他们无法从语言工具那里获得统一的 API。这使得在 N 个代码编辑器中为 M 种语言实现支持的工作量变成了 M * N。

为了解决这些问题，微软制定了 语言服务器协议 (LSP)，它标准化了语言工具与代码编辑器之间的通信。通过这种方式，语言服务器可以使用任何语言实现，并运行在各自的进程中以避免性能开销，因为它们通过语言服务器协议与代码编辑器通信。此外，任何符合 LSP 的语言工具都可以与多个符合 LSP 的代码编辑器集成，任何符合 LSP 的代码编辑器也可以轻松接入多个符合 LSP 的语言工具。LSP 对语言工具提供商和代码编辑器厂商来说是双赢的！

LSP Languages and Editors

在本指南中，我们将：

  • 解释如何使用提供的 Node SDK 在 VS Code 中构建语言服务器扩展。
  • 解释如何运行、调试、记录日志以及测试语言服务器扩展。
  • 为您指出关于语言服务器的一些进阶主题。

实现语言服务器

概述

在 VS Code 中，语言服务器由两部分组成：

  • 语言客户端（Language Client）：一个用 JavaScript / TypeScript 编写的普通 VS Code 扩展。该扩展可以访问所有 VS Code 命名空间 API。
  • 语言服务器（Language Server）：运行在独立进程中的语言分析工具。

如上所述，在独立进程中运行语言服务器有两个好处：

  • 只要能够遵循语言服务器协议与语言客户端进行通信，分析工具可以使用任何语言实现。
  • 由于语言分析工具通常对 CPU 和内存的占用较高，在独立进程中运行它们可以避免性能损耗。

下图展示了 VS Code 运行两个语言服务器扩展的情景。HTML 语言客户端和 PHP 语言客户端是用 TypeScript 编写的普通 VS Code 扩展。它们各自实例化对应的语言服务器，并通过 LSP 与其通信。尽管 PHP 语言服务器是用 PHP 编写的，但它仍然可以通过 LSP 与 PHP 语言客户端通信。

LSP Illustration

本指南将教您如何使用我们的 Node SDK 构建语言客户端/服务器。本文档的其余部分假设您熟悉 VS Code 扩展 API。

LSP 示例 - 一个用于纯文本文件的简单语言服务器

让我们构建一个简单的语言服务器扩展，为纯文本文件实现自动补全和诊断功能。我们还将涵盖客户端/服务器之间的配置同步。

如果您更喜欢直接查看代码：

  • lsp-sample：本指南中带有详尽注释的源代码。
  • lsp-multi-server-sample：lsp-sample 的高级版本，带有详细注释。它为每个工作区文件夹启动一个不同的服务器实例，以支持 VS Code 的多根工作区功能。

克隆仓库 Microsoft/vscode-extension-samples 并打开示例。

> git clone https://github.com/microsoft/vscode-extension-samples.git
> cd vscode-extension-samples/lsp-sample
> npm install
> npm run compile
> code .

上述操作将安装所有依赖项并打开包含客户端和服务器代码的 lsp-sample 工作区。以下是 lsp-sample 结构的简要概述：

.
├── client // Language Client
│   ├── src
│   │   ├── test // End to End tests for Language Client / Server
│   │   └── extension.ts // Language Client entry point
├── package.json // The extension manifest
└── server // Language Server
    └── src
        └── server.ts // Language Server entry point

解释“语言客户端”

首先看一下 /package.json，它描述了语言客户端的功能。这里有两个有趣的部分：

首先，查看 configuration 部分。

"configuration": {
    "type": "object",
    "title": "Example configuration",
    "properties": {
        "languageServerExample.maxNumberOfProblems": {
            "scope": "resource",
            "type": "number",
            "default": 100,
            "description": "Controls the maximum number of problems produced by the server."
        }
    }
}

本节向 VS Code 贡献了 configuration 设置。本示例将解释这些设置如何在启动时以及每次更改设置时发送到语言服务器。

注意：如果您的扩展兼容 1.74.0 之前的 VS Code 版本，您必须在 /package.json 的 activationEvents 字段中声明 onLanguage:plaintext，以告知 VS Code 在打开纯文本文件（例如扩展名为 .txt 的文件）时立即激活该扩展。

"activationEvents": []

实际的语言客户端源代码和相应的 package.json 位于 /client 文件夹中。/client/package.json 文件中引人注目的部分是，它通过 engines 字段引用了 vscode 扩展宿主 API，并添加了对 vscode-languageclient 库的依赖。

"engines": {
    "vscode": "^1.52.0"
},
"dependencies": {
    "vscode-languageclient": "^7.0.0"
}

如前所述，客户端是作为普通 VS Code 扩展实现的，它可以访问所有 VS Code 命名空间 API。

以下是 lsp-sample 扩展入口点 extension.ts 文件的内容：

import * as path from 'path';
import { workspace, ExtensionContext } from 'vscode';

import {
  LanguageClient,
  LanguageClientOptions,
  ServerOptions,
  TransportKind
} from 'vscode-languageclient/node';

let client: LanguageClient | undefined;

export async function activate(context: ExtensionContext) {
  // The server is implemented in node
  let serverModule = context.asAbsolutePath(path.join('server', 'out', 'server.js'));
  // The debug options for the server
  // --inspect=6009: runs the server in Node's Inspector mode so VS Code can attach to the server for debugging
  let debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] };

  // If the extension is launched in debug mode then the debug server options are used
  // Otherwise the run options are used
  let serverOptions: ServerOptions = {
    run: { module: serverModule, transport: TransportKind.ipc },
    debug: {
      module: serverModule,
      transport: TransportKind.ipc,
      options: debugOptions
    }
  };

  // Options to control the language client
  let clientOptions: LanguageClientOptions = {
    // Register the server for plain text documents
    documentSelector: [{ scheme: 'file', language: 'plaintext' }],
    synchronize: {
      // Notify the server about file changes to '.clientrc files contained in the workspace
      fileEvents: workspace.createFileSystemWatcher('**/.clientrc')
    }
  };

  // Create the language client and start the client.
  client = new LanguageClient(
    'languageServerExample',
    'Language Server Example',
    serverOptions,
    clientOptions
  );

  // Start the client. This will also launch the server
  await client.start();
}

export async function deactivate() {
  await client?.dispose();
  client = undefined;
}

解释“语言服务器”

注意：从 GitHub 仓库克隆的“服务器”实现包含了最终的演示代码。要跟随本指南操作，您可以创建一个新的 server.ts 或修改克隆版本中的内容。

在本例中，服务器也是用 TypeScript 实现并使用 Node.js 执行的。由于 VS Code 已经内置了 Node.js 运行时，除非您对运行时有特殊要求，否则无需提供自己的运行时。

语言服务器的源代码位于 /server。服务器的 package.json 文件中引人注目的部分是：

"dependencies": {
    "vscode-languageserver": "^7.0.0",
    "vscode-languageserver-textdocument": "^1.0.1"
}

这将引入 vscode-languageserver 库。

下面是一个服务器实现，它使用了所提供的文本文档管理器，该管理器通过持续向服务器发送来自 VS Code 的增量更改来同步文本文档。

import {
  createConnection,
  TextDocuments,
  Diagnostic,
  DiagnosticSeverity,
  ProposedFeatures,
  InitializeParams,
  DidChangeConfigurationNotification,
  CompletionItem,
  CompletionItemKind,
  TextDocumentPositionParams,
  TextDocumentSyncKind,
  InitializeResult
} from 'vscode-languageserver/node';

import { TextDocument } from 'vscode-languageserver-textdocument';

// Create a connection for the server, using Node's IPC as a transport.
// Also include all preview / proposed LSP features.
let connection = createConnection(ProposedFeatures.all);

// Create a simple text document manager.
let documents: TextDocuments<TextDocument> = new TextDocuments(TextDocument);

let hasConfigurationCapability: boolean = false;
let hasWorkspaceFolderCapability: boolean = false;
let hasDiagnosticRelatedInformationCapability: boolean = false;

connection.onInitialize((params: InitializeParams) => {
  let capabilities = params.capabilities;

  // Does the client support the `workspace/configuration` request?
  // If not, we fall back using global settings.
  hasConfigurationCapability = !!(
    capabilities.workspace && !!capabilities.workspace.configuration
  );
  hasWorkspaceFolderCapability = !!(
    capabilities.workspace && !!capabilities.workspace.workspaceFolders
  );
  hasDiagnosticRelatedInformationCapability = !!(
    capabilities.textDocument &&
    capabilities.textDocument.publishDiagnostics &&
    capabilities.textDocument.publishDiagnostics.relatedInformation
  );

  const result: InitializeResult = {
    capabilities: {
      textDocumentSync: TextDocumentSyncKind.Incremental,
      // Tell the client that this server supports code completion.
      completionProvider: {
        resolveProvider: true
      }
    }
  };
  if (hasWorkspaceFolderCapability) {
    result.capabilities.workspace = {
      workspaceFolders: {
        supported: true
      }
    };
  }
  return result;
});

connection.onInitialized(() => {
  if (hasConfigurationCapability) {
    // Register for all configuration changes.
    connection.client.register(DidChangeConfigurationNotification.type, undefined);
  }
  if (hasWorkspaceFolderCapability) {
    connection.workspace.onDidChangeWorkspaceFolders(_event => {
      connection.console.log('Workspace folder change event received.');
    });
  }
});

// The example settings
interface ExampleSettings {
  maxNumberOfProblems: number;
}

// The global settings, used when the `workspace/configuration` request is not supported by the client.
// Please note that this is not the case when using this server with the client provided in this example
// but could happen with other clients.
const defaultSettings: ExampleSettings = { maxNumberOfProblems: 1000 };
let globalSettings: ExampleSettings = defaultSettings;

// Cache the settings of all open documents
let documentSettings: Map<string, Thenable<ExampleSettings>> = new Map();

connection.onDidChangeConfiguration(change => {
  if (hasConfigurationCapability) {
    // Reset all cached document settings
    documentSettings.clear();
  } else {
    globalSettings = <ExampleSettings>(
      (change.settings.languageServerExample || defaultSettings)
    );
  }

  // Revalidate all open text documents
  documents.all().forEach(validateTextDocument);
});

function getDocumentSettings(resource: string): Thenable<ExampleSettings> {
  if (!hasConfigurationCapability) {
    return Promise.resolve(globalSettings);
  }
  let result = documentSettings.get(resource);
  if (!result) {
    result = connection.workspace.getConfiguration({
      scopeUri: resource,
      section: 'languageServerExample'
    });
    documentSettings.set(resource, result);
  }
  return result;
}

// Only keep settings for open documents
documents.onDidClose(e => {
  documentSettings.delete(e.document.uri);
});

// The content of a text document has changed. This event is emitted
// when the text document first opened or when its content has changed.
documents.onDidChangeContent(change => {
  validateTextDocument(change.document);
});

async function validateTextDocument(textDocument: TextDocument): Promise<void> {
  // In this simple example we get the settings for every validate run.
  let settings = await getDocumentSettings(textDocument.uri);

  // The validator creates diagnostics for all uppercase words length 2 and more
  let text = textDocument.getText();
  let pattern = /\b[A-Z]{2,}\b/g;
  let m: RegExpExecArray | null;

  let problems = 0;
  let diagnostics: Diagnostic[] = [];
  while ((m = pattern.exec(text)) && problems < settings.maxNumberOfProblems) {
    problems++;
    let diagnostic: Diagnostic = {
      severity: DiagnosticSeverity.Warning,
      range: {
        start: textDocument.positionAt(m.index),
        end: textDocument.positionAt(m.index + m[0].length)
      },
      message: `${m[0]} is all uppercase.`,
      source: 'ex'
    };
    if (hasDiagnosticRelatedInformationCapability) {
      diagnostic.relatedInformation = [
        {
          location: {
            uri: textDocument.uri,
            range: Object.assign({}, diagnostic.range)
          },
          message: 'Spelling matters'
        },
        {
          location: {
            uri: textDocument.uri,
            range: Object.assign({}, diagnostic.range)
          },
          message: 'Particularly for names'
        }
      ];
    }
    diagnostics.push(diagnostic);
  }

  // Send the computed diagnostics to VS Code.
  connection.sendDiagnostics({ uri: textDocument.uri, diagnostics });
}

connection.onDidChangeWatchedFiles(_change => {
  // Monitored files have change in VS Code
  connection.console.log('We received a file change event');
});

// This handler provides the initial list of the completion items.
connection.onCompletion(
  (_textDocumentPosition: TextDocumentPositionParams): CompletionItem[] => {
    // The pass parameter contains the position of the text document in
    // which code complete got requested. For the example we ignore this
    // info and always provide the same completion items.
    return [
      {
        label: 'TypeScript',
        kind: CompletionItemKind.Text,
        data: 1
      },
      {
        label: 'JavaScript',
        kind: CompletionItemKind.Text,
        data: 2
      }
    ];
  }
);

// This handler resolves additional information for the item selected in
// the completion list.
connection.onCompletionResolve(
  (item: CompletionItem): CompletionItem => {
    if (item.data === 1) {
      item.detail = 'TypeScript details';
      item.documentation = 'TypeScript documentation';
    } else if (item.data === 2) {
      item.detail = 'JavaScript details';
      item.documentation = 'JavaScript documentation';
    }
    return item;
  }
);

// Make the text document manager listen on the connection
// for open, change and close text document events
documents.listen(connection);

// Listen on the connection
connection.listen();

添加简单的验证

要向服务器添加文档验证，我们需要为文本文档管理器添加一个监听器，每当文本文档的内容发生变化时，该监听器就会被调用。服务器随后决定验证文档的最佳时机。在示例实现中，服务器验证纯文本文件并标记所有使用全大写的单词。相应的代码片段如下所示：

// The content of a text document has changed. This event is emitted
// when the text document first opened or when its content has changed.
documents.onDidChangeContent(async change => {
  let textDocument = change.document;
  // In this simple example we get the settings for every validate run.
  let settings = await getDocumentSettings(textDocument.uri);

  // The validator creates diagnostics for all uppercase words length 2 and more
  let text = textDocument.getText();
  let pattern = /\b[A-Z]{2,}\b/g;
  let m: RegExpExecArray | null;

  let problems = 0;
  let diagnostics: Diagnostic[] = [];
  while ((m = pattern.exec(text)) && problems < settings.maxNumberOfProblems) {
    problems++;
    let diagnostic: Diagnostic = {
      severity: DiagnosticSeverity.Warning,
      range: {
        start: textDocument.positionAt(m.index),
        end: textDocument.positionAt(m.index + m[0].length)
      },
      message: `${m[0]} is all uppercase.`,
      source: 'ex'
    };
    if (hasDiagnosticRelatedInformationCapability) {
      diagnostic.relatedInformation = [
        {
          location: {
            uri: textDocument.uri,
            range: Object.assign({}, diagnostic.range)
          },
          message: 'Spelling matters'
        },
        {
          location: {
            uri: textDocument.uri,
            range: Object.assign({}, diagnostic.range)
          },
          message: 'Particularly for names'
        }
      ];
    }
    diagnostics.push(diagnostic);
  }

  // Send the computed diagnostics to VS Code.
  connection.sendDiagnostics({ uri: textDocument.uri, diagnostics });
});

诊断功能提示与技巧

  • 如果开始和结束位置相同，VS Code 将在那个位置用波浪线标出该单词。
  • 如果您想用波浪线标出直到行尾，请将结束位置的字符设置为 Number.MAX_VALUE。

要运行语言服务器，请执行以下步骤：

  • 按 ⇧⌘B (Windows, Linux Ctrl+Shift+B) 启动构建任务。该任务会编译客户端和服务器。
  • 打开运行和调试视图，选择 Launch Client 启动配置，然后按下启动调试按钮，启动一个额外的 VS Code 扩展开发宿主实例来执行扩展代码。
  • 在根目录下创建一个 test.txt 文件并粘贴以下内容：
TypeScript lets you write JavaScript the way you really want to.
TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
ANY browser. ANY host. ANY OS. Open Source.

此时，扩展开发宿主实例将如下所示：

Validating a text file

调试客户端和服务器

调试客户端代码就像调试普通扩展一样简单。在客户端代码中设置断点，然后按 F5 调试扩展。

Debugging the client

由于服务器是由扩展（客户端）中运行的 LanguageClient 启动的，我们需要将调试器附加到运行中的服务器上。为此，切换到运行和调试视图，选择 Attach to Server 启动配置，然后按 F5。这将把调试器附加到服务器。

Debugging the server

语言服务器的日志支持

如果您使用 vscode-languageclient 来实现客户端，您可以指定设置 [langId].trace.server，指示客户端将语言客户端/服务器之间的通信记录到语言客户端的 name 通道中。

对于 lsp-sample，您可以设置："languageServerExample.trace.server": "verbose"。现在转到“Language Server Example”输出通道，您应该能看到日志。

LSP Log

在服务器中使用配置设置

在编写扩展的客户端部分时，我们已经定义了一个设置来控制报告问题的最大数量。我们还在服务器端编写了代码，从客户端读取这些设置：

function getDocumentSettings(resource: string): Thenable<ExampleSettings> {
  if (!hasConfigurationCapability) {
    return Promise.resolve(globalSettings);
  }
  let result = documentSettings.get(resource);
  if (!result) {
    result = connection.workspace.getConfiguration({
      scopeUri: resource,
      section: 'languageServerExample'
    });
    documentSettings.set(resource, result);
  }
  return result;
}

现在我们只需要在服务器端监听配置更改，如果设置发生变化，则重新验证已打开的文本文档。为了复用文档更改事件处理的验证逻辑，我们将代码提取到一个 validateTextDocument 函数中，并修改代码以遵循 maxNumberOfProblems 变量。

async function validateTextDocument(textDocument: TextDocument): Promise<void> {
  // In this simple example we get the settings for every validate run.
  let settings = await getDocumentSettings(textDocument.uri);

  // The validator creates diagnostics for all uppercase words length 2 and more
  let text = textDocument.getText();
  let pattern = /\b[A-Z]{2,}\b/g;
  let m: RegExpExecArray | null;

  let problems = 0;
  let diagnostics: Diagnostic[] = [];
  while ((m = pattern.exec(text)) && problems < settings.maxNumberOfProblems) {
    problems++;
    let diagnostic: Diagnostic = {
      severity: DiagnosticSeverity.Warning,
      range: {
        start: textDocument.positionAt(m.index),
        end: textDocument.positionAt(m.index + m[0].length)
      },
      message: `${m[0]} is all uppercase.`,
      source: 'ex'
    };
    if (hasDiagnosticRelatedInformationCapability) {
      diagnostic.relatedInformation = [
        {
          location: {
            uri: textDocument.uri,
            range: Object.assign({}, diagnostic.range)
          },
          message: 'Spelling matters'
        },
        {
          location: {
            uri: textDocument.uri,
            range: Object.assign({}, diagnostic.range)
          },
          message: 'Particularly for names'
        }
      ];
    }
    diagnostics.push(diagnostic);
  }

  // Send the computed diagnostics to VS Code.
  connection.sendDiagnostics({ uri: textDocument.uri, diagnostics });
}

配置更改的处理是通过向连接添加配置更改的通知处理程序来完成的。相应的代码如下所示：

connection.onDidChangeConfiguration(change => {
  if (hasConfigurationCapability) {
    // Reset all cached document settings
    documentSettings.clear();
  } else {
    globalSettings = <ExampleSettings>(
      (change.settings.languageServerExample || defaultSettings)
    );
  }

  // Revalidate all open text documents
  documents.all().forEach(validateTextDocument);
});

再次启动客户端并将设置更改为最多报告 1 个问题，将产生以下验证结果：

Maximum One Problem

添加附加语言功能

语言服务器通常实现的第一个有趣功能是文档验证。从这个意义上讲，甚至代码检查工具（linter）也算作语言服务器，在 VS Code 中，linter 通常实现为语言服务器（参见 eslint 和 jshint 的示例）。但语言服务器远不止于此。它们可以提供代码补全、查找所有引用或转到定义。下面的示例代码向服务器添加了代码补全功能。它提议了两个单词：“TypeScript”和“JavaScript”。

// This handler provides the initial list of the completion items.
connection.onCompletion(
  (_textDocumentPosition: TextDocumentPositionParams): CompletionItem[] => {
    // The pass parameter contains the position of the text document in
    // which code complete got requested. For the example we ignore this
    // info and always provide the same completion items.
    return [
      {
        label: 'TypeScript',
        kind: CompletionItemKind.Text,
        data: 1
      },
      {
        label: 'JavaScript',
        kind: CompletionItemKind.Text,
        data: 2
      }
    ];
  }
);

// This handler resolves additional information for the item selected in
// the completion list.
connection.onCompletionResolve(
  (item: CompletionItem): CompletionItem => {
    if (item.data === 1) {
      item.detail = 'TypeScript details';
      item.documentation = 'TypeScript documentation';
    } else if (item.data === 2) {
      item.detail = 'JavaScript details';
      item.documentation = 'JavaScript documentation';
    }
    return item;
  }
);

data 字段用于在解析处理程序中唯一标识补全项。该属性对协议是透明的。由于底层消息传递协议基于 JSON，因此数据字段应仅包含可序列化为 JSON 的数据。

剩下的工作就是告诉 VS Code 服务器支持代码补全请求。为此，请在初始化处理程序中标记相应的功能：

connection.onInitialize((params): InitializeResult => {
    ...
    return {
        capabilities: {
            ...
            // Tell the client that the server supports code completion
            completionProvider: {
                resolveProvider: true
            }
        }
    };
});

下图显示了在纯文本文件上运行的补全功能：

Code Complete

测试语言服务器

要创建一个高质量的语言服务器，我们需要构建一个覆盖其功能的良好测试套件。测试语言服务器有两种常见方式：

  • 单元测试：如果您想通过模拟发送给它的所有信息来测试语言服务器中的特定功能，这很有用。VS Code 的 HTML / CSS / JSON 语言服务器都采用这种方式进行测试。LSP npm 模块也采用此方法。请参见此处查看一些使用 npm 协议模块编写的单元测试。
  • 端到端测试：这类似于 VS Code 扩展测试。这种方法的优势在于，它通过实例化一个带有工作区的 VS Code 实例、打开文件、激活语言客户端/服务器并运行 VS Code 命令来运行测试。如果您有难以或无法模拟的文件、设置或依赖项（例如 node_modules），这种方法非常出色。流行的 Python 扩展就采用了这种测试方法。

可以在您选择的任何测试框架中进行单元测试。在此我们描述如何对语言服务器扩展进行端到端测试。

打开 .vscode/launch.json，您可以找到一个 E2E 测试目标。

{
  "name": "Language Server E2E Test",
  "type": "extensionHost",
  "request": "launch",
  "runtimeExecutable": "${execPath}",
  "args": [
    "--extensionDevelopmentPath=${workspaceRoot}",
    "--extensionTestsPath=${workspaceRoot}/client/out/test/index",
    "${workspaceRoot}/client/testFixture"
  ],
  "outFiles": ["${workspaceRoot}/client/out/test/**/*.js"]
}

如果您运行此调试目标，它将启动一个以 client/testFixture 为活动工作区的 VS Code 实例。然后 VS Code 将继续执行 client/src/test 中的所有测试。作为调试技巧，您可以在 client/src/test 的 TypeScript 文件中设置断点，它们会被命中。

让我们看看 completion.test.ts 文件：

import * as vscode from 'vscode';
import * as assert from 'assert';
import { getDocUri, activate } from './helper';

suite('Should do completion', () => {
  const docUri = getDocUri('completion.txt');

  test('Completes JS/TS in txt file', async () => {
    await testCompletion(docUri, new vscode.Position(0, 0), {
      items: [
        { label: 'JavaScript', kind: vscode.CompletionItemKind.Text },
        { label: 'TypeScript', kind: vscode.CompletionItemKind.Text }
      ]
    });
  });
});

async function testCompletion(
  docUri: vscode.Uri,
  position: vscode.Position,
  expectedCompletionList: vscode.CompletionList
) {
  await activate(docUri);

  // Executing the command `vscode.executeCompletionItemProvider` to simulate triggering completion
  const actualCompletionList = (await vscode.commands.executeCommand(
    'vscode.executeCompletionItemProvider',
    docUri,
    position
  )) as vscode.CompletionList;

  assert.ok(actualCompletionList.items.length >= 2);
  expectedCompletionList.items.forEach((expectedItem, i) => {
    const actualItem = actualCompletionList.items[i];
    assert.equal(actualItem.label, expectedItem.label);
    assert.equal(actualItem.kind, expectedItem.kind);
  });
}

在此测试中，我们：

  • 激活扩展。
  • 使用 URI 和位置运行 vscode.executeCompletionItemProvider 命令以模拟补全触发。
  • 断言返回的补全项与我们预期的补全项一致。

让我们深入研究 activate(docURI) 函数。它定义在 client/src/test/helper.ts 中：

import * as vscode from 'vscode';
import * as path from 'path';

export let doc: vscode.TextDocument;
export let editor: vscode.TextEditor;
export let documentEol: string;
export let platformEol: string;

/**
 * Activates the vscode.lsp-sample extension
 */
export async function activate(docUri: vscode.Uri) {
  // The extensionId is `publisher.name` from package.json
  const ext = vscode.extensions.getExtension('vscode-samples.lsp-sample')!;
  await ext.activate();
  try {
    doc = await vscode.workspace.openTextDocument(docUri);
    editor = await vscode.window.showTextDocument(doc);
    await sleep(2000); // Wait for server activation
  } catch (e) {
    console.error(e);
  }
}

async function sleep(ms: number) {
  return new Promise(resolve => setTimeout(resolve, ms));
}

在激活部分，我们：

  • 使用 package.json 中定义的 {publisher.name}.{extensionId} 获取扩展。
  • 打开指定的文档，并在活动文本编辑器中显示它。
  • 等待 2 秒，以确保语言服务器已完成实例化。

准备工作完成后，我们可以运行对应于每种语言功能的 VS Code 命令，并对返回的结果进行断言。

还有一个测试覆盖了我们刚刚实现的诊断功能。查看 client/src/test/diagnostics.test.ts。

高级主题

到目前为止，本指南涵盖了：

  • 语言服务器和语言服务器协议的简要概述。
  • VS Code 中语言服务器扩展的架构。
  • lsp-sample 扩展，以及如何开发/调试/检查/测试它。

还有一些更高级的主题我们无法在本指南中一一介绍。我们将提供这些资源的链接，供您深入研究语言服务器开发。

额外的语言服务器功能

除了代码补全外，语言服务器目前还支持以下语言功能：

  • 文档高亮：高亮显示文本文档中所有“相同”的符号。
  • 悬停提示：为在文本文档中选择的符号提供悬停信息。
  • 签名帮助：为在文本文档中选择的符号提供签名帮助。
  • 转到定义：为在文本文档中选择的符号提供转到定义支持。
  • 转到类型定义：为在文本文档中选择的符号提供转到类型/接口定义支持。
  • 转到实现：为在文本文档中选择的符号提供转到实现定义支持。
  • 查找引用：为在文本文档中选择的符号查找项目范围内的所有引用。
  • 列出文档符号：列出在文本文档中定义的所有符号。
  • 列出工作区符号：列出项目范围内的所有符号。
  • 代码操作：为给定的文本文档和范围计算要运行的命令（通常用于美化/重构）。
  • CodeLens：为给定的文本文档计算 CodeLens 统计信息。
  • 文档格式化：这包括整个文档的格式化、文档范围格式化以及输入时格式化。
  • 重命名：项目范围内的符号重命名。
  • 文档链接：计算和解析文档内部的链接。
  • 文档颜色：计算和解析文档内部的颜色，以在编辑器中提供颜色选择器。

程序化语言功能主题详细描述了上述每种语言功能，并提供了关于如何通过语言服务器协议或直接使用扩展 API 来实现它们的指导。

增量文本文档同步

该示例使用了 vscode-languageserver 模块提供的简单文本文档管理器来同步 VS Code 和语言服务器之间的文档。

这有两个缺点：

  • 传输了大量数据，因为文本文档的全部内容会被反复发送到服务器。
  • 如果使用现有的语言库，这些库通常支持增量文档更新，以避免不必要的解析和抽象语法树创建。

因此，协议也支持增量文档同步。

要利用增量文档同步，服务器需要安装三个通知处理程序：

  • onDidOpenTextDocument：在 VS Code 中打开文本文档时调用。
  • onDidChangeTextDocument：在 VS Code 中文本文档内容发生更改时调用。
  • onDidCloseTextDocument：在 VS Code 中关闭文本文档时调用。

下面的代码片段展示了如何在连接上挂载这些通知处理程序，以及如何在初始化时返回正确的功能：

connection.onInitialize((params): InitializeResult => {
    ...
    return {
        capabilities: {
            // Enable incremental document sync
            textDocumentSync: TextDocumentSyncKind.Incremental,
            ...
        }
    };
});

connection.onDidOpenTextDocument((params) => {
    // A text document was opened in VS Code.
    // params.uri uniquely identifies the document. For documents stored on disk, this is a file URI.
    // params.text the initial full content of the document.
});

connection.onDidChangeTextDocument((params) => {
    // The content of a text document has change in VS Code.
    // params.uri uniquely identifies the document.
    // params.contentChanges describe the content changes to the document.
});

connection.onDidCloseTextDocument((params) => {
    // A text document was closed in VS Code.
    // params.uri uniquely identifies the document.
});

/*
Make the text document manager listen on the connection
for open, change and close text document events.

Comment out this line to allow `connection.onDidOpenTextDocument`,
`connection.onDidChangeTextDocument`, and `connection.onDidCloseTextDocument` to handle the events
*/
// documents.listen(connection);

直接使用 VS Code API 实现语言功能

虽然语言服务器有很多好处，但它们并不是扩展 VS Code 编辑功能的唯一选择。在您只想为某种类型的文档添加一些简单语言功能的情况下，可以考虑使用 vscode.languages.register[LANGUAGE_FEATURE]Provider 作为选项。

这是一个使用 vscode.languages.registerCompletionItemProvider 为纯文本文件添加一些代码片段作为补全的 completions-sample。

更多展示 VS Code API 用法的示例可以在 https://github.com/microsoft/vscode-extension-samples 找到。

语言服务器的容错解析器

大多数时候，编辑器中的代码是不完整的且在语法上不正确的，但开发人员仍然期望自动补全和其他语言功能能够工作。因此，语言服务器需要一个容错解析器：解析器从部分完整的代码中生成有意义的 AST，而语言服务器则基于 AST 提供语言功能。

当我们改进 VS Code 中的 PHP 支持时，我们意识到官方的 PHP 解析器不具备容错性，无法直接在语言服务器中复用。因此，我们开发了 Microsoft/tolerant-php-parser，并留下了详细的说明文档，可能对需要实现容错解析器的语言服务器作者有所帮助。

常见问题

当我尝试附加到服务器时，出现“无法连接到运行时进程（5000 毫秒后超时）”的错误？

如果您在尝试附加调试器时服务器没有运行，您将看到此超时错误。客户端启动语言服务器，因此请确保您已启动客户端以使服务器处于运行状态。如果客户端断点干扰了服务器的启动，您可能还需要禁用客户端断点。

我已经通读了本指南和 LSP 规范，但仍有未解决的问题。我该去哪里寻求帮助？

请在 https://github.com/microsoft/language-server-protocol 提交 issue。

5/28/2026
English 한국어 中文(简体) 中文(繁體)
© . This site is unofficial and not affiliated with Microsoft.