跳到主要内容
版本:v6

安装 Capacitor

你可以创建一个全新的 Capacitor 应用程序,或者将 Capacitor 添加到现有的 Web 项目中。这可以通过 CLI 或使用 VS Code 扩展 来实现。

请务必确保已为要构建的平台 设置好环境

创建新的 Capacitor 应用

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

npm init @capacitor/app

将 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 会将构建后的 Web 包(预期在 Capacitor 配置 文件的 webDir 中找到)复制到原生项目中,并安装原生项目的依赖项。

下一步

环境设置完成且项目结构正确配置后,你就可以开始了!如果需要更具体的文档,可以点击以下任意链接。

开始使用 iOS ›

开始使用 Android ›

开发者工作流指南 ›