将应用中的 Capacitor 更新到 3.0

Capacitor 3 为生态系统带来了关键更新和令人兴奋的新功能。

阅读 Capacitor 3.0 公告 ›

将应用升级到 Capacitor 3 后，您是否愿意在此讨论中分享您的反馈？我们非常期待听到您的意见！💖

如果您是插件作者，希望将插件升级到更新的 Capacitor 版本，请参阅 Capacitor 插件升级指南。

NodeJS 12+

Node 8 已达到生命周期终点。Node 10 将于 2021 年 4 月 30 日达到生命周期终点。Capacitor 3 需要 NodeJS 12 或更高版本。（建议使用最新的 LTS 版本。）

Ionic CLI

如果您正在使用 Ionic CLI，对 Capacitor 3 的官方支持从版本 6.16.0 开始。建议此时通过 npm install -g @ionic/cli 升级到最新版本。

更新 Capacitor CLI 和 Core

npm install @capacitor/cli@latest-3 @capacitor/core@latest-3

ES2017+

Capacitor 3 现在为 ES2017 环境构建，而不是 ES5。插件模板也已更新以针对 ES2017，并鼓励第三方插件更新其目标。

此更改不应影响您的应用，除非您支持 IE11（Capacitor 不官方支持 IE11）。

TypeScript 3.8+

Capacitor 3 使用更新的 TypeScript 语法，只能在 TS 3.8 或更高版本中使用。

Capacitor 配置更改

如果您已安装 TypeScript 3.8+，可以将 capacitor.config.json 迁移为类型化的 TypeScript 配置文件 capacitor.config.ts。您可以继续使用 .json 文件，但 TypeScript 配置文件可能为您的团队提供更好的开发者体验。以下是 Capacitor Test App 中使用的 capacitor.config.ts 文件示例。

/// <reference types="@capacitor/local-notifications" />
/// <reference types="@capacitor/push-notifications" />
/// <reference types="@capacitor/splash-screen" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'com.capacitorjs.app.testapp',
  appName: 'capacitor-testapp',
  webDir: 'build',
  plugins: {
    SplashScreen: {
      launchAutoHide: false,
    },
    LocalNotifications: {
      smallIcon: 'ic_stat_icon_config_sample',
      iconColor: '#CE0B7C',
    },
    PushNotifications: {
      presentationOptions: ['alert', 'sound'],
    },
  },
};

export default config;

官方插件

所有插件已从 Capacitor 核心中移除，并放入各自的 npm 包中。这样做有几个原因（参见 #3227），核心团队相信这是正确的方式。您可以像这样导入核心插件：

import { Camera } from '@capacitor/camera';

Background Task、Permissions 和 Photos 插件已移除

• Background Task：此插件似乎很少使用，并且大多数开发者的预期效果不符。核心团队将在未来重新处理后台功能。订阅 #3032 以获取更新。
• Permissions：核心团队已实现此集中方法的替代方案，社区插件也可以采用（请参阅新的 Permissions API）。
• Photos：这个未记录的仅 iOS 插件已被移除。请使用 @capacitor-community/media。

Accessibility、App 和 Modals 插件已拆分

• Accessibility
  • VoiceOver 和 TalkBack 功能已移至 Screen Reader
• App
  • 应用相关的信息和功能保留在 App
  • 应用 URL 处理（openUrl() 和 canOpenUrl()）已移至 App Launcher
• Modals
  • Action Sheet 功能（showActions()）已移至 Action Sheet
  • 对话框窗口功能（alert()、prompt() 和 confirm()）已移至 Dialog

迁移应用以使用新的官方插件包

此更改将要求您单独安装每个正在使用的插件。

1. 在项目中搜索从 @capacitor/core 的 Plugins 对象中提取的核心插件
2. 找到对应的插件文档，记住某些插件已被拆分
3. 按照文档中每个插件的安装说明进行操作
4. 更改插件导入，改为从插件包中导入（参见插件导入）
5. 按照不向后兼容的插件更改中的任何说明操作

使用 Ionic Framework？

Ionic Framework 使用以下插件中的 API：

• App
• Haptics
• Keyboard
• StatusBar

