跳到主要内容
版本：v8

打包插件

ScreenOrientation 插件在功能上已经完成，并且作为本地插件集成到了 Capacitor 应用中。然而，ScreenOrientation 插件目前的状态无法被其他 Capacitor 应用使用。

让我们继续打包这个插件以便发布，使 ScreenOrientation 插件能够全局可用。

注意： 本节参考了 Capacitor 文档中 创建 Capacitor 插件 部分的步骤和流程。关于本教程范围之外的详细信息，请参阅相关文档。

生成新的插件项目​

Capacitor 提供了一个 插件生成器，我们可以用它来搭建一个适合发布全局插件的项目结构。

在新的终端中，运行以下命令：

npx @capacitor/create-plugin \
  --name @capacitor-community/screen-orientation \
  --package-id io.ionic.plugins.screenorientation \
  --class-name ScreenOrientation \
  --repo "https://ionic.io" \
  --license "MIT" \
  --description "Work with the screen orientation in a common way for iOS, Android, and web"

当提示提供目录时，按 Enter 键使用默认值。当询问作者姓名时，请填写你自己的名字！

移植插件代码​

查看生成项目的结构；它看起来与为 Capacitor 应用构建的结构非常相似，不是吗？🤔

显然，这是有意为之，以便轻松地将插件代码从 Capacitor 应用的代码库移植到生成的插件项目中。

将 src/plugins/screen-orientation 目录下文件的内容复制到插件项目中对应的 web.ts、index.ts 和 definitions.ts 文件中。

接下来，将一个代码库中的 ScreenOrientation.swift、ScreenOrientationPlugin.m 和 ScreenOrientationPlugin.swift 的内容复制到另一个代码库中。

然后，对 ScreenOrientation.java 和 ScreenOrientationPlugin.java 执行相同的操作。之后，在插件项目中更新这些文件的包名：

package io.ionic.plugins.screenorientation

上面的包名是在生成插件项目时提供的，项目中的任何 Android 文件都应使用此包名。

最后，运行以下命令来验证代码移植过程中是否出现问题：

npm run verify

注意： 你可以在发布插件之前，通过将插件文件夹链接到 Capacitor 项目来测试插件。详情请参阅 插件开发工作流程。

更新插件文档​

查看插件项目的 README.md 文件；它已被更新以记录插件的 API。这个更新是在我们运行 npm run verify 时发生的。对源文件 JSDoc 注释的任何更改都可以通过运行 npm run docgen 反映在 readme 文件的 API 部分中。

该插件要求开发者修改其 Capacitor 应用的 AppDelegate.swift 文件，因此应在插件文档中包含如何操作的说明。

注意： 请务必记录开发者在安装或配置你构建的插件时需要进行的任何修改。

将 README.md 中的“安装”部分替换为以下 Markdown 内容：

安装​

npm install @capacitor-community/screen-orientation
npx cap sync

iOS​

对于 iOS，你必须对 AppDelegate.swift 文件进行以下调整：

import UIKit
+ import CapacitorCommunityScreenOrientation

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
+   func application(_ application: UIApplication, supportedInterfaceOrientationsFor window: UIWindow?) -\> UIInterfaceOrientationMask {
+     return ScreenOrientationPlugin.supportedOrientations
+  }
}

发布插件​

插件现在已经处于可以发布到 npm 注册表的状态。本教程中我们不会实际发布，但请注意，发布 Capacitor 插件项目的命令与发布任何其他 npm 包相同：npm publish。

你可以将全局 Capacitor 插件发布到公共 npm 注册表、私有注册表，或者仅将其链接到你机器本地的多个项目。具体方式取决于你的使用场景。

此外，还有一个 Capacitor 社区 GitHub 组织，你可以在其中托管你的插件，并在继续开发和维护插件时与社区和 Capacitor 团队紧密合作。

结论​

Capacitor 的插件 API 是一个灵活且强大的解决方案，可以为 Capacitor 应用补充 Web 平台无法提供的原生功能，无论是为特定应用添加自定义原生代码，还是在多个应用之间复用原生代码。

期待你接下来开发的插件！🎉

Contents

编辑此页