跳转至正文
@capgo/capacitor-asset-cache 文件与存储 开源

资源缓存 Capacitor 插件

将 CDN 图片和视频缓存到应用的持久化存储中,并绑定为本地媒体源

安装

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

指南

如何在 Capacitor 中使用 Asset Cache

使用 @capgo/capacitor-asset-cache

@capgo/capacitor-asset-cache 将大型 CDN 图片和视频存入应用自有的持久化存储,然后为 Capacitor WebView 返回本地源 URL。

安装

npm install @capgo/capacitor-asset-cache
npx cap sync

插件暴露的内容

  • bind - 将图片或视频元素绑定到本地资源 source,并在就绪时更新。
  • src - 资源在本地存在后,返回本地 source 字符串。
  • resolve - 返回本地 source 以及缓存元数据。
  • configure - 设置默认 CDN 和重新验证行为。
  • get, list, remove, clear,以及 getCacheSize - 需要时显式管理缓存。

用法示例

配置一次 CDN,然后通过相对路径绑定元素:

import { AssetCache } from '@capgo/capacitor-asset-cache';

AssetCache.configure({
  cdnUrl: 'https://cdn.example.com/assets/',
  revalidate: {
    strategy: 'ttl',
    maxAgeSeconds: 86400,
  },
});

const hero = document.querySelector<HTMLImageElement>('#hero');

if (hero) {
  AssetCache.bind(hero, 'images/hero.jpg');
}

该元素会获得 data-asset-cache-state="loading" 在 native fetch 运行期间,随后会收到本地 source URL 并进入 ready.

img[data-asset-cache-state='loading'],
video[data-asset-cache-state='loading'] {
  opacity: 0.45;
}

受保护的资源

插件在获取或重新验证远程文件时会发送请求头。Web 元素仍然只会收到本地源 URL。

const src = await AssetCache.src('private/videos/intro.mp4', {
  cdnUrl: 'https://cdn.example.com/assets/',
  headers: {
    Authorization: `Bearer ${token}`,
  },
});

无需 CDN 基础 URL

不想配置时,请传入绝对 URL cdnUrl.

const src = await AssetCache.src('https://cdn.example.com/assets/videos/intro.mp4');

相对路径需要已配置的 cdnUrl 或单次调用的 cdnUrl.

存储注意事项

在 iOS 上,文件位于 Application Support 下,且不会包含在 iCloud 备份中。在 Android 上,文件位于应用的内部文件目录中。系统不会将这些文件视为可丢弃的缓存文件,但卸载应用、清除应用数据, clear(),以及 remove() 仍会删除它们。

完整参考

继续:使用 @capgo/capacitor-asset-cache

如果你正在使用 使用 @capgo/capacitor-asset-cache 要规划持久化媒体加载,请将其与 @capgo/capacitor-asset-cache 了解实现细节, 快速入门 了解实现细节, @capgo/capacitor-downloader 如需显式后台下载,以及 @capgo/capacitor-file 用于通用的本地文件访问。

常见问题

Asset Cache 插件常见问题

如何在 Capacitor 应用中安装 Asset Cache 插件?

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

@capgo/capacitor-asset-cache 支持 React、Vue 和 Angular 吗?

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

@capgo/capacitor-asset-cache 支持哪个版本的 Capacitor?

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

@capgo/capacitor-asset-cache 是免费且开源的吗?

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

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

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

无需等待应用审核,即可发布 Asset Cache 变更

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

开始使用 Capgo