FileSystemSyncAccessHandle

Baseline 2023

Newly available

Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

安全上下文: 此项功能仅在一些支持的浏览器的安全上下文（HTTPS）中可用。

备注： 此特性仅在专用 Web Worker 中可用。

文件系统 API 的 FileSystemSyncAccessHandle 接口用于表示一个指向某个文件系统条目的同步句柄。

这个类只在用于处理对终端用户不可见的源私有文件系统上的文件的专用 Web Worker 中可以访问（这样它的方法就不会阻塞主线程的执行）。

因此，它的方法不受与运行在用户可见文件系统中的文件上的方法相同的安全性检查，从而具有更优秀的性能。这使得这些方法适用于重要的、大规模的文件更新，例如对 SQLite 数据库进行更改。

这个接口通过 FileSystemFileHandle.createSyncAccessHandle() 方法来访问。

备注：在规范早期版本中，FileSystemSyncAccessHandle 的 close()、flush()、getSize() 和 truncate() 被错误地规定为异步方法。某些浏览器的旧版本是依照异步方式来实现这些方法的，不过，现今所有支持这些方法的浏览器都将它们实现为同步方法。

实例属性

无。

实例方法

close()

关闭一个打开的同步文件句柄，禁止之后对其的任何操作并且释放之前加在与文件句柄相关联的文件上的独占锁。

flush()

将通过 write() 方法对句柄相关联的文件所做的所有更改持久化保存到磁盘上。

getSize()

返回与句柄相关联文件的字节大小。

read()

将与句柄相关联文件的内容读取到指定的缓冲区中，可选择在给定的偏移处开始读取。

truncate()

将与句柄相关联文件的大小调整为指定的字节数。

write()

将指定缓冲区中的内容写入到与句柄相关联的文件，可选择在给定的偏移处开始写入。

示例

下面的异步事件处理函数包含在一个 Web Worker 中。当收到来自主线程的消息时，它将执行：

  • 创建一个同步文件访问句柄。
  • 获取文件的大小然后创建一个 ArrayBuffer 来容纳其内容。
  • 将文件内容读取到缓冲区。
  • 将收到的消息编码然后写入到文件的末尾。
  • 将更改保存到磁盘然后关闭访问句柄。
js
onmessage = async (e) => {
  // 接收从主线程发来的消息
  const message = e.data;

  // 获取草稿文件的句柄
  const root = await navigator.storage.getDirectory();
  const draftHandle = await root.getFileHandle("draft.txt", { create: true });
  // 获取同步访问句柄
  const accessHandle = await draftHandle.createSyncAccessHandle();

  // 获取文件的大小
  const fileSize = accessHandle.getSize();
  // 读取文件内容到缓冲区
  const buffer = new DataView(new ArrayBuffer(fileSize));
  const readBuffer = accessHandle.read(buffer, { at: 0 });

  // 将消息写入文件末尾
  const encoder = new TextEncoder();
  const encodedMessage = encoder.encode(message);
  const writeBuffer = accessHandle.write(encodedMessage, { at: readBuffer });

  // 将更改持久化至磁盘
  accessHandle.flush();

  // 如果完成，请始终关闭 FileSystemSyncAccessHandle
  accessHandle.close();
};

规范

Specification
File System Standard
# api-filesystemsyncaccesshandle

浏览器兼容性

BCD tables only load in the browser

参见