跳到主要内容
版本:v8

安装 Capacitor

您可以创建一个新的 Capacitor 应用程序或将 Capacitor 添加到现有的 Web 项目。这可以通过 CLI 或使用社区维护的 VS Code 扩展 来完成。

请记住确保您的环境已设置为将要构建的平台做好准备。

创建新的 Capacitor 应用

@capacitor/create-app 包可用于快速创建 Capacitor 应用程序。您可以在空目录中运行以下命令来搭建新的 Capacitor 应用程序。

npm init @capacitor/app@latest

将 Capacitor 添加到您的 Web 应用

Capacitor 旨在集成到任何现代 JavaScript Web 应用中。但是,您的项目需要满足以下三个要求才能在现有应用中使用 Capacitor:

  • 一个 package.json 文件
  • 一个用于构建的 Web 资源的单独目录,例如 distwww
  • 在 Web 资源目录根目录下的 index.html 文件
信息

您的 index.html 文件必须具有 <head> 标记才能正确注入 Capacitor。如果您的 HTML 中没有 <head>,Capacitor 插件将无法工作。

安装 Capacitor

在应用的根目录中,安装 Capacitor 的主要 npm 依赖项:核心 JavaScript 运行时和命令行界面 (CLI)。

npm i @capacitor/core
npm i -D @capacitor/cli

初始化您的 Capacitor 配置

然后,使用 CLI 问卷初始化 Capacitor:

npx cap init

CLI 会问您几个问题,首先是您的应用名称,以及您想为应用使用的包 ID。它将使用这些配置详细信息创建 capacitor-config 文件,包括您的打包器的构建过程的预期输出目录(例如,Angular 的 www,React 的 build,Vue 的 public 等)。

信息

您可以通过修改在 npx cap init 期间创建的 Capacitor 配置文件中的 webDir 变量来自定义 Capacitor 使用的文件夹。请注意,Capacitor 会通过检查您使用的框架来尝试检测您的 Web 项目的默认值。不过,在首次同步构建时遇到问题时,交叉检查此配置变量是一个好主意。

创建您的 Android 和 iOS 项目

安装 Capacitor 核心运行时后,您可以安装 Android 和 iOS 平台。

npm i @capacitor/android @capacitor/ios

将平台添加到 package.json 后,您可以运行以下命令为原生应用创建 Android 和 iOS 项目。

npx cap add android
npx cap add ios

将您的 Web 代码同步到原生项目

创建原生项目后,可以通过运行以下命令将 Web 应用程序同步到原生项目。

npx cap sync

npx cap sync 将在 Capacitor 配置文件的 webDir 中预期的构建的 Web 包复制到您的原生项目,并安装原生项目的依赖项。

下一步

通过环境设置和正确的项目结构,您就可以开始了!如果您需要更具体的文档,可以按照下面的任何链接进行操作。

开始使用 iOS ›

开始使用 Android ›

开发者工作流程指南 ›