はじめ方

インストール

CapgoのAI-Assistedセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを使用してください。

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-asset-cache` plugin in my project.

Manual Setup を選択した場合は、次のコマンドを実行してプラグインをインストールしてください。

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

Import

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

CDN を設定

アプリケーションが起動したときに、CDN のベース URL を一度設定してください。相対的なアセットのパスは、この URL に基づいて解決されます。

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

スキップできます cdnUrl 絶対 URL を渡す場合 bind, src, または resolve.

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

イメージまたはビデオをバインド

bind 最も透明な表示パスです。要素をロード中としてマークし、ローカルファイルが準備されているときにローカルソースURLを割り当てます。

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

if (image) {
  const binding = AssetCache.bind(image, 'images/hero.jpg');
  await binding.promise;
}

<img id="hero" alt="Product preview" />

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

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

注意

成功パスでは要素はCDN URLを受信せず、ローカルウェブビューURLを受信します。

React

import { useEffect, useRef } from 'react';
import { AssetCache } from '@capgo/capacitor-asset-cache';

AssetCache.configure({ cdnUrl: 'https://cdn.example.com/assets/' });

export function HeroImage() {
  const imageRef = useRef<HTMLImageElement>(null);

  useEffect(() => {
    if (!imageRef.current) return;

    const binding = AssetCache.bind(imageRef.current, 'images/hero.jpg');
    return () => binding.cancel();
  }, []);

  return <img ref={imageRef} alt="Product preview" />;
}

Vue

<script setup lang="ts">
import { onMounted, onUnmounted, ref } from 'vue';
import { AssetCache, type AssetCacheBinding } from '@capgo/capacitor-asset-cache';

const image = ref<HTMLImageElement | null>(null);
let binding: AssetCacheBinding | undefined;

onMounted(() => {
  if (image.value) {
    binding = AssetCache.bind(image.value, 'images/hero.jpg', {
      cdnUrl: 'https://cdn.example.com/assets/',
    });
  }
});

onUnmounted(() => binding?.cancel());
</script>

<template>
  <img ref="image" alt="Product preview" />
</template>

Vue

Use src 使用

const src = await AssetCache.src('videos/intro.mp4');

videoElement.src = src;

Use resolve フレームワークがロードとエラーの状態を制御している場合に使用してください。ローカルファイルが存在するまで、ローカルソース文字列が解決されるまでの約束が解決されます。

const source = await AssetCache.resolve('images/hero.jpg');

console.log(source.src, source.local, source.fromCache, source.status);

保護されたアセット

ヘッダーをネイティブのfetchに渡します。これは署名済みのCDNパス、認証済みのメディア、または短期間のトークンに便利です。

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

プラグインがリモートファイルをフェッチまたは再検証する際に使用するヘッダーです。画像または動画タグは、プラグインによって返されたローカルソースURLのみを受け取ります。

再検証

デフォルトの戦略を設定するには configure または、1つのアセットにのみオーバーライドします。

await AssetCache.src('videos/intro.mp4', {
  revalidate: {
    strategy: 'etag',
  },
});

利用可能な戦略:

戦略	使用する場合
never	キャッシュされたローカルファイルは、明示的に削除するまで十分です。
ttl	簡単な新鮮さウィンドウが必要です。
always	プラグインが毎回リモートアセットを確認したい場合
etag	CDNが安定したETagヘッダーを返します。
last-modified	CDNが信頼できるLast-Modifiedヘッダーを返します。

ストレージとプライバシー

• iOSは、Application Supportの下にファイルを格納し、キャッシュルートをiCloudバックアップから除外します。
• Androidは、内部ファイルディレクトリの下にファイルを格納します。
• Webは、ブラウザのキャッシュ API とlocalStorageメタデータを開発用のフォールバックとして使用します。
• キャッシュされたファイルはアプリのサンドボックス内に隠されています、ユーザーのパブリックメディアに保存されません。
• キャッシュされたファイルはアンインストール、データのクリア、またはプラグインの削除時に削除されます。 clear() または remove().

キャッシュは永続的ですが、セキュリティの境界ではありません。機密情報を暗号化して、侵害されたデバイス上で読み取れないようにする必要がある場合は、ファイルを暗号化してサーバーから提供してください。

高度なキャッシュ管理

ほとんどのUI code は bind, src、または resolve。キャッシュ管理を明示的に必要とする場合に使用してください:

メソッド	説明
get	リモートURLを解決してネイティブファイルメタデータを取得します。
list	ディスク上でまだ存在するキャッシュされたアセットを返します。
getCacheSize	キャッシュされた合計バイト数を返します。
remove	キーまたはURLを使用して1つのキャッシュされたアセットを削除します。
clear	プラグインによって管理されているすべてのキャッシュされたアセットを削除します。

const asset = await AssetCache.get({
  url: 'https://cdn.example.com/assets/videos/intro.mp4',
  key: 'videos/intro.mp4',
  revalidate: { strategy: 'last-modified' },
});

フル リファレンス

• GitHub: https://github.com/Cap-go/capacitor-asset-cache/
• パッケージ: @capgo/capacitor-asset-cache