跳到主要内容
版本：v8

设计插件 API

构建 Capacitor 插件的第一步——也可以说是最重要的一步——就是设计 API。API 是我们在编写每个平台特定实现时将要遵守的契约。

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

等等，你真的需要为此做一个插件吗？​

信不信由你，现代 Web 浏览器可以做许多我们认为是"原生功能"的事情，比如检查电池状态、语音识别，以及，是的，屏幕方向。在构建 Web 原生应用时，曾经需要插件才能访问的功能，现在作为 Web API 可用的情况并不少见。

在为特定功能构建插件之前，我们建议查看诸如 What Web Can Do Today 之类的网站，看看你需要的功能是否已经作为 Web API 可用。

如果屏幕方向已经有了 Web API，为什么我们还要费心去构建一个呢？查看 屏幕方向 Web API，我们可以看到 iOS 并未实现该 API（截至撰写本文时），这意味着我们需要自己提供实现。对于 Android，当我们的应用在 Android 平台上运行时，我们可以直接使用屏幕方向 Web API——但出于教学目的，我们将原生实现屏幕方向功能。

定义 ScreenOrientation API​

我们可能无法直接使用屏幕方向 Web API，但我们可以将插件的 API 建模为与之类似：

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

这里有一个额外的好处；我们可以使用 TypeScript 现有 DOM 类型定义中的 OrientationType 类型。OrientationLockType 自 TypeScript 5.2+ 起已不再可用，因此我们将为其提供定义。

让我们建立一个目录来存放我们的插件 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

编辑此页