跳到主要内容
版本：v7

Capacitor Web/PWA 插件指南

Capacitor 采用了一个 Web/原生兼容层，使得构建插件变得容易，无论是在原生环境运行还是在 Web 上的 PWA 中运行，都能具备相应的功能。

开始使用​

首先，请按照插件指南中开始使用部分的说明生成一个插件。

接下来，在你选择的编辑器中打开 echo/src/web.ts 文件。

示例​

Capacitor 的 Web 插件基本结构如下所示：

import { WebPlugin } from '@capacitor/core';

import type { EchoPlugin } from './definitions';

export class EchoWeb extends WebPlugin implements EchoPlugin {
  async echo(options: { value: string }) {
    console.log('ECHO', options);
    return options;
  }
}

EchoPlugin 接口定义了插件的方法签名。在 TypeScript 中，我们可以确保 Web 实现（EchoWeb 类）正确地实现了该接口。

权限管理​

如果你的插件在 Web 端具有需要最终用户授权的功能，那么你需要实现权限管理模式。

权限别名​

你需要为插件所需的权限开发一个或多个别名，用于抽象和分组权限。这些别名用于传达权限状态。默认情况下，别名可以处于以下状态之一：

  • granted：该别名下的所有权限都已被最终用户授予（或者无需提示）。
  • denied：该别名下的一个或多个权限已被最终用户拒绝。
  • prompt：应向最终用户请求权限，因为权限既未被授予也未被拒绝。
  • prompt-with-rationale：最终用户之前拒绝了权限，但尚未阻止提示。

这些状态由从 @capacitor/core 导出的 PermissionState 类型表示。

如果需要，也可以为别名定义自定义状态。例如，官方的相机插件为 camera 和 photos 别名还定义了一个 limited 状态。

别名是跨平台的，因此在决定插件的别名时，请确保考虑 iOS、Android 和 Web 的权限设置。

权限状态定义​

在 src/definitions.ts 中，从 Capacitor 导入 PermissionState，并定义一个 PermissionStatus 接口，该接口表示插件中的权限状态，键名为你设定的别名。

在下面的示例中，权限状态可以完全由一个 location 别名表示，该别名可以是 granted、denied 等。

import type { PermissionState } from '@capacitor/core';

export interface PermissionStatus {
  // TODO: 将 'location' 更改为你实际的别名名称！
  location: PermissionState;
}

然后，在你的插件接口中添加 checkPermissions() 和 requestPermissions() 的定义。这两个方法都将返回插件中权限的当前状态，如 PermissionStatus 所定义。

 export interface EchoPlugin {
   echo(options: { value: string }): Promise<{ value: string }>;
+  checkPermissions(): Promise<PermissionStatus>;
+  requestPermissions(): Promise<PermissionStatus>;
 }

因为这些方法被添加到了你的插件接口中，所以它们必须在插件支持的所有平台上实现。

实现权限管理​

在 src/web.ts 中，将 checkPermissions() 和 requestPermissions() 方法添加到你的 Web 实现中。

+import { PermissionStatus } from './definitions';

 export class EchoWeb extends WebPlugin implements EchoPlugin {
   async echo(options: { value: string }) {
     ...
   }

+  async checkPermissions(): Promise<PermissionStatus> {
+    // TODO
+  }

+  async requestPermissions(): Promise<PermissionStatus> {
+    // TODO
+  }
 }

checkPermissions()​

此方法应返回插件中权限的当前状态。这些信息可能直接来自特定的 Web API，或者来自权限 API。

请记住，在使用浏览器支持不完善的 Web API（例如权限 API）时，你应该实现特性检测，并在最终用户的浏览器不支持时抛出适当的错误。

 async checkPermissions(): Promise<PermissionStatus> {
+  if (typeof navigator === 'undefined' || !navigator.permissions) {
+    throw this.unavailable('Permissions API not available in this browser.');
+  }

   const permission = await navigator.permissions.query( ... );

   // TODO
 }

requestPermissions()​

此方法应提示最终用户授予使用插件所需平台 API 的权限。然后，它应返回提示后插件中权限的新状态（就像 checkPermissions() 方法一样）。

在 Web 端，有时无法将权限请求与实际调用分开。例如，地理定位 API 只在请求位置时才请求权限。对于这种情况，我们建议抛出未实现的异常。

async requestPermissions(): Promise<PermissionStatus> {
  // TODO: Web 端是否支持为我的插件请求权限？
  throw this.unimplemented('Not implemented on web.');
}

错误处理​

Capacitor 的 Web 插件通常要处理一些尚未在某些浏览器中采用甚至远未标准化的 API。尽管如此，为插件的 Web 实现采取尽力而为的方法，并在 API 不可用时优雅地失败，这是很常见的。这就是为什么错误处理在 Web 端尤其重要！

不可用​

此错误应抛出，表示当前无法使用该功能。

原因包括：

  • 当前缺少先决条件，例如网络连接。
  • 需要已实现底层 API 的浏览器。

在下面的示例中，我们首先检查 navigator 上是否定义了 geolocation。如果没有，则表示浏览器不支持地理定位，我们应该抛出“不可用”的错误。否则，我们可以继续实现。

async getLocation(): Promise<Location> {
  if (typeof navigator === 'undefined' || !navigator.geolocation) {
    throw this.unavailable('Geolocation API not available in this browser.');
  }

  // TODO: 实际的 Web 实现
}

未实现​

此错误可以抛出，表示功能尚未实现。你可以用它来在 Web 端暂存你的方法以供后续实现，或者用它来表示功能无法在某个特定平台上实现。

async getLocation(): Promise<Location> {
  throw this.unimplemented('Not implemented on web.');
}

Contents

编辑此页