为了与 Ionic Framework 获得最佳用户体验，即使您不在应用中导入它们，也应确保安装这些插件：

npm install @capacitor/app @capacitor/haptics @capacitor/keyboard @capacitor/status-bar

插件导入

Plugins 对象已弃用，但在 Capacitor 3 中将继续工作。Capacitor 插件应更新为使用新的插件注册 API（请参阅插件升级指南），这将允许直接从插件包中导入它们。

今后，不应使用 @capacitor/core 中的 Plugins 对象。

// 旧方式
import { Plugins } from '@capacitor/core';
const { AnyPlugin } = Plugins;

建议直接从插件包中导入插件，但插件必须更新为与 Capacitor 3 兼容才能实现。

// 新方式
import { AnyPlugin } from 'any-plugin';

不向后兼容的插件更改

虽然许多插件 API 保持不变以简化向 Capacitor 3 的迁移过程，但有些需要代码更新和手动迁移。

• Accessibility / Screen Reader
  • isScreenReaderEnabled() 方法已重命名为 isEnabled()
  • 'accessibilityScreenReaderStateChange' 事件已重命名为 'stateChange'
  • 在 Android 和 iOS 上，speak() 仅在屏幕阅读器当前激活时有效。如需在屏幕阅读器激活或未激活时使用文本转语音功能，请使用 @capacitor-community/text-to-speech
• Browser
  • prefetch() 已被移除
• Device
  • 应用信息已从 getInfo() 中移除（appVersion、appBuild、appId 和 appName）。请使用 App 插件的 getInfo() 获取此信息
  • uuid 已从 getInfo() 中移除，请使用新的 getId() 函数
• Haptics
  • HapticsNotificationType 枚举键已从大写切换为驼峰命名，以与其他枚举保持一致
• Local Notifications
  • 此插件现在使用新的 Permissions API。requestPermission() 已移除，请使用 requestPermissions()
• Push Notifications
  • 此插件现在使用新的 Permissions API。requestPermission() 已移除，请使用 requestPermissions()
• Share
  • share() 方法现在返回 ShareResult 而不是 any
  • share() 的返回值将不再包含 completed。如果未完成，将改为 reject
• Storage
  • 需要数据迁移！ 内部存储机制已更改，需要数据迁移。已添加一个便捷方法：migrate()。要在不影响最终用户的情况下更新应用，请在任何其他方法之前调用 migrate()
• Filesystem
  • stat() 方法现在在所有平台上以毫秒为单位返回 ctime 和 mtime 时间戳。以前，iOS 以秒为单位返回时间戳

日志记录更改

hideLogs 配置选项在 Capacitor 3 中已弃用。它已被新的 loggingBehavior 配置选项替代。详细信息可以在配置文档中找到。

iOS

Capacitor 3 支持 iOS 12+。需要 Xcode 12+。建议使用 CocoaPods 1.8+。

更新 CocoaPods

建议将 CocoaPods 升级到最新的稳定版本。CocoaPods 1.8 切换到使用 CDN，这意味着不再需要定期运行 pod repo update。

使用 pod --version 检查您的 CocoaPods 版本，并访问 cocoapods.org 获取安装说明。

将 iOS 部署目标设置为 12.0

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

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

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

将 Swift 版本设置为 5

如果您的应用尚未使用 Swift 5，请打开 Xcode target 中的 Build Settings 选项卡，然后在 Swift Compiler - Language 部分下将 Swift Language Version 更改为 Swift 5。

将 public 移动到 iOS target 目录

建议在 Capacitor 3 中将 ios/App/public 目录移动到 ios/App/App/public。这可以在 Xcode 中实现：

移除现有的 public 文件夹

1. 展开 App 项目下的文件树，然后是 App 组，选择 public 文件夹。
2. 右键点击 Delete。当提示删除文件夹或仅移除引用时，选择 Move to Trash。

在新的位置重新创建 public

1. 右键点击 App 项目中的 App 组，点击 Add Files to "App"...
2. 保留默认选项（确保创建文件夹引用，而不是组，并添加到 App target）。
3. 点击 New Folder，命名为 "public"。
4. 点击 Create，然后点击 Add。

