Workers

Deno 支持 Web Worker API .

Worker 可以在多个线程中运行代码,Worker 的每个实例都会在单独的线程中运行,这个线程专属于 worker。

目前,Deno 只支持 module 类型的 worker,因此在创建新的 worker 时必须传递 type: "module" 选项。

只有在 CLI 上传 --location <href>,才支持在主 worker 中使用相对模块说明符。为了便捷性,不建议这样做。你可以使用 URL 构造函数和 import.meta.url 来为一些周围的脚本轻松创建说明符。但是,对于一些专门的 worker,它们有默认的位置和能力。

// Good
new Worker(new URL("./worker.js", import.meta.url).href, { type: "module" });

// Bad
new Worker(new URL("./worker.js", import.meta.url).href);
new Worker(new URL("./worker.js", import.meta.url).href, { type: "classic" });
new Worker("./worker.js", { type: "module" });

实例化权限

创建一个新的 Worker 实例的行为与动态导入类似,因此 Deno 需要适当的权限来做这个操作。

对于使用本地模块的 worker,Deno 需要读取 (--allow-read) 权限:

main.ts

new Worker(new URL("./worker.ts", import.meta.url).href, { type: "module" });

worker.ts

console.log("hello world");
self.close();
$ deno run main.ts
error: Uncaught PermissionDenied: read access to "./worker.ts", run again with the --allow-read flag

$ deno run --allow-read main.ts
hello world

对于使用远程模块的 worker,Deno 需要网络 (--allow-net) 权限:

main.ts

new Worker("https://example.com/worker.ts", { type: "module" });

worker.ts (at https ://example.com/worker.ts)

console.log("hello world");
self.close();
$ deno run main.ts
error: Uncaught PermissionDenied: net access to "https://example.com/worker.ts", run again with the --allow-net flag

$ deno run --allow-net main.ts
hello world

在 Worker 中使用 Deno

这是一个不稳定的 Deno 特性。更多信息请查阅 不稳定特性

默认情况下,Deno 命名空间在 worker 作用域中不可用。

要想启用 Deno 命名空间,在创建新的 worker 时传递 deno.namespace = true 选项:

main.js

const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
  type: "module",
  deno: {
    namespace: true,
  },
});
worker.postMessage({ filename: "./log.txt" });

worker.js

self.onmessage = async (e) => {
  const { filename } = e.data;
  const text = await Deno.readTextFile(filename);
  console.log(text);
  self.close();
};

log.txt

hello world
$ deno run --allow-read --unstable main.js
hello world

详述 worker 权限

这是一个不稳定的 Deno 特性。更多信息请查阅 不稳定特性

Worker 可用的权限类似于 CLI 权限标志,这意味着在那里启用的每个权限都可以在 Worker API 层面上被禁用。你可以在 这里 找到每个权限选项更详细的描述。

默认情况下,worker 将从其创建的线程中继承权限,但为了允许用户限制该 worker 的访问,我们在 worker API 中提供了 deno.permissions 选项。

  • 对于支持更细访问的权限,你可以传入 worker 访问的所需资源的列表,对于只有 on/off 选项的 worker,你可以分别传入 true/false。

    const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
      type: "module",
      deno: {
        namespace: true,
        permissions: {
          net: [
            "https://deno.land/",
          ],
          read: [
            new URL("./file_1.txt", import.meta.url),
            new URL("./file_2.txt", import.meta.url),
          ],
          write: false,
        },
      },
    });
  • 更细的访问权限可接收绝对和相对路由作为参数,但要考虑到,相对路由将相对于 worker 实例化的文件进行解析,而不是 worker 文件当前所在的路径。

    const worker = new Worker(
      new URL("./worker/worker.js", import.meta.url).href,
      {
        type: "module",
        deno: {
          namespace: true,
          permissions: {
            read: [
              "/home/user/Documents/deno/worker/file_1.txt",
              "./worker/file_2.txt",
            ],
          },
        },
      },
    );
  • deno.permissions 和它的孩子们都支持 "inherit" 选项,这意味着它将借用其父辈的权限。

    // 这个 worker 将继承其父辈的权限
    const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
      type: "module",
      deno: {
        namespace: true,
        permissions: "inherit",
      },
    });
    // 这个 worker 将只继承其父辈的网络权限
    const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
      type: "module",
      deno: {
        namespace: true,
        permissions: {
          env: false,
          hrtime: false,
          net: "inherit",
          ffi: false,
          read: false,
          run: false,
          write: false,
        },
      },
    });
  • 未指定 deno.permissions 选项或其子选项之一,将导致 worker 默认继承权限。

    // 这个 worker 将继承其父辈的权限
    const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
      type: "module",
    });
    // 这个 worker 将会继承其父辈除了网络以外的所有权限
    const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
      type: "module",
      deno: {
        namespace: true,
        permissions: {
          net: false,
        },
      },
    });
  • 你可以通过 deno.permissions 选项中传 "none" 来禁用 worker 的所有权限。

    // 这个 worker 将不会有任何权限被启用
    const worker = new Worker(new URL("./worker.js", import.meta.url).href, {
      type: "module",
      deno: {
        namespace: true,
        permissions: "none",
      },
    });