跳转至正文
教程

使用 CapacitorJS 开发跨平台应用:分步指南

学习如何使用 CapacitorJS,通过单一 JavaScript 代码库为 Android、iOS 和 Web(PWA)构建跨平台应用。

《使用 CapacitorJS 开发跨平台应用:分步指南》Capgo 博客插图

在不断发展的移动应用开发领域,渐进式 Web 应用(PWA)的兴起为新的跨平台运行时铺平了道路。这些运行时让基于 Web 的应用无需完全依赖原生 code 就能进入应用商店。实现这一点的技术之一就是 CapacitorJS,它允许开发者使用单一 JavaScript 代码库,将简单网站作为应用部署到 Android、iOS 和 Web。这种方法显著降低开发成本并提升编码效率。

本指南将重点介绍如何仅用纯 JavaScript、不依赖任何额外 framework 来创建应用。尽管 2021 年纯 JavaScript 应用开发资源并不好找,我们仍会提供一份全面教程,教你构建应用并在 CapacitorJS 中使用原生插件。

‣ 前置条件

在开始之前,请确保已安装以下工具:

注意:iOS 应用开发只能在 macOS 设备上完成。

‣ 设置你的 Capacitor 项目

要创建 Capacitor 应用,请进入目标文件夹,并在终端中执行以下命令:

npm init @capacitor/app

按照提示安装 package 并设置项目。使用 Capacitor v3 时,项目目录结构应如下所示:

www/
  css/
    style.css
  js/
    capacitor-welcome.js
  index.html
  manifest.json
.gitignore
capacitor.config.json
package.json
README.md

初始设置完成后,就可以继续了。

‣ 项目结构调整

我们将使用 Vite 来 bundle JavaScript 文件,因此需要相应地调整项目结构:

  • 创建 一个新文件夹 src 在主目录中。
  • 创建 一个新的 script 文件 index.js 中的 src/.
  • 创建 Vite 配置文件 vite.config.js 在主目录中。
  • 移除 这个 capacitor-welcome.js 文件来自 www/js/.

您的新文件夹结构应如下所示:

src/
  index.js
www/
  css/
    style.css
  js/
  index.html
  manifest.json
.gitignore
capacitor.config.json
package.json
README.md
vite.config.js

‣ 适配纯 JavaScript

让我们修改一些文件以适配纯 JavaScript:

www/index.html

  1. 移除以下脚本导入: Ionic PWA Elements 如果你不打算将应用作为 PWA 发布:
<script type="module" src="https://unpkg.com/@ionic/pwa-elements@latest/dist/ionicpwaelements/ionicpwaelements.esm.js"></script>
<script nomodule src="https://unpkg.com/@ionic/pwa-elements@latest/dist/ionicpwaelements/ionicpwaelements.js"></script>
  1. 从 body 中删除 <capacitor-welcome> HTML 元素。

  2. 将 script 导入从 capacitor.js 改为 js/main.js。这将是我们打包后的 JavaScript 文件。

  3. 移除 js/capacitor-welcome.js 导入。你的 index.html 现已准备就绪。

vite.config.js

要打包我们的 Node.js 模块,请使用 Vite,我们需要一个配置文件来指定打包后脚本的输出位置。以下配置会把文件 src/index.js 并将其打包为生产环境版本 www/js/main.js:

import { defineConfig } from 'vite';
import path from 'node:path';

export default defineConfig({
  build: {
    outDir: path.resolve(__dirname, 'www'),
    rollupOptions: {
      input: './src/index.js',
      output: {
        format: 'es',
        file: path.resolve(__dirname, 'www/js/main.js')
      }
    }
  }
});

capacitor.config.json

在 capacitor.config.json 文件,找到 "bundledWebRuntime": true 属性并将其更改为 false。此调整可确保 Capacitor 不打包文件,从而让我们改用 Vite 来完成此任务。

完成这些更改后,您的 Capacitor 应用基础配置即告完成,您可以开始使用纯 JavaScript 开发应用了。

‣ 开发您的应用

基础工作已就绪,您现在可以在 src/index.js 文件中开始编写应用逻辑。在这里,您可以导入所需的 Node.js 模块,定义应用功能,并与 Capacitor 的原生插件进行交互。

请记住,每次修改后都要运行 Vite 的 build 命令来打包您的 JavaScript 文件:

vite build

该命令将生成 main.js 中的文件 www/js 目录,您的 index.html 文件将引用该目录。

‣ 测试与调试

Capacitor 提供了一种便捷的方式,用于在不同平台上测试您的应用。使用以下命令可在相应平台的开发环境中打开您的应用:

针对 Android:

npx cap add android
npx cap open android

适用于 iOS(仅限 macOS):

npx cap add ios
npx cap open ios

适用于 Web/PWA:

npx cap serve

通过这些命令,你可以在 Android Studio、Xcode 或浏览器中运行应用,并按需测试和调试。

‣ 结语

使用纯 JavaScript 和 CapacitorJS 开发跨平台应用,是一种高性价比且高效的方式,可用单一代码库为多个平台构建应用。按照本指南,你已完成项目搭建、为 Vite 重构项目,并让应用准备好进入开发。有了这个基础,你已朝着构建健壮且多用途的应用稳步前进。

记得在所有平台上充分测试,并利用 Capacitor 的原生插件增强应用功能。祝你编码愉快!

继续阅读:Developing Cross-Platform Apps with CapacitorJS: A Step-by-Step Guide

如果你正在使用 使用 CapacitorJS 开发跨平台应用:分步指南 要规划原生插件工作,请将其与 Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 查看添加或更新插件中的实现细节, Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流,以及 Capgo Native Build 查看 Capgo Native Builds 中的产品工作流。

为 Capacitor 应用提供 Live Updates

当 Web 层出现线上 Bug 时,通过 Capgo 发布修复,而不用等 App Store 审核好几天。用户会在后台收到更新,原生变更则仍走正常审核流程。

博客最新动态

Capgo 为你提供打造真正专业的移动应用所需的最有价值的洞察。