在 Xcode 中看起来可能相同，但新的 public 文件夹现在应该相对于 App 组，而不是项目根目录。

gitignore 新的 public 文件夹

在 ios/.gitignore 中，将忽略路径从 App/public 更改为 App/App/public。此文件夹包含您的 Web 资产副本，不应提交。

 App/build
 App/Pods
-App/public
+App/App/public
 App/Podfile.lock
 xcuserdata

更新 Capacitor iOS 平台

npm install @capacitor/ios@latest-3
npx cap sync ios

在应用事件中从 CAPBridge 切换到 ApplicationDelegateProxy

在 ios/App/App/AppDelegate.swift 中，更新以下内容：

     func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
         // Called when the app was launched with a url. Feel free to add additional processing here,
         // but if you want the App API to support tracking app url opens, make sure to keep this call
-        return CAPBridge.handleOpenUrl(url, options)
+        return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
     }

     func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
         // Called when the app was launched with an activity, including Universal Links.
         // Feel free to add additional processing here, but if you want the App API to support
         // tracking app url opens, make sure to keep this call
-        return CAPBridge.handleContinueActivity(userActivity, restorationHandler)
+        return ApplicationDelegateProxy.shared.application(application, continue: userActivity, restorationHandler: restorationHandler)
     }

移除 USE_PUSH 编译条件

如果使用推送通知功能，在 ios/App/App/AppDelegate.swift 中更新以下内容：

-    #if USE_PUSH

     func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
        NotificationCenter.default.post(name: Notification.Name(CAPNotifications.DidRegisterForRemoteNotificationsWithDeviceToken.name()), object: deviceToken)
     }

     func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
        NotificationCenter.default.post(name: Notification.Name(CAPNotifications.DidFailToRegisterForRemoteNotificationsWithError.name()), object: error)
     }

-#endif

如果不使用推送通知，您可以移除整个代码块：

-    #if USE_PUSH
-
-    func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
-        NotificationCenter.default.post(name: Notification.Name(CAPNotifications.DidRegisterForRemoteNotificationsWithDeviceToken.name()), object: deviceToken)
-    }
-
-    func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
-        NotificationCenter.default.post(name: Notification.Name(CAPNotifications.DidFailToRegisterForRemoteNotificationsWithError.name()), object: error)
-    }
-
-#endif

从硬编码的 CAPNotifications 切换到 NSNotification 扩展

在 ios/App/App/AppDelegate.swift 中，更新以下内容：

     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(CAPBridge.statusBarTappedNotification)
+            NotificationCenter.default.post(name: .capacitorStatusBarTapped, object: nil)
         }
     }

     func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
-        NotificationCenter.default.post(name: Notification.Name(CAPNotifications.DidRegisterForRemoteNotificationsWithDeviceToken.name()), object: deviceToken)
+        NotificationCenter.default.post(name: .capacitorDidRegisterForRemoteNotifications, object: deviceToken)
     }

     func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
-        NotificationCenter.default.post(name: Notification.Name(CAPNotifications.DidFailToRegisterForRemoteNotificationsWithError.name()), object: error)
+        NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
     }

忽略 DerivedData

将 DerivedData 添加到 ios/.gitignore 文件中。这是 Capacitor CLI 放置原生 iOS 构建的位置。

 App/Pods
 App/App/public
 App/Podfile.lock
+DerivedData
 xcuserdata

 # Capacitor 的 Cordova 插件

Android

Capacitor 3 支持 Android 5+（现在支持 Android 11）。需要 Android Studio 4+。

更新 Capacitor Android 平台

npm install @capacitor/android@latest-3
npx cap sync android

切换到自动 Android 插件加载

在 Capacitor 3 中，建议自动加载 Android 插件。在 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);
-        }});
-    }
 }

如果您的应用包含专门为您的应用构建的自定义插件，您仍然需要在 onCreate 中注册插件：

 public class MainActivity extends BridgeActivity {
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);

+        registerPlugin(PluginInMyApp.class);
     }
 }

更新 Gradle 到 7.0

