跳到主要内容
版本：v8

从 Capacitor 5 升级到 Capacitor 6

Capacitor 5 和 6 之间的破坏性变更设计得非常少。在本指南中，你将找到将项目更新到当前 Capacitor 6 版本的步骤，以及官方插件的破坏性变更列表。

NodeJS 18+​

Node 16 已于 2023 年 9 月 11 日结束生命周期。Capacitor 6 需要 NodeJS 18 或更高版本。（推荐使用最新的 LTS 版本。）

使用 CLI 进行迁移​

将 latest-6 版本的 Capacitor CLI 安装到你的项目中：

npm i -D @capacitor/cli@latest-6

安装完成后，只需运行以下命令，CLI 将为你处理迁移：

npx cap migrate

如果迁移的某些步骤无法完成，终端输出中会提供额外的信息。以下是手动迁移的步骤。

使用 VS Code 扩展进行迁移​

如果你已安装 VS Code 扩展，只需查看扩展的推荐部分，即可找到将项目迁移到 Capacitor 6 的选项。

iOS​

以下指南描述了如何将你的 Capacitor 5 iOS 项目升级到 Capacitor 6。

升级 Xcode​

Capacitor 6 需要 Xcode 15.0+。

SPM 支持​

从使用 CocoaPods 切换到 SPM 是一个相当大的主题，我们将在另一篇文章中介绍，敬请期待。

注册自定义插件​

在 Capacitor 6 中，插件类不再自动注册。对于通过 npm 安装的插件，CLI 将生成一个插件类列表以编程方式注册它们。 但对于遵循自定义代码指南创建不在 npm 上分发的本地插件的用户，他们将需要创建一个自定义视图控制器并注册他们的插件。

缩放​

为了与 Android 行为保持一致，iOS 应用默认不再可缩放。要启用缩放，请检查 zoomEnabled 配置选项。

Android​

以下指南描述了如何将你的 Capacitor 5 Android 项目升级到 Capacitor 6。

升级 Android Studio​

Capacitor 6 需要 Android Studio Hedgehog | 2023.1.1 或更新版本，因为使用了 Gradle 8.2。

更新完成后，Android Studio 可以帮助处理一些与 gradle 和将 package 移入构建文件相关的更新。首先，运行 Tools -> AGP Upgrade Assistant。

APG Upgrade Assistant

更新 Android 项目变量​

在你的 variables.gradle 文件中，将值更新为以下新的最低版本：

minSdkVersion = 22
compileSdkVersion = 34
targetSdkVersion = 34
androidxActivityVersion = '1.8.0'
androidxAppCompatVersion = '1.6.1'
androidxCoordinatorLayoutVersion = '1.2.0'
androidxCoreVersion = '1.12.0'
androidxFragmentVersion = '1.6.2'
coreSplashScreenVersion = '1.0.1'
androidxWebkitVersion = '1.9.0'
junitVersion = '4.13.2'
androidxJunitVersion = '1.1.5'
androidxEspressoCoreVersion = '3.5.1'
cordovaAndroidVersion = '10.1.1'

更新 Google Services 插件​

# build.gradle

    dependencies {
        classpath 'com.android.tools.build:gradle:8.0.0'
-       classpath 'com.google.gms:google-services:4.3.15'
+       classpath 'com.google.gms:google-services:4.4.0'

更新 Gradle 插件至 8.2.1​

# build.gradle

    dependencies {
-       classpath 'com.android.tools.build:gradle:8.0.0'
+       classpath 'com.android.tools.build:gradle:8.2.1'

更新 Gradle Wrapper 至 8.2.1​

# gradle-wrapper.properties

distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
- distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-all.zip
+ distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-all.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

更新 androidScheme​

在 Capacitor 6 中，对于现有应用，https 是 androidScheme 的默认设置，以更好地使 Capacitor 应用能够使用系统的自动填充功能。

更改 scheme 相当于在不同的域名上发布你的应用程序，这意味着存储在 cookies、localstorage 等中的任何数据将不再可访问。为了避免因这一变更导致数据丢失，如果你在 Capacitor 配置文件中还没有将 androidScheme 设置为 https，则应将 scheme 设置为 http。

{
  server: {
    androidScheme: "http"
  }
}

如果你已经将 androidScheme 设置为 https，现在可以安全地移除它。

更新 Kotlin 版本​

如果你的项目使用了 Kotlin，请将 kotlin_version 变量更新为 '1.9.10'。

插件​

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

对于所有具有监听器的插件，addListener 现在只返回一个 Promise。如果你在没有使用 await 的情况下将调用结果存储在变量中，你的代码将无法编译。

Action Sheet​

  • androidxMaterialVersion 变量已更新为 1.10.0。

Camera​

  • Capacitor Camera 插件的第 6 版现在使用 Photo Picker API，除非使用 saveToGallery: true，否则不再需要声明相机权限。如果此项为 false，并且没有其他插件需要以下权限，你可以从 AndroidManifest.xml 中移除它们。
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
  • 在 Android 上，如果用户取消从相册选择图片，返回的错误现在是 "User cancelled photos app"，与其他平台一致。
  • androidxMaterialVersion 变量已更新为 1.10.0。

Filesystem​

  • iOS 现在返回 ctime 和 mtime 为数字而非字符串，与其他所有平台一致。

Geolocation​

  • NSLocationAlwaysUsageDescription（Privacy - Location Always Usage Description）已弃用，可以从 Info.plist 中移除。
  • playServicesLocationVersion 变量已更新为 21.1.0。

Google Maps​

  • iOS 原生库已更新，请查看此处了解更多详情
  • NSLocationAlwaysUsageDescription（Privacy - Location Always Usage Description）已弃用，可以从 Info.plist 中移除。
  • googleMapsPlayServicesVersion 已更新为 18.2.0。
  • googleMapsUtilsVersion 已更新为 3.8.2。
  • googleMapsKtxVersion 已更新为 5.0.0。
  • googleMapsUtilsKtxVersion 已更新为 5.0.0。
  • kotlinxCoroutinesVersion 已更新为 1.7.3。
  • androidxCoreKTXVersion 已更新为 1.12.0。
  • kotlin_version 已更新为 1.9.10。

Local Notifications​

  • 在 Android 14 上，即使使用了 <uses-permission android:name="android.permission.SCHEDULE_EXACT_ALARM" /> 权限，通知默认也不是精确的，请查看此处了解更多详情

Push Notifications​

  • firebaseMessagingVersion 变量已更新为 23.3.1。

Share​

  • androidxCoreVersion 变量已更新为 1.12.0。

Splash Screen​

  • coreSplashScreenVersion 变量已更新为 1.0.1。

Status Bar​

  • androidxCoreVersion 变量已更新为 1.12.0。

Contents

编辑此页