跳到主要内容
版本：v7

设计插件 API

构建 Capacitor 插件的第一步——也可以说是最重要的一步——是设计 API。API 是我们编写各平台具体实现时需要遵循的契约。

我们可以使用 TypeScript 来定义插件 API；它将作为我们实现时的契约，并提供 TypeScript 带来的便利，如代码补全和类型检查。

等等，你真的需要为此开发插件吗？​

信不信由你，现代网络浏览器可以完成许多我们认为是“原生功能”的事情，例如检查电池状态、语音识别，以及屏幕方向。在构建 Web Native 应用时，我们常常会发现一些曾经需要插件才能访问的功能，现在已作为 Web API 提供。

在针对特定功能构建插件之前，我们建议查看诸如 What Web Can Do Today 之类的网站，以确认你所需的功能是否已作为 Web API 提供。

如果屏幕方向已有 Web API，我们为何还要费心自己开发一个呢？查看 Screen Orientation Web API 可以发现，iOS 并未实现此 API（截至撰写本文时），这意味着我们需要自行提供实现。至于 Android，我们本可以在应用运行于 Android 平台时直接使用 Screen Orientation Web API——但出于教学目的，我们将以原生方式实现屏幕方向功能。

定义 ScreenOrientation API​

我们或许无法直接使用 Screen Orientation Web API，但可以参照它来设计我们插件的 API：

方法名称输入参数返回值
orientationPromise<ScreenOrientationResult>
lockoptions: OrientationLockOptionsPromise<void>
unlockPromise<void>
addListener(orientation: ScreenOrientationResult)Promise<PluginListenerHandle>
removeAllListenersPromise<void>

这里还有一个额外优势：我们可以使用 TypeScript 现有 DOM 类型中提供的 OrientationType 类型。由于 TypeScript 5.2+ 不再提供 OrientationLockType，我们将自行定义它。

让我们创建一个目录来存放插件 API。在 src/plugins/screen-orientation 下新建一个子文件夹，并在其中添加以下文件：

  • definitions.ts
  • index.ts

在 definitions.ts 中填入以下代码：

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

export interface OrientationLockOptions {
  /**
   * 注意：TypeScript v5.2+ 用户应从 @capacitor/screen-orientation 导入 OrientationLockType。
   */
  orientation: OrientationLockType;
}

export type OrientationLockType =
  | 'any'
  | 'natural'
  | 'landscape'
  | 'portrait'
  | 'portrait-primary'
  | 'portrait-secondary'
  | 'landscape-primary'
  | 'landscape-secondary';

export interface ScreenOrientationResult {
  type: OrientationType;
}

export interface ScreenOrientationPlugin {
  /**
   * 返回屏幕当前方向。
   */
  orientation(): Promise<ScreenOrientationResult>;

  /**
   * 锁定屏幕方向。
   */
  lock(options: OrientationLockOptions): Promise<void>;

  /**
   * 解锁屏幕方向。
   */
  unlock(): Promise<void>;

  /**
   * 监听屏幕方向变化。
   */
  addListener(
    eventName: 'screenOrientationChange',
    listenerFunc: (orientation: ScreenOrientationResult) => void,
  ): Promise<PluginListenerHandle>;

  /**
   * 移除所有监听器。
   */
  removeAllListeners(): Promise<void>;
}

注册 ScreenOrientation 插件​

为了在 Capacitor 应用中使用该插件，我们需要使用 @capacitor/core 导出的 registerPlugin() 模块来注册它。

在 index.ts 中填入以下代码：

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

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

const ScreenOrientation = registerPlugin<ScreenOrientationPlugin>('ScreenOrientation');

export * from './definitions';
export { ScreenOrientation };

上面的代码创建了一个链接到我们插件实现代码的对象。

API 设计已完成；接下来我们将构建一个调用它的用户界面。这样做将使我们在实现每个平台集成时更容易进行测试。下一步：使用插件 API。

Contents

编辑此页