基于Language Server Protocol实现VSCode扩展时，如何获取跳转定义触发位置的文本/符号

没错，你猜的完全对——每次触发onDefinition时，你确实需要主动获取对应文档的内容，再定位到指定行和字符位置，提取出当前触发的符号文本。毕竟Language Server本身不会默认缓存所有文档的内容，得按需去拿目标位置的信息。

下面是具体的实现步骤和代码修改方案：

1. 获取目标文档的内容 #

通过connection.workspace.getTextDocument()方法，传入TextDocumentPositionParams里的documentUri，就能拿到对应的TextDocument对象，这个对象包含了文档的完整文本内容。

2. 定位符号的边界 #

拿到文档后，先获取触发位置所在行的文本，然后从当前字符位置出发，向前、向后扫描，找到单词的起始和结束位置（这里的“单词”可以根据你目标语言的语法调整匹配规则）。

3. 提取符号并调用定义查询 #

提取出完整的符号文本后，再传给你的refManager去获取定义位置。

修改后的完整代码 #

export default class DefinitionFinder extends Handler {
 constructor(
  protected connection: Connection,
  private refManager: ReferenceManager
 ) {
  super();
  this.connection.onDefinition(async (textPosition) => {
   return this.handleErrors(
    this.getDefinition(textPosition),
    undefined
   ) as Promise<Definition>;
  });
 }

 private async getDefinition(textPosition: TextDocumentPositionParams): Promise<Location[]> {
  // 1. 获取目标文档对象
  const targetDoc = this.connection.workspace.getTextDocument(textPosition.textDocument.uri);
  if (!targetDoc) {
    // 处理文档不存在的异常情况
    return [];
  }

  // 2. 获取触发位置所在的行文本
  const lineRange = {
    start: { line: textPosition.position.line, character: 0 },
    end: { line: textPosition.position.line + 1, character: 0 }
  };
  const lineText = targetDoc.getText(lineRange).trimEnd(); // 移除行尾的换行符

  // 3. 定位当前符号的边界
  const currentCharPos = textPosition.position.character;
  let symbolStart = currentCharPos;
  let symbolEnd = currentCharPos;

  // 向前扫描：匹配字母、数字、下划线（可根据你的语言语法调整正则）
  while (symbolStart > 0 && /[\w]/.test(lineText[symbolStart - 1])) {
    symbolStart--;
  }

  // 向后扫描：匹配字母、数字、下划线
  while (symbolEnd < lineText.length && /[\w]/.test(lineText[symbolEnd])) {
    symbolEnd++;
  }

  // 4. 提取触发的符号文本
  const targetSymbol = lineText.slice(symbolStart, symbolEnd);
  if (!targetSymbol) {
    return [];
  }

  // 5. 查询并返回定义位置
  return this.refManager.getDefinitionLocations(targetSymbol);
 }
}

额外注意事项 #

• 正则匹配规则：上面用/[\w]/匹配字母、数字和下划线，如果你的目标语言支持其他符号（比如$、-），可以修改正则表达式，比如/[\w$]/或者自定义字符集。
• 文档缓存：如果你的Server需要处理大量大型文档，建议自己实现一套文档缓存机制，避免重复从客户端获取文档内容，提升性能。
• 异常处理：别忘了处理文档不存在、符号为空等边界情况，避免Server崩溃。

内容的提问来源于stack exchange，提问作者Mauricio Gracia Gutierrez