VSCode扩展开发：FileSystem与FileSystemProvider的区别及适用场景

什么时候用 FileSystem #

• 这是VSCode提供的现成工具类，直接调用就能操作本地或已挂载的文件系统，比如读文件、写文件、遍历目录这类常规操作。
• 只要你的扩展只需要和本地文件、或者VSCode已经支持的远程文件系统（比如SSH、WSL）交互，直接用它就够了。
• 示例代码（读取本地文件）：

import * as vscode from 'vscode';

async function readLocalFile() {
  const fileUri = vscode.Uri.file('/Users/xxx/documents/note.txt');
  const rawContent = await vscode.workspace.fs.readFile(fileUri);
  console.log(Buffer.from(rawContent).toString());
}

什么时候用 FileSystemProvider #

• 这是一套接口规范，用来让你实现自定义文件系统。比如你想让VSCode支持访问云存储、数据库里的虚拟文件、甚至内存中的临时文件系统，就需要实现这个接口。
• 实现后，你的扩展可以把自定义文件系统挂载到VSCode中，用户就能像操作本地文件一样操作这些特殊资源。
• 你需要实现接口里的核心方法（比如readFile、readDirectory、writeFile），告诉VSCode怎么处理自定义资源的读写逻辑。
• 示例代码（自定义文件系统框架）：

import * as vscode from 'vscode';

class CloudFileSystemProvider implements vscode.FileSystemProvider {
  // 实现读取文件逻辑（比如从云存储拉取）
  async readFile(uri: vscode.Uri): Promise<Uint8Array> {
    // 这里替换为你的云存储读取逻辑
    return new Uint8Array(Buffer.from('从云存储获取的文件内容'));
  }

  // 实现读取目录逻辑
  async readDirectory(uri: vscode.Uri): Promise<[string, vscode.FileType][]> {
    // 返回云存储目录下的文件列表
    return [['report.pdf', vscode.FileType.File], ['photos', vscode.FileType.Directory]];
  }

  // 必须实现的其他核心方法
  async writeFile(uri: vscode.Uri, content: Uint8Array, options: { create: boolean; overwrite: boolean; }): Promise<void> {
    // 自定义写入云存储的逻辑
  }

  // 省略delete、rename等其他必填方法...
}

// 注册自定义文件系统，协议名为cloud-fs
vscode.workspace.registerFileSystemProvider('cloud-fs', new CloudFileSystemProvider());

一句话总结 #

用FileSystem来「使用」现有文件系统，用FileSystemProvider来「创建」新的文件系统。常规文件操作选前者，要扩展VSCode的文件系统支持能力选后者。

内容的提问来源于stack exchange，提问作者nimish642