跳到主要内容
版本：v6

设计插件 API

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

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

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

信不信由你，现代 Web 浏览器可以做到许多我们认为是"原生功能"的事情，比如检查电池状态、语音识别，以及——没错——屏幕方向。在构建 Web 原生应用时，曾经需要插件才能访问的功能现在已经成为 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<{ type: OrientationType }>
lock{ orientation: OrientationLockType }Promise<void>
unlockPromise<void>
addListener(orientation: { type: OrientationType })Promise<PluginListenerHandle> & PluginListenerHandle
removeAllListenersPromise<void>

这里有一个额外的好处；我们可以使用 TypeScript 现有 DOM 类型中可用的 OrientationType 和 OrientationLockType 类型。

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

  • definitions.ts
  • index.ts

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

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

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

  /**
   * 锁定屏幕方向。
   */
  lock(opts: { orientation: OrientationLockType }): Promise<void>;

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

  /**
   * 监听屏幕方向变化。
   */
  addListener(
    eventName: 'screenOrientationChange',
    listenerFunc: (orientation: { type: OrientationType }) => void,
  ): Promise<PluginListenerHandle> & 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

编辑此页