相比之前的更新,Capacitor 4 到 Capacitor 5 的过渡涉及最小的破坏性更改。这份指南提供了逐步的更新指南,帮助您将项目升级到 Capacitor 5,另外还列出了官方插件的破坏性更改。
注意:Capacitor 5 需要 NodeJS 16 或更高版本,因为 Node 12 已经到达了末端生命期,Node 14 将于 2023 年 4 月 30 日到达末端生命期。建议使用 NodeJS 的最新 LTS 版本。
-
安装项目中的
latestCapacitor CLI 的npm i -D @capacitor/cli@latest -
运行以下命令,让 CLI 处理迁移:
npx cap migrate如果任何迁移步骤无法实现,终端输出中将提供额外的信息。手动迁移步骤如下。
-
如果您安装了 VS Code 扩展,请检查扩展的建议部分,找到迁移项目到 Capacitor 5 的选项。
将 Capacitor 4 iOS 项目升级到 Capacitor 5
-
升级 Xcode:Capacitor 5 需要 Xcode 14.1+。
-
更新 .gitignore: 请对以下文件进行以下修改
.gitignorefile:- App/Podfile.lock + App/output -
更新 Assets 以使用单个应用图标: Xcode 14 支持单个应用图标的 1024x1024。清理 AppIcon.appiconset 中的所有不必要的大小。
将 Capacitor 4 个 Android 项目升级到 Capacitor 5
-
升级 Android Studio: Capacitor 5 需要 Android Studio Flamingo | 2022.2.1 或更高版本,因为它使用 Gradle 8,这需要 Java JDK 17。Java 17 与 Android Studio Flamingo 一起提供,因此不需要额外下载。
-
运行 AGP Upgrade 助手: Android Studio 可以帮助一些与 Gradle 和将包移动到构建文件相关的更新。要开始,请运行
Tools -> AGP Upgrade Assistant. -
更新 Android 项目变量: 在您的
variables.gradle文件中,更新您的值以以下新最低值:minSdkVersion = 22 compileSdkVersion = 33 targetSdkVersion = 33 androidxActivityVersion = '1.7.0' androidxAppCompatVersion = '1.6.1' androidxCoordinatorLayoutVersion = '1.2.0' androidxCoreVersion = '1.10.0' androidxFragmentVersion = '1.5.6' coreSplashScreenVersion = '1.0.0' androidxWebkitVersion = '1.6.1' junitVersion = '4.13.2' androidxJunitVersion = '1.1.5' androidxEspressoCoreVersion = '3.5.1' cordovaAndroidVersion = '10.1.1' -
更新 Google 服务:
# build.gradle dependencies { - classpath 'com.google.gms:google-services:4.3.13' + classpath 'com.google.gms:google-services:4.3.15' } -
更新 Gradle 插件到 8.0.0:
# build.gradle dependencies { - classpath 'com.android.tools.build:gradle:7.2.1' + classpath 'com.android.tools.build:gradle:8.0.0' } -
更新 Gradle 包装器到 8.0.2:
# gradle-wrapper.properties distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists - distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-all.zip + distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-all.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -
禁用 Jetifier:
# gradle.properties android.useAndroidX=true - android.enableJetifier=true -
移动包到
build.gradle:# AndroidManifest.xml <?xml version="1.0" encoding="utf-8"?> - <manifest xmlns:android="http://schemas.android.com/apk/res/android" - package="[YOUR_PACKAGE_ID]"> + <manifest xmlns:android="http://schemas.android.com/apk/res/android"># build.gradle android { + namespace "[YOUR_PACKAGE_ID]" compileSdkVersion rootProject.ext.compileSdkVersion -
更新 androidScheme: 在 Capacitor 6 中
https将成为androidSchemefor existing apps to better enable Capacitor applications to use the system Autofill feature. To avoid data loss as a result of this change, set the scheme tohttp应用程序使用系统 Autofill 功能的能力。为了避免由于此更改而导致的数据丢失,请将方案设置为{ server: { androidScheme: "http" } } -
现在,即使它是当前默认值更新 Kotlin 版本
kotlin_version变量到'1.8.20'.
插件功能变更
以下插件功能已修改或删除。更新您的 code 以适应:
- 动作面板
- 浏览器
- 相机
- 设备
- 地理位置
- 谷歌地图
- 本地通知
- 推送通知
- 状态栏
操作面板
- 更新
androidxMaterialVersion__CAPGO_KEEP_0__1.8.0.
浏览器
- 更新
androidxBrowserVersion__CAPGO_KEEP_0__1.5.0.
相机
- 为了 Android 13,添加读取媒体图像权限(
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES"/>) 在AndroidManifest.xml. - 更新
androidxMaterialVersion更新1.8.0. - __CAPGO_KEEP_0__
androidxExifInterfaceVersion__CAPGO_KEEP_0__1.3.6.
__CAPGO_KEEP_0__
- __CAPGO_KEEP_1__
DeviceId.uuid__CAPGO_KEEP_2__DeviceId.identifier. - __CAPGO_KEEP_3__
DeviceInfo.name在 iOS 16+ 上, 除非您添加适当的.
__CAPGO_KEEP_4__
- __CAPGO_KEEP_5__
playServicesLocationVersion__CAPGO_KEEP_6__21.0.1.
__CAPGO_KEEP_7__
- __CAPGO_KEEP_8__
googleMapsPlayServicesVersion到18.1.0.googleMapsUtilsVersion到3.4.0.googleMapsKtxVersion到3.4.0.googleMapsUtilsKtxVersion到3.4.0.kotlinxCoroutinesVersion到1.6.4.androidxCoreKTXVersion到1.10.0.kotlin_version到1.8.20.
本地通知
- 为了 Android 13,需要在目标 SDK 33 时调用新的运行时权限检查来排程本地通知。
checkPermissions()和requestPermissions()因此
推送通知
- 为了 Android 13,需要在目标 SDK 33 中添加一个新的运行时权限检查,以接收推送通知。调用
checkPermissions()和requestPermissions()相应地。 - 更新
firebaseMessagingVersion变量到23.1.2.
状态栏
- 在 iOS 上,已更改默认状态栏动画为
FADE.
按照这些步骤并更新您的 code,您应该现在已经成功地从 Capacitor 4 更新了您的项目到 Capacitor 5。确保测试您的应用程序,以确保所有功能和插件都按预期工作。
继续从 Updating from Capacitor 4 to Capacitor 5: A Step-by-Step Guide:一个步骤步骤指南
如果您正在使用 Updating from Capacitor 4 to Capacitor 5: A Step-by-Step Guide 来规划原生插件工作,连接它 Capgo 插件目录 在 Capgo 插件目录中了解产品工作流程 Capacitor 由 Capgo 提供的插件 了解 Capacitor 由 Capgo 提供的插件的实现细节 添加或更新插件 了解添加或更新插件的实现细节 Ionic Enterprise 插件替代方案 了解 Ionic Enterprise 插件替代方案的产品工作流程 Capgo 原生构建 了解 Capgo 原生构建的产品工作流程