キャッシュ

AdonisJS Cache (@adonisjs/cache) は、データをキャッシュしてアプリケーションのパフォーマンスを向上させるために bentocache.dev の上に構築されたシンプルで軽量なラッパーです。Redis、DynamoDB、PostgreSQL、インメモリキャッシュなど、さまざまなキャッシュドライバと対話するための簡単で統一されたAPIを提供します。

Bentocacheのドキュメントを読むことを強くオススメします。Bentocacheは、マルチティア、グレース期間、タイムアウト、スタンピードプロテクションなど、特定の状況で非常に役立つ高度なオプションの概念を提供します。

インストール

以下のコマンドを実行して @adonisjs/cache パッケージをインストールおよび設定します：

node ace add @adonisjs/cache

検出されたパッケージマネージャーを使用して @adonisjs/cache パッケージをインストールします。
adonisrc.ts ファイルに次のサービスプロバイダーを登録します：

{
  providers: [
   // ...他のプロバイダー
   () => import('@adonisjs/cache/cache_provider'),
  ]
}

config/cache.ts ファイルを作成します。
.env ファイル内に選択されたキャッシュドライバの環境変数を定義します。

設定

キャッシュパッケージの設定ファイルは config/cache.ts にあります。デフォルトのキャッシュドライバ、ドライバのリスト、およびそれらの特定の設定を構成できます。

参照： Config stub

import { defineConfig, store, drivers } from '@adonisjs/cache'

const cacheConfig = defineConfig({
  default: 'redis',
  
  stores: {
   /**
    * データをDynamoDBにのみキャッシュ
    */
   dynamodb: store().useL2Layer(drivers.dynamodb({})),

   /**
    * Lucidで設定されたデータベースを使用してデータをキャッシュ
    */
   database: store().useL2Layer(drivers.database({ connectionName: 'default' })),

   /**
    * データをプライマリストアとしてインメモリに、セカンダリストアとしてRedisにキャッシュ。
    * アプリケーションが複数のサーバーで実行されている場合、インメモリキャッシュはバスを使用して同期する必要があります。
    */
   redis: store()
    .useL1Layer(drivers.memory({ maxSize: '100mb' }))
    .useL2Layer(drivers.redis({ connectionName: 'main' }))
    .useBus(drivers.redisBus({ connectionName: 'main' })),
  },
})

export default cacheConfig

上記のコード例では、各キャッシュストアに複数のレイヤーを設定しています。これはマルチティアキャッシングシステムと呼ばれます。これにより、最初に高速なインメモリキャッシュ（最初のレイヤー）をチェックし、データが見つからない場合は分散キャッシュ（2番目のレイヤー）を使用します。

Redis

Redisをキャッシュシステムとして使用するには、@adonisjs/redis パッケージをインストールして設定する必要があります。ドキュメントはこちらを参照してください： Redis。

config/cache.ts では、connectionName を指定する必要があります。このプロパティは config/redis.ts ファイル内のRedis設定キーと一致する必要があります。

データベース

database ドライバには @adonisjs/lucid のピア依存関係があります。したがって、このパッケージをインストールして設定する必要があります。

config/cache.ts では、connectionName を指定する必要があります。このプロパティは config/database.ts ファイル内のデータベース設定キーに対応する必要があります。

その他のドライバ

memory、dynamodb、kysely、orchid などの他のドライバを使用できます。

詳細は Cache Drivers を参照してください。

使用方法

キャッシュが設定されたら、cache サービスをインポートして操作できます。次の例では、ユーザーの詳細を5分間キャッシュします：

import cache from '@adonisjs/cache/services/main'
import router from '@adonisjs/core/services/router'

router.get('/user/:id', async ({ params }) => {
  return cache.getOrSet({
   key: `user:${params.id}`,
   factory: async () => {
    const user = await User.find(params.id)
    return user.toJSON()
   },
   ttl: '5m',
  })
})

ご覧のとおり、user.toJSON() を使用してユーザーデータをシリアル化しています。これは、データをキャッシュに保存するためにシリアル化する必要があるためです。Lucidモデルや Date のインスタンスなどのクラスは、Redisやデータベースのようなキャッシュに直接保存することはできません。

ttl はキャッシュキーの有効期限を定義します。TTLが切れると、キャッシュキーは古いと見なされ、次のリクエストはファクトリメソッドからデータを再取得します。

グレース期間

キャッシュキーが期限切れでもグレース期間内であれば古いデータを返すようにするには、grace オプションを使用します。この変更により、Bentocacheは SWR や TanStack Query と同じように動作します。

import cache from '@adonisjs/cache/services/main'

cache.getOrSet({
  key: 'slow-api',
  factory: async () => {
   await sleep(5000)
   return 'slow-api-response'
  },
  ttl: '1h',
  grace: '6h',
})

上記の例では、データは1時間後に古いと見なされます。ただし、6時間のグレース期間内の次のリクエストは古いデータを返しながら、ファクトリメソッドからデータを再取得してキャッシュを更新します。

タイムアウト

ファクトリメソッドが実行される時間を timeout オプションで設定できます。デフォルトでは、Bentocacheは0msのソフトタイムアウトを設定しており、常に古いデータを返しながらバックグラウンドでデータを再取得します。

import cache from '@adonisjs/cache/services/main'

cache.getOrSet({
  key: 'slow-api',
  factory: async () => {
   await sleep(5000)
   return 'slow-api-response'
  },
  ttl: '1h',
  grace: '6h',
  timeout: '200ms',
})

上記の例では、ファクトリメソッドは最大200ms実行されます。ファクトリメソッドが200msを超えると、古いデータがユーザーに返されますが、ファクトリメソッドはバックグラウンドで実行され続けます。

grace 期間を定義していない場合でも、ハードタイムアウトを使用して一定時間後にファクトリメソッドの実行を停止できます。

import cache from '@adonisjs/cache/services/main'

cache.getOrSet({
  key: 'slow-api',
  factory: async () => {
   await sleep(5000)
   return 'slow-api-response'
  },
  ttl: '1h',
  hardTimeout: '200ms',
})

この例では、ファクトリメソッドは200ms後に停止され、エラーがスローされます。

timeout と hardTimeout を一緒に定義できます。timeout はファクトリメソッドが古いデータを返す前に実行される最大時間であり、hardTimeout はファクトリメソッドが停止されるまでの最大時間です。