跳到主要内容
版本：v4

将使用 Cordova 的 Web 应用迁移到 Capacitor

将使用 Cordova 的 Web 应用完全迁移到 Capacitor 需要几个步骤。

建议在应用这些更改时使用单独的分支。

添加 Capacitor​

首先在终端中打开你的项目，然后按照向 Web 应用添加 Capacitor 或向 Ionic 应用添加 Capacitor 的指南进行操作。

使用 Capacitor 初始化你的应用。系统提示的一些信息可以在 Cordova 的 config.xml 文件中找到：

  • 应用名称可以在 <name> 元素中找到。
  • Bundle ID 可以在根 <widget> 元素的 id 属性中找到。
npx cap init

构建你的 Web 应用​

在添加任何原生平台之前，你必须至少构建一次你的 Web 项目。

npm run build

这确保 Capacitor 已自动配置为将 www 文件夹用作 Capacitor 配置文件中的 webDir。

添加平台​

Capacitor 原生平台位于它们自己的顶级文件夹中。Cordova 的平台位于 platforms/ios 或 platforms/android 下。

npx cap add ios
npx cap add android

在项目的根目录下会创建 android 和 ios 文件夹。这些是完全独立的原生项目产物，应被视为应用的一部分（即检入源代码管理、在它们自己的 IDE 中编辑等）。此外，package.json 中 dependencies 下找到的任何 Cordova 插件都会由 Capacitor 自动安装到每个新的原生项目中（排除任何不兼容的插件）：

"dependencies": {
    "@ionic-native/camera": "^5.3.0",
    "@ionic-native/core": "^5.3.0",
    "@ionic-native/file": "^5.3.0",
    "cordova-android": "8.0.0",
    "cordova-ios": "5.0.0",
    "cordova-plugin-camera": "4.0.3",
    "cordova-plugin-file": "6.0.1",
}

启动屏和图标​

如果你之前创建过图标和启动屏图片，它们可以在项目根目录的 resources 文件夹中找到。有了这些图片，你可以使用 cordova-res 工具为基于 Capacitor 的 iOS 和 Android 项目生成图标和启动屏。

首先，安装 cordova-res：

npm install -g cordova-res

接下来，运行以下命令重新生成图片并将它们复制到原生项目中：

cordova-res ios --skip-config --copy
cordova-res android --skip-config --copy

此处提供完整详情。

迁移插件​

首先审查你现有的 Cordova 插件——可能可以移除不再需要的插件。

接下来，查看 Capacitor 的所有官方插件以及社区插件。你可能可以切换到与 Capacitor 等效的 Cordova 插件。

某些插件可能功能不完全匹配，但根据你所需的功能，这可能并不重要。

请注意，任何不兼容或导致构建问题的插件都会被自动跳过。

移除 Cordova 插件​

在用 Capacitor 插件替换 Cordova 插件后（或完全移除它），卸载该插件，然后运行 sync 命令以从原生项目中移除插件代码：

npm uninstall cordova-plugin-name
npx cap sync

设置权限​

默认情况下，Capacitor 最新版本所需的全部初始权限已在 iOS 和 Android 的默认原生项目中为你设置好了。但是，你可能需要通过将 plugin.xml 与 iOS 和 Android 上所需的设置进行映射来手动应用额外的权限。请参阅 iOS 和 Android 配置指南，了解如何配置每个平台的信息。

Cordova 插件偏好设置​

当运行 npx cap init 时，Capacitor 会读取 config.xml 中的所有偏好设置，并将它们移植到 Capacitor 配置文件中。你可以手动向 cordova.preferences 对象添加更多偏好设置。

{
  "cordova": {
    "preferences": {
      "DisableDeploy": "true",
      "CameraUsesGeolocation": "true"
    }
  }
}

config.xml 中的其他字段​

你可能想知道 config.xml 中的其他元素如何在 Capacitor 应用中工作。

Author 元素可以在 package.json 中配置，但 Capacitor 或你的应用不使用它：

<author email="email@test.com" href="http://ionicframework.com/">Ionic Framework Team</author>

大多数 allow-intent 值要么不被使用，要么有可配置的替代方案。

<allow-intent href="http://*/*" />
<allow-intent href="https://*/*" />
<allow-intent href="tel:*" />
<allow-intent href="sms:*" />
<allow-intent href="mailto:*" />
<allow-intent href="geo:*" />

iOS 的 edit-config 元素需要在 Info.plist 中配置。

<edit-config file="*-Info.plist" mode="merge" target="NSCameraUsageDescription">
    <string>用于拍照</string>
</edit-config>

不可能涵盖所有可用的 config.xml 元素。然而，大多数关于"如何在 Capacitor 中配置 X"的问题，在网上搜索答案时应该视为"如何在 [平台] (iOS/Android) 中配置 X"。

设置 Scheme​

当将 Ionic 与 Cordova 一起使用时，你的应用默认使用 cordova-plugin-ionic-webview，它在 iOS 上使用 ionic:// scheme 来提供内容。Capacitor 应用在 iOS 上默认使用 capacitor:// 作为 scheme。这意味着使用像 LocalStorage 这样绑定源的 Web API 会导致数据丢失，因为源不同。可以通过更改用于提供内容的 scheme 来解决这个问题：

{
  "server": {
    "iosScheme": "ionic"
  }
}

移除 Cordova​

在测试确认所有迁移更改已应用且应用运行正常后，可以从项目中移除 Cordova。删除 config.xml 以及 platforms 和 plugins 文件夹。请注意，从技术上讲，你不必移除 Cordova，因为 Capacitor 可以与其共存。实际上，如果你计划继续使用 Cordova 插件或认为将来可能会使用，你可以将 Cordova 资产保留在原地。

下一步​

这只是你 Capacitor 之旅的开始。了解更多关于在 Capacitor 项目中使用 Cordova 插件或更多关于 Capacitor 开发工作流的详细信息。

Contents

编辑此页