跳到主要内容
版本：v2

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

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

注意：建议在单独的分支中应用这些更改。

添加 Capacitor​

首先在终端中打开你的项目，然后将 Capacitor 添加到 Web 应用 或 Ionic 应用 中。

接下来，打开 config.xml 文件，找到 widget 元素中的 id 字段。在此示例中，它是 io.ionic.myapp。

<widget id="io.ionic.myapp" version="0.0.1" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.0">

同时找到你的应用的 Name：

<name>MyApp</name>

现在，使用此应用信息初始化 Capacitor：

npx cap init [appName] [appId]

在此示例中，命令应为 npx cap init MyApp io.ionic.myapp。这些值可以在新创建的 capacitor.config.json 文件中找到。

构建你的 Web 应用​

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

这确保了 Capacitor 自动配置 为在 capacitor.config.json 中使用 webDir 的 www 文件夹确实存在。

添加平台​

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

npx cap add ios
npx cap add android

项目根目录下会创建 android 和 ios 文件夹。这些是完全独立的原生项目产物，应被视为应用的一部分（即，将它们纳入版本控制，在各自的 IDE 中编辑它们等）。此外，之前通过 npm install 添加到项目中的任何 Cordova 插件（位于 package.json 的 dependencies 下）都会被 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 [android | ios]

设置权限​

如果插件在 plugin.xml 中声明了权限或使用说明，Capacitor 会自动将它们添加到你的 AndroidManifest.xml 和 Info.plist 中。但是，你可能需要通过在 plugin.xml 和 iOS、Android 上的所需设置之间进行映射，手动应用额外的权限或使用说明。请查阅 iOS 和 Android 配置指南，了解如何配置每个平台。

Cordova 插件偏好设置​

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

{
  "cordova": {
    "preferences": {
      "DisableDeploy": "true",
      "CameraUsesGeolocation": "true"
    }
  }
}
const config: CapacitorConfig = {
  cordova: {
    preferences: {
      DisableDeploy: 'false',
      CameraUsesGeolocation: 'true',
    },
  },
};

额外的 Config.xml 字段​

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

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

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

大多数 allow-intent 值要么未被使用，要么在 capacitor.config.json 中有 可配置的替代方案。

<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>Used to take photos</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

编辑此页