我们现在建议在 Capacitor 项目中使用 Gradle 7.0。在 Android Studio 中，打开 File 菜单，然后点击 Project Structure。在 Project 部分，将 Gradle Version 更改为 7.0，将 Android Gradle Plugin Version 更改为 4.2.0。然后点击 OK。

您可能需要在 Project Structure 对话框的 Suggestions 部分评估对 Android 包的建议更新。

更新 Android 变量

在 android/variables.gradle 中，您可以更新以下变量：

 ext {
     minSdkVersion = 21
-    compileSdkVersion = 29
-    targetSdkVersion = 29
+    compileSdkVersion = 30
+    targetSdkVersion = 30
+    androidxActivityVersion = '1.2.0'
-    androidxAppCompatVersion = '1.1.0'
+    androidxAppCompatVersion = '1.2.0'
+    androidxCoordinatorLayoutVersion = '1.1.0'
-    androidxCoreVersion =  '1.2.0'
-    androidxMaterialVersion =  '1.1.0-rc02'
-    androidxBrowserVersion =  '1.2.0'
-    androidxLocalbroadcastmanagerVersion =  '1.0.0'
-    androidxExifInterfaceVersion = '1.2.0'
-    firebaseMessagingVersion =  '20.1.2'
-    playServicesLocationVersion =  '17.0.0'
+    androidxCoreVersion = '1.3.2'
+    androidxFragmentVersion = '1.3.0'
-    junitVersion =  '4.12'
-    androidxJunitVersion =  '1.1.1'
-    androidxEspressoCoreVersion =  '3.2.0'
+    junitVersion = '4.13.1'
+    androidxJunitVersion = '1.1.2'
+    androidxEspressoCoreVersion = '3.3.0'
     cordovaAndroidVersion = '7.0.0'
 }

Capacitor 3 支持 Android 11（API 30），因此您可以将 SDK 目标更新为 30。将 compileSdkVersion 和 targetSdkVersion 更改为 30。

新增了 androidxActivityVersion 变量，以值 1.2.0 添加。

androidxAppCompatVersion 可以更新为 1.2.0。

新增了 androidxCoordinatorLayoutVersion 变量，以值 1.1.0 添加。

androidxCoreVersion 可以更新为 1.3.2。

androidxMaterialVersion 变量由 Action Sheet 和 Camera 插件使用，如果不使用它们可以移除。如果使用，请查看 Camera 文档和 Action Sheet 文档。

androidxBrowserVersion 变量由 Browser 插件使用，如果不使用该插件可以移除。如果使用，请查看文档。

androidxLocalbroadcastmanagerVersion 变量可以移除。

androidxExifInterfaceVersion 变量由 Camera 插件使用，如果不使用该插件可以移除。如果使用，请查看文档。

firebaseMessagingVersion 变量由 Push Notifications 插件使用，如果不使用该插件可以移除。如果使用，请查看文档。

playServicesLocationVersion 变量由 Geolocation 插件使用，如果不使用该插件可以移除。如果使用，请查看文档。

新增了 androidxFragmentVersion 变量，以值 1.3.0 添加。

junitVersion 可以更新为 4.13.1。

androidxJunitVersion 可以更新为 1.1.2。

androidxEspressoCoreVersion 可以更新为 3.3.0。

移除未使用和冗余的权限

根据您使用的插件，您可以选择从应用的 AndroidManifest.xml 文件中移除未使用的权限。新 Capacitor 应用中的清单仅包含 INTERNET，因为权限现在应在安装插件时添加。按照以下步骤移除未使用的权限：

1. 确定您的应用使用的插件
2. 阅读这些文档中每个插件的安装说明，查找每个插件所需的权限
3. 在您的应用的 AndroidManifest.xml 文件中，保留插件所需的权限，移除未使用的权限

Haptics 和 Network 插件是现在在其自己的 AndroidManifest.xml 文件中包含安装时权限的插件示例，这些权限最终会与您的应用合并。可以从您的应用的 AndroidManifest.xml 文件中安全地移除它们的权限：

     <!-- 权限 -->

     <uses-permission android:name="android.permission.INTERNET" />

-    <!-- Network API -->
-    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

-    <!-- Vibration API -->
-    <uses-permission android:name="android.permission.VIBRATE" />

 </manifest>