跳转至正文

实时重载 Capacitor 插件

连接开发服务器,在开发过程中实现即时热重载

安装

bun add @capgo/capacitor-live-reload bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-live-reload
  • pnpm add @capgo/capacitor-live-reload
  • yarn add @capgo/capacitor-live-reload

指南

如何在 Capacitor 中使用 Live Reload

使用 @capgo/capacitor-live-reload

通过 Capacitor 插件从远程 Vite 开发服务器实时重载 Capacitor 应用。

安装

bun add @capgo/capacitor-live-reload
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { LiveReload } from '@capgo/capacitor-live-reload';

API 概览

方法 描述
configureServer 存储远程开发服务器设置,供后续连接使用。
connect 如果当前没有活跃的 WebSocket 连接,则建立一个新的连接。
disconnect 关闭当前的 WebSocket 连接并禁用自动重连。
getStatus 返回当前连接状态。
reload 触发 Capacitor WebView 的完整重新加载。
reloadFile 如果运行时支持,则重新加载单个文件/模块(否则回退到完整重新加载)。

示例

configureServer()

存储远程开发服务器设置,供后续连接使用。

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.configureServer({ url: 'https://example.com' });
console.log(result);

connect()

如果当前没有活跃的 WebSocket 连接,则建立一个新的连接。

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.connect();
console.log(result);

disconnect()

关闭当前的 WebSocket 连接并禁用自动重连。

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.disconnect();
console.log(result);

getStatus()

返回当前连接状态。

import { LiveReload } from '@capgo/capacitor-live-reload';

const result = await LiveReload.getStatus();
console.log(result);

reload()

触发 Capacitor WebView 的完整重新加载。

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.reload();

reloadFile()

如果运行时支持,则重新加载单个文件/模块(否则回退到完整重新加载)。

import { LiveReload } from '@capgo/capacitor-live-reload';

await LiveReload.reloadFile({ path: 'path/to/file' });

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时,或者调用 LiveReload.removeAllListeners() 以清除所有监听器。

完整参考文档

继续阅读“使用 @capgo/capacitor-live-reload”

如果你正在使用 使用 @capgo/capacitor-live-reload 要规划原生插件工作,请将其与 @capgo/capacitor-live-reload 了解 @capgo/capacitor-live-reload 中的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Live Reload 插件常见问题

如何在 Capacitor 应用中安装 Live Reload 插件?

运行 "bun add @capgo/capacitor-live-reload"(或 "npm install @capgo/capacitor-live-reload"),然后运行 "bunx cap sync",以便 iOS 和 Android 项目获取原生 code。在您的应用 code 中从 "@capgo/capacitor-live-reload" 导入它。

@capgo/capacitor-live-reload 支持 React、Vue 和 Angular 吗?

是的。Live Reload 是一个 Capacitor 包,因此它适用于任何在 Capacitor 内部运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-live-reload 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-live-reload 是免费且开源的吗?

是的。源代码 code 在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-live-reload/,并且可以从 npm 免费安装该包。欢迎提交 Bug 报告和 Pull Request。

我可以更新使用 Live Reload 的 code 而无需经过 App Store 审核吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可发布 Live Reload 变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo