跳到主要内容
版本：v6

从 Capacitor 3 更新到 Capacitor 4

与之前的升级相比，Capacitor 3 和 4 之间的破坏性变化相当少。在本指南中，您将找到将项目更新到当前 Capacitor 4 版本的步骤，以及我们官方插件的破坏性更改列表。

使用 CLI 迁移​

使用 npm i -D @capacitor/cli@latest-4 将最新版本的 Capacitor CLI 安装到项目中。安装后，只需运行 npx cap migrate 即可让 CLI 为您处理迁移。如果迁移的任何步骤无法完成，终端输出中将提供额外信息。下面列出了手动迁移的步骤。

iOS​

以下指南描述了如何将您的 Capacitor 3 iOS 项目升级到 Capacitor 4。

提高 iOS 部署目标​

为您的 Xcode 项目执行以下操作：在项目编辑器中选择 Project，打开 Build Settings 选项卡。在 Deployment 部分下，将 iOS Deployment Target 更改为 iOS 13.0。对所有应用 Targets 重复相同步骤。

然后，打开 ios/App/Podfile 并按照以下步骤操作：

  1. 在第一行添加：
require_relative '../../node_modules/@capacitor/ios/scripts/pods_helpers'
  1. 将 iOS 版本更新为 13.0：
platform :ios, '13.0'
  1. 在最后一行添加此块：
post_install do |installer|
  assertDeploymentTarget(installer)
end

移除不必要的代码​

从 AppDelegate.swift 中移除未使用的 touchesBegan 方法

-override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
-  super.touchesBegan(touches, with: event)
-
-  let statusBarRect = UIApplication.shared.statusBarFrame
-  guard let touchPoint = event?.allTouches?.first?.location(in: self.window) else { return }
-
-  if statusBarRect.contains(touchPoint) {
-      NotificationCenter.default.post(name: .capacitorStatusBarTapped, object: nil)
-  }
-}

可选：从 Info.plist 中移除 NSAppTransportSecurity 条目​

NSAppTransportSecurity 仅用于实时重载，如果您不使用实时重载或使用 Ionic CLI 进行实时重载，则不再需要此条目。

-<key>NSAppTransportSecurity</key>
-<dict>
-		  <key>NSAllowsArbitraryLoads</key>
-  		<true/>
-</dict>

Android​

以下指南描述了如何将您的 Capacitor 3 Android 项目升级到 Capacitor 4。

更新 Android 项目变量​

在您的 variables.gradle 文件中，将值更新为以下新的最小值，并添加新的 coreSplashScreenVersion 和 androidxWebkitVersion：

minSdkVersion = 22
compileSdkVersion = 32
targetSdkVersion = 32
androidxActivityVersion = '1.4.0'
androidxAppCompatVersion = '1.4.2'
androidxCoordinatorLayoutVersion = '1.2.0'
androidxCoreVersion = '1.8.0'
androidxFragmentVersion = '1.4.1'
coreSplashScreenVersion = '1.0.0-rc01'
androidxWebkitVersion = '1.4.0'
junitVersion = '4.13.2'
androidxJunitVersion = '1.1.3'
androidxEspressoCoreVersion = '3.4.0'
cordovaAndroidVersion = '10.1.1'

在 Android 清单中添加 android:exported 标签​

在您的 AndroidManifest.xml 文件中，您需要在 <activity> 标签中添加以下行。

android:exported="true"

此标签确保您可以在应用中打开此"Activity"或屏幕。有关此标签和其他标签的更多信息，请查看 Android 的 <activity> 参考文档。

信息

默认情况下，您的 AndroidManifest.xml 位于 android/app/src/main/AndroidManifest.xml。

更新 Gradle Google Services 插件​

在 android/build.gradle 文件中，将 classpath 'com.google.gms:google-services:4.3.5' 更改为 classpath 'com.google.gms:google-services:4.3.13' 以更新 Google Services 插件。

更新到 Gradle 7​

在 File > Project Structure > Project 中调整您的 Gradle 项目设置。Android Gradle Plugin Version 应为 7.2.1 或更高版本，Gradle Version 应为 7.4.2 或更高版本。应用这些更改并通过点击 Android Studio 右上角的大象图标运行 gradle 同步。

信息

Android Studio 可能提供自动迁移到 Gradle 7。接受这个提议！要升级，请转到您的 build.gradle 文件，点击 💡 图标，然后点击 "Upgrade Gradle"。项目迁移完成后，按上述说明运行 gradle 同步。

另一个替代方案是使用 Android Gradle Plugin Upgrade Assistant 为您处理迁移。此工具的步骤可以在 Android 文档中找到。

确保您使用的是 Java 11​

Capacitor 3 兼容 Java 8 和 Java 11。今后，Capacitor 4 将仅支持 Java 11。您可以在项目中通过转到 Android Studio 中的以下菜单来更改此项：

Preferences > Build, Execution, Deployment > Build Tools > Gradle

Gradle 偏好设置

然后，您可以将 "Gradle JDK" 修改为 Java 11。

信息

Java 11 随最新版本的 Android Studio 一起提供。无需额外下载！

切换到自动 Android 插件加载​

这在 Capacitor 3 中是可选的更改，但现在对于 Capacitor 4 升级是强制性的，因为 init 方法已被移除。在 MainActivity.java 中，可以移除 onCreate 方法。您不再需要在添加或移除通过 npm 安装的插件时编辑此文件。

 public class MainActivity extends BridgeActivity {
-    @Override
-    public void onCreate(Bundle savedInstanceState) {
-        super.onCreate(savedInstanceState);
-
-        // 初始化 Bridge
-        this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
-            // 您安装的额外插件放在这里
-            add(Plugin1.class);
-            add(Plugin2.class);
-        }});
-    }
 }

更改 registerPlugin 顺序​

如果您的应用包含专门为您的应用构建的自定义插件，您必须在 super.onCreate 之前注册它们：

 public class MainActivity extends BridgeActivity {
     @Override
     public void onCreate(Bundle savedInstanceState) {
+        registerPlugin(PluginInMyApp.class);
         super.onCreate(savedInstanceState);
-        registerPlugin(PluginInMyApp.class);
     }
 }

可选：使用新的 Android 12 启动屏 API​

要启用新的推荐的 Android 12 启动屏 API，需要进行此更改：

  • 在 android/app/src/main/res/values/styles.xml 中，将 AppTheme.NoActionBarLaunch 主题的 parent 属性从 AppTheme.NoActionBar 编辑为 Theme.SplashScreen，并向主题添加所需的选项。
<style name="AppTheme.NoActionBarLaunch" parent="Theme.SplashScreen">
    <item name="android:background">@drawable/splash</item>
</style>

不启用 Android 12 启动屏将导致 Android 12+ 设备上出现双重启动屏，并在较旧设备上使用旧的启动屏。

此更改是可选的，但建议执行以防止 Android Studio 在上次更改后显示 Cannot resolve symbol 'Theme.SplashScreen' 消息。

  • 在 android/app/build.gradle 的 dependencies 部分添加 implementation "androidx.core:core-splashscreen:$coreSplashScreenVersion"。

可选：使用 DayNight 主题​

要根据用户的设备主题自动切换主题（暗/亮主题），请在 android/app/src/main/res/values/styles.xml 中将 <style name="AppTheme.NoActionBar" parent="Theme.AppCompat.NoActionBar"> 更改为 <style name="AppTheme.NoActionBar" parent="Theme.AppCompat.DayNight.NoActionBar">。

可选：从 Gradle 文件中移除 jcenter()​

在以前的 Capacitor 版本中，由于我们的 Cordova 兼容层托管在 Jcenter 上，因此需要 jcenter()。但是，我们现在使用最新的 Cordova Android 版本，托管在 Maven Central 上。因此，您可以从 build.gradle 文件中完全移除 jcenter()。如果您使用其他插件或原生依赖，请在移除之前确保它们没有托管在 Jcenter 上！

插件​

以下插件功能已被修改或移除。请相应更新您的代码。

Storage​

@capacitor/storage 插件已重命名为 @capacitor/preferences，以更好地反映其用途。API 保持不变。

Camera​

  • 设置项 preserveAspectRatio 已被移除。
  • 插件将不再提示 iOS 使用说明缺失。
  • androidxMaterialVersion 变量已更新为 1.6.1。
  • androidxExifInterfaceVersion 变量已更新为 1.3.3。

Action Sheet​

  • ShowActionsOptions.title 现在为可选。
  • androidxMaterialVersion 变量已更新为 1.6.1。

仅 iOS​

  • buildActionSheet 的标题和消息现在为可选。

Push Notifications​

  • 为 registrationError 事件添加了新类型 RegistrationError。
  • importance 现在为可选，默认为 3。
  • deleteChannel 现在只接受频道 ID 而不是整个对象。
  • firebaseMessagingVersion 变量已更新为 23.0.5。
  • Android 现在遵守 presentationOptions 配置选项。

Local Notifications​

  • importance 现在为可选，默认为 3。
  • deleteChannel 现在只接受频道 ID 而不是整个对象。
  • Android 12+ 需要权限才能进行精确通知。

App​

  • App.exitApp() 现在返回一个 promise。

Geolocation​

  • getCurrentPosition() 现在忽略超时。
  • playServicesLocationVersion 已更新为 20.0.0。
  • 当应用进入后台状态时，插件现在停止位置更新。
  • 如果系统定位服务被禁用，插件现在抛出错误。

FileSystem​

  • copy 现在返回复制文件的路径。
  • ReaddirResult 现在返回 FileInfo 对象数组，除了 URI 外还包含每个文件的元数据。
  • StatResult 已统一，在所有平台上返回相同的结果。

Device​

  • model 现在在 iOS 上返回精确的型号（从 "iPhone" 变为 "iPhone13.4"）。
  • getLanguageCode() 现在在 Web 上返回短语言代码（与其他平台一样），要获取完整代码请使用 getLanguageTag()。

Dialog​

  • title 现在为可选。

Keyboard​

  • style 配置选项现在使用 KeyboardStyle 枚举作为选项。

Toast​

  • 在 Android 12 及更新版本上，所有 toast 显示在底部。

Browser​

  • androidxBrowserVersion 变量已更新为 1.4.0。

Splash Screen​

  • 如果切换到新的 Android 12 启动屏 API，大多数配置选项将不适用于初始启动屏，但它们仍然适用于调用 show() 时显示的启动屏。此外，在 Android 12+ 设备上，初始启动屏与 show() 方法显示的启动屏不同。

Contents

编辑此页