跳到主要内容
版本：v8

在插件中将 Capacitor 升级到 3.0

对于正在升级到 Capacitor 3 的插件，有一些必需的和推荐的更改。

规划核心 API​

目前，核心团队很难在不影响插件的情况下对 Capacitor 的内部进行更改。由于 Capacitor 2 中大多数类和方法对 iOS 和 Android 都是 public 的，我们观察到了一些我们认为属于内部的 Capacitor API 被不当使用。

在 Capacitor 3 的开发过程中，我们将评估这个问题，并为插件创建一个官方的 public API，该 API 将在此处文档化。

Android​

使用新的 @CapacitorPlugin 注解​

@NativePlugin 注解已弃用。我们现在建议使用新的 @CapacitorPlugin 注解，它将支持新的权限 API。

name 属性保持不变。requestCodes 和 permissionRequestCode 属性已被移除。permissions 属性需要替换为 @Permission 注解列表，每个注解包含一组清单字符串及其对应的 alias，在新的权限 API 在你的插件中实现之前，你可以暂时省略 alias。

-@NativePlugin(
+@CapacitorPlugin(
     name = "FooBar",
-    requestCodes = {
-        FooBarPlugin.REQUEST_SOME_METHOD,
-        FooBarPlugin.REQUEST_SOME_OTHER_METHOD
-    },
-    permissionRequestCode = FooBarPlugin.REQUEST_ALL_PERMISSIONS,
-    permissions = { Manifest.permission.FOO, Manifest.permission.BAR }
+    permissions = {
+        @Permission(strings = { Manifest.permission.FOO }, alias = "foo"),
+        @Permission(strings = { Manifest.permission.BAR }, alias = "bar")
+    })
 )
 public class FooBarPlugin extends Plugin {
     static final int REQUEST_SOME_METHOD = 10051;
     static final int REQUEST_SOME_OTHER_METHOD = 10052;

Android 请求码​

Capacitor 3.0 实现了 AndroidX Activity Result API 并移除了手动定义的请求码。插件无需提供请求码并重写 handleOnActivityResult 或 handleRequestPermissionsResult，而应使用 @ActivityCallback 或 @PermissionCallback 注解提供回调方法。在启动新的 Activity 或权限请求时，可以引用这些回调。

-static final int IMAGE_REQUEST = 10052;

 @PluginMethod
 public void chooseImage(PluginCall call) {
     Intent intent = new Intent(Intent.ACTION_PICK);
     intent.setType("image/*");
-    startActivityForResult(call, intent, IMAGE_REQUEST);
+    startActivityForResult(call, intent, "chooseImageResult");
 }

+@ActivityCallback
+private void chooseImageResult(PluginCall call, ActivityResult result) {
+    if (result.getResultCode() == Activity.RESULT_CANCELED) {
+        call.reject("Activity canceled");
+    } else {
+        Intent data = result.getData();
+        // 对返回的数据进行处理
+        call.resolve("Success!");
+    }
+}

使用 WebColor.parseColor() 替代 Color.parseColor()​

Android 将带有 Alpha 通道的十六进制颜色字符串解析为 ARGB，而在 iOS 和 Web 中它们被解析为 RGBA。如果你在跨平台共享带有 Alpha 通道的颜色，请务必使用新的 WebColor 工具类。WebColor.parseColor() 的工作方式类似于原生 Android 的 Color.parseColor() 函数，但将字符串解析为 RGBA。

String colorStringWithAlpha = "#FF000088"; // 半透明红色
int color = WebColor.parseColor(colorStringWithAlpha);

如果你的颜色没有 Alpha 通道，两个函数将返回相同的结果。

将默认的 compileSdkVersion 和 targetSdkVersion 更改为 30​

在 android/build.gradle 中将 compileSdkVersion 和 targetSdkVersion 的默认值更改为 30。

android {
-   compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 29
+   compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
    defaultConfig {
        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
-       targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 29
+       targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
        ...
    }
    ...
}

iOS​

弱引用​

Capacitor 3 中更新了对象之间的关系以修复内存泄漏。其结果是，插件对层级结构中较高对象的引用现在是 weak 的，这意味着在 Swift 中它们是 optional 的。你最可能在访问 bridge 时遇到此更改，但它也适用于其他属性，如 webView。调用 bridge 上的方法基本没有变化，只是现在需要使用可选链：

-bridge.presentVC(myViewController, animated: true, completion: nil)
+bridge?.presentVC(myViewController, animated: true, completion: nil)

此更改的最大影响是 bridge 的所有返回值也将变为 optional。安全处理和展开 optional 可能需要额外的步骤。

if bridge?.isSimEnvironment {
     // 错误：无法编译。布尔值是 optional 的（因为 `bridge` 是 optional 的）
     // 在对其进行求值之前必须先展开。
}
if bridge?.isSimEnvironment == true {
     // 中性：对于布尔值，显式与 optional 比较可以工作，但
     // 可能不适用于所有数据类型。
}
if let isSim = bridge?.isSimEnvironment, isSim {
     // 正确：使用可选绑定在检查其值之前展开 optional。
}

Bridge 变更​

除了引用从 strong 变为 weak 之外，bridge 本身的 API 也进行了更新（现在通过更正式的协议暴露）。许多属性和方法已重命名，但在可能的情况下通过保留和弃用旧接口提供了向后兼容性。在大多数情况下，Xcode 能够自动建议新的替代方案。你应该迁移任何现有代码，以便你的插件可以在没有编译器警告的情况下构建。

Xcode 自动更正建议

CAPPluginCall 参数​

Capacitor 在 CAPPluginCall 上包含一系列便捷方法（getString、getDate 等），用于访问从 JavaScript 传递到插件方法的数据。这些方法已在 Capacitor 3 中更新。

  • get() 已被移除。如果你想直接访问参数，请读取 options 字典。
  • hasOption 已弃用。请使用类型化访问器之一来检查值。
  • 任何接受默认值的访问器现在需要非 optional 的默认值，但返回非 optional 的结果。这可能会改变你的局部变量的 optional 性，但应该会减少强制展开的使用，这在 Swift 中是一种反模式。
  • 关于日期和空值的行为已略有更改并提供了更好的文档。在此处了解更多信息。
  • Obj-C 便捷访问器已分离出来，以避免与 Swift 实现冲突。如果你在 Obj-C 中工作，你需要通过在你的 .m 文件中添加 #import <Capacitor/CAPBridgedJSTypes.h> 来单独导入它们。

对 PluginCall 和 CAPPluginCall 的更改​

使用 resolve() 和 reject()​

我们认为 resolve() 和 reject() 更好地反映了插件方法预期的 Promise 式流程。即使是在回调风格的插件方法中，也应优先使用它们而不是 success() 和 error()（现已弃用）。

不带参数调用 resolve() 现在解析为 undefined​

以前，不带参数调用 resolve() 会导致向 JavaScript 层发送空对象。由于这与 JavaScript 的 Promise.resolve() 的行为不同，从 Capacitor 3 开始，改为发送 undefined。

保存调用​

save() 方法已弃用，并添加了替代属性 keepAlive。保存调用的推荐模式已有文档说明以阐明行为。在此处阅读更多信息。

将 iOS 部署目标设置为 12.0​

在插件 Xcode 项目和插件 Target 中执行以下操作：打开 Build Settings 选项卡。在 Deployment 部分下，将 iOS Deployment Target 更改为 iOS 12.0。

然后，打开 ios/Podfile 并将 iOS 版本更新为 12.0：

-platform :ios, '11.0'
+platform :ios, '12.0'
 use_frameworks!

最后，打开 pluginName.podspec 并将 iOS 版本更新为 12.0：

-s.ios.deployment_target  = '11.0'
+s.ios.deployment_target  = '12.0'

将 Swift 版本设置为 5​

打开 Xcode 目标中的 Build Settings 选项卡，然后在 Swift Compiler - Language 部分下将 Swift Language Version 更改为 Swift 5。

然后，打开 pluginName.podspec 并将 Swift 版本更新为 5.1：

-s.swift_version = '4.2'
+s.swift_version = '5.1'

Web​

注册插件​

registerWebPlugin(MyPlugin) 函数已弃用。我们建议使用新的 registerPlugin 函数并延迟加载 web（以及可选的 electron）插件，如下所示。

import { registerPlugin } from '@capacitor/core';
import type { CoolPlugin } from './definitions';

const MyCoolPlugin = registerPlugin<CoolPlugin>('MyCoolPlugin', {
  web: () => import('./web').then(m => new m.MyCoolPluginWeb()),
  // electron: () => ("./electron").then(m => new m.MyCoolPluginElectron())
});

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

将 TypeScript 输出设置为 es2017​

如果你使用 TypeScript 开发 web 插件，我们建议你在 tsconfig.json 中将输出目标设置为 es2017。

评估错误处理​

我们现在建议插件作者使用 Capacitor 3 中的新错误码：

  • Unavailable：表示当前无法使用该功能
  • Unimplemented：表示该功能无法或不会被实现，或者可能在将来实现

阅读更多关于 Web、iOS 和 Android 的错误处理。

采用新的权限 API​

在 3.0 之前，期望插件在功能使用前自动请求权限。例如，地理定位插件会在首次请求用户位置时自动请求权限，然后根据权限被授予或拒绝的情况继续执行。

Capacitor 3 的一个目标是让应用开发者能够随时请求或检查权限，并控制如何以及何时向用户显示提示。这通过允许应用以多种方式响应用户的选择，提供了更大的用户体验灵活性。

继续自动请求权限是完全可行的，但我们也鼓励你采用新的权限模式，以便让应用开发者能够控制权限。

了解如何在你的插件中实现权限 API ›

Contents

编辑此页