Electron 中如何注册自定义协议？

推荐答案

在 Electron 中，可以通过 protocol.registerSchemesAsPrivileged 和 protocol.registerFileProtocol 方法来注册自定义协议。以下是一个示例代码：

// www.javascriptcn.com code example
const { app, protocol } = require('electron');

app.whenReady().then(() => {
  // 注册自定义协议
  protocol.registerSchemesAsPrivileged([
    {
      scheme: 'myapp',
      privileges: {
        standard: true,
        secure: true,
        supportFetchAPI: true,
      },
    },
  ]);

  // 注册文件协议
  protocol.registerFileProtocol('myapp', (request, callback) => {
    const url = request.url.replace('myapp://', '');
    const filePath = path.join(__dirname, url);
    callback({ path: filePath });
  });
});

本题详细解读

1. protocol.registerSchemesAsPrivileged 方法

protocol.registerSchemesAsPrivileged 方法用于注册自定义协议，并为其设置特权。这个方法需要在 app 模块的 ready 事件之前调用。参数是一个数组，数组中的每个对象代表一个自定义协议，包含以下属性：

• scheme: 自定义协议的名称，例如 myapp。
• privileges: 协议的特权设置，包括：
  • standard: 是否允许协议使用标准 URL 格式。
  • secure: 是否允许协议使用安全上下文。
  • supportFetchAPI: 是否允许协议使用 Fetch API。

2. protocol.registerFileProtocol 方法

protocol.registerFileProtocol 方法用于注册一个自定义协议，并将其与本地文件系统关联。这个方法需要在 app 模块的 ready 事件之后调用。参数包括：

• scheme: 自定义协议的名称，例如 myapp。
• handler: 处理请求的回调函数，接收 request 和 callback 两个参数：
  • request: 包含请求的 URL 等信息。
  • callback: 用于返回处理结果，通常是一个包含 path 属性的对象，指向本地文件路径。

3. 示例代码解析

在示例代码中，首先通过 protocol.registerSchemesAsPrivileged 注册了一个名为 myapp 的自定义协议，并设置了相应的特权。然后，通过 protocol.registerFileProtocol 将 myapp 协议与本地文件系统关联，当访问 myapp:// 开头的 URL 时，Electron 会将请求映射到本地文件系统中的对应文件。

4. 注意事项

• 自定义协议的注册必须在 app 模块的 ready 事件之前完成。
• 自定义协议的 URL 必须以 scheme:// 开头，例如 myapp://。
• 自定义协议的安全性设置需要谨慎处理，避免引入安全漏洞。