メインコンテンツまでスキップ

cacheTag

cacheTag関数を使用すると、キャッシュされたデータにタグを付けて、オンデマンドで無効化できます。タグをキャッシュエントリに関連付けることで、他のキャッシュデータに影響を与えることなく、特定のキャッシュエントリを選択的にパージまたは再検証できます。

使用法​

cacheTagを使用するには、next.config.jsファイルでdynamicIOフラグを有効にします：

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  experimental: {
    dynamicIO: true,
  },
}

export default nextConfig

cacheTag関数は、単一の文字列値または文字列の配列を受け取ります。

app/data.ts
import { unstable_cacheTag as cacheTag } from 'next/cache'

export async function getData() {
  'use cache'
  cacheTag('my-data')
  const data = await fetch('/api/data')
  return data
}

その後、別の関数、たとえばroute handlerやServer ActionでrevalidateTag APIを使用して、オンデマンドでキャッシュをパージできます：

app/action.ts
'use server'

import { revalidateTag } from 'next/cache'

export default async function submit() {
  await addPost()
  revalidateTag('my-data')
}

Good to know​

  • 冪等なタグ: 同じタグを複数回適用しても追加の効果はありません
  • 複数のタグ: 配列をcacheTagに渡すことで、単一のキャッシュエントリに複数のタグを割り当てることができます
cacheTag('tag-one', 'tag-two')

例​

コンポーネントや関数へのタグ付け​

キャッシュされた関数やコンポーネント内でcacheTagを呼び出して、キャッシュされたデータにタグを付けます：

app/components/bookings.tsx
import { unstable_cacheTag as cacheTag } from 'next/cache'

interface BookingsProps {
  type: string
}

export async function Bookings({ type = 'haircut' }: BookingsProps) {
  'use cache'
  cacheTag('bookings-data')

  async function getBookingsData() {
    const data = await fetch(`/api/bookings?type=${encodeURIComponent(type)}`)
    return data
  }

  return //...
}

外部データからのタグの作成​

非同期関数から返されたデータを使用して、キャッシュエントリにタグを付けることができます。

app/components/bookings.tsx
import { unstable_cacheTag as cacheTag } from 'next/cache'

interface BookingsProps {
  type: string
}

export async function Bookings({ type = 'haircut' }: BookingsProps) {
  async function getBookingsData() {
    'use cache'
    const data = await fetch(`/api/bookings?type=${encodeURIComponent(type)}`)
    cacheTag('bookings-data', data.id)
    return data
  }
  return //...
}

タグ付きキャッシュの無効化​

revalidateTagを使用して、必要に応じて特定のタグのキャッシュを無効化できます：

app/actions.ts
'use server'

import { revalidateTag } from 'next/cache'

export async function updateBookings() {
  await updateBookingData()
  revalidateTag('bookings-data')
}