将应用中的 Capacitor 升级到 2.0
Capacitor 2 进行了一些工具链更新,包括在 iOS 中采用 Swift 5,在 Android 中采用 AndroidX。
更新 Capacitor 依赖项
首先,更新 Capacitor Core 和 CLI:
npm install @capacitor/cli@2 @capacitor/core@2
接下来,更新你使用的每个 Capacitor 平台:
# iOS
npm install @capacitor/ios@2
npx cap sync ios
# Android
npm install @capacitor/android@2
npx cap sync android
# Electron
cd electron
npm install @capacitor/electron@2
不向后兼容的插件变更
- Camera
- 在所 有平台上,
saveToGallery的默认值现在是false - 如果
allowEditing为true且编辑被取消,则返回原始图片
- 在所 有平台上,
- Push Notifications
- 调用
register()时不再请求权限,请使用requestPermission() PushNotificationChannel重命名为NotificationChannel
- 调用
- Local Notifications
- 调用
register()时不再请求权限,请使用requestPermission() schedule()现在返回LocalNotificationScheduleResult
- 调用
- Toast
- 统一各平台时长:短 2000ms,长 3500ms
- Geolocation
- 在 Android 上使用融合定位提供程序
- 从
GeolocationOptions中移除了requireAltitude - 更改了 iOS 上的原生定位精度值(更多信息)
- Filesystem
- 从
MkdirOptions中移除了createIntermediateDirectories(请使用recursive代替) - 向
writeFile添加了recursive选项,这会改变 Android 和 Web 上的行为(更多信息) - 移除了
Application目录选项,因为它存在问题
- 从
- Device
- 从
getInfo()中移除了batteryLevel和isCharging,请使用getBatteryInfo()
- 从
- Modals
inputPlaceholder现在设置占位符而不是文本,请改用inputText
- App
AppRestoredResult现在是可选的,仅在成功时返回,否则返回错误
- Clipboard
- 移除了
ReadOptions
- 移除了
iOS
Capacitor 2 需要 Xcode 11 或更高版本。
将原生项目更新到 Swift 5
Capacitor 2 使用 Swift 5。建议将你的原生项目也更新到使用 Swift 5。
- 在 Xcode 中点击 Edit -> Convert -> To Current Swift Syntax。
- App.app 将显示为选中状态,点击 Next 按钮。
- 然后会显示消息 No source changes necessary。
- 最后,点击 Update 按钮。
Android
AndroidX
Capacitor 2 遵循 Google 的建议,对 Android 支持库依赖项使用 AndroidX,因此原生项目也需要更新为使用 AndroidX。
在 Android Studio 中执行 Refactor -> Migrate to AndroidX。然后点击 Migrate 按钮,最后点击 Do Refactor。
如果使用尚未采用 AndroidX 的 Cordova 或 Capacitor 插件,可以使用 jetifier 工具来修补它们。
npm install jetifier
npx jetifier
要在每次安装包后自动运行它,请在 package.json 中添加 "postinstall": "jetifier"。
创建通用变量
创建一个 android/variables.gradle 文件,内容如下:
ext {
minSdkVersion = 21
compileSdkVersion = 29
targetSdkVersion = 29
androidxAppCompatVersion = '1.1.0'
androidxCoreVersion = '1.2.0'
androidxMaterialVersion = '1.1.0-rc02'
androidxBrowserVersion = '1.2.0'
androidxLocalbroadcastmanagerVersion = '1.0.0'
firebaseMessagingVersion = '20.1.2'
playServicesLocationVersion = '17.0.0'
junitVersion = '4.12'
androidxJunitVersion = '1.1.1'
androidxEspressoCoreVersion = '3.2.0'
cordovaAndroidVersion = '7.0.0'
}
在 android/build.gradle 文件中,添加 apply from: "variables.gradle":
classpath 'com.android.tools.build:gradle:4.1.1'
classpath 'com.google.gms:google-services:4.3.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}
+apply from: "variables.gradle"
allprojects {
repositories {
google()
jcenter()
使用通用变量
如果你创建了 variables.gradle 文件,请更新项目以使用这些变量。
在 android/app/build.gradle 文件中,进行以下更新:
android {
- compileSdkVersion 28
+ compileSdkVersion rootProject.ext.compileSdkVersion
defaultConfig {
applicationId "com.example.app"
- minSdkVersion 21
- targetSdkVersion 28
+ minSdkVersion rootProject.ext.minSdkVersion
+ targetSdkVersion rootProject.ext.targetSdkVersion
versionCode 1
versionName "1.0"
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
dependencies {
implementation fileTree(include: ['*.jar'], dir: 'libs')
- implementation 'androidx.appcompat:appcompat:1.0.0'
+ implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
implementation project(':capacitor-android')
- testImplementation 'junit:junit:4.12'
- androidTestImplementation 'androidx.test.ext:junit:1.1.1'
- androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.0'
+ testImplementation "junit:junit:$junitVersion"
+ androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+ androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
implementation project(':capacitor-cordova-android-plugins')
不要忘记将单引号改为双引号。变量插值需要使用双引号。
推荐更新 Android Studio 插件
在 Android Studio 中打开 Android 项目时,会出现 Plugin Update Recommended 消息。点击 update。它会提示你更新 Gradle 插件和 Gradle。点击 Update 按钮。
你也可以手动更新 Gradle 插件和 Gradle。
要手动更新 Gradle 插件,请在 android/build.gradle 文件中将 com.android.tool.build:gradle 版本更新到 3.6.1。
要手动更新 Gradle,请在 android/gradle/wrapper/gradle-wrapper.properties 中,将 gradle-4.10.1-all.zip 改为 gradle-5.6.4-all.zip。
更新 Google Services 插件
在 android/build.gradle 文件中,将 com.google.gms:google-services 依赖版本更新到 4.3.3。
dependencies {
classpath 'com.android.tools.build:gradle:4.1.1'
- classpath 'com.google.gms:google-services:4.2.0'
+ classpath 'com.google.gms:google-services:4.3.3'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
更改 android:configChanges 以避免应用重启
在 android/app/src/main/AndroidManifest.xml 中,在 activity 的 android:configChanges 属性中添加 |smallestScreenSize|screenLayout|uiMode。
<activity
- android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale"
+ android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
android:name="com.example.app"
android:label="@string/title_activity_main"
android:theme="@style/AppTheme.NoActionBarLaunch"
android:launchMode="singleTask">
```### 将缓存文件夹添加到 `FileProvider` 文件路径,以避免编辑图库图片时出现权限错误
在 `android/app/src/main/res/xml/file_paths.xml` 中添加 `<cache-path name="my_cache_images" path="." />`:
```diff
<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
<external-path name="my_images" path="." />
+ <cache-path name="my_cache_images" path="." />
</paths>
移除 launch_splash.xml
android/app/src/main/res/drawable/launch_splash.xml 文件可以删除,因为它已不再使用。
移除 maven 仓库
Capacitor 已通过 npm 分发,因此 android/app/build.gradle 中的 maven 仓库条目不再需要,并且可能引发问题。
从 repositories 部分移除它:
repositories {
- maven {
- url "https://dl.bintray.com/ionic-team/capacitor"
- }
flatDir {
dirs '../capacitor-cordova-android-plugins/src/main/libs', 'libs'
}
}