Some checks failed
Test examples / Test Examples (20) (push) Has been cancelled
Test examples / Test Examples (22) (push) Has been cancelled
Lock Threads / action (push) Has been cancelled
Trigger Release / start (push) Has been cancelled
Stale issue handler / stale (push) Has been cancelled
Update Font Data / create-pull-request (push) Has been cancelled
build-and-deploy / deploy-target (push) Has been cancelled
build-and-deploy / build (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / build-wasm (nodejs) (push) Has been cancelled
build-and-deploy / build-wasm (web) (push) Has been cancelled
build-and-deploy / Deploy preview tarball (push) Has been cancelled
build-and-deploy / Potentially publish release (push) Has been cancelled
build-and-deploy / publish-turbopack-npm-packages (push) Has been cancelled
build-and-deploy / Deploy examples (push) Has been cancelled
build-and-deploy / thank you, build (push) Has been cancelled
build-and-deploy / Upload Turbopack Bytesize metrics to Datadog (push) Has been cancelled
Rspack Next.js development integration tests / Rspack integration tests (push) Has been cancelled
Rspack Next.js production integration tests / Rspack integration tests (push) Has been cancelled
Turbopack Next.js development integration tests / Next.js integration tests (push) Has been cancelled
Turbopack Next.js production integration tests / Next.js integration tests (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack development test manifest (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack production test manifest (push) Has been cancelled
Upload bundler test manifests to areweturboyet.com / Upload test results (push) Has been cancelled
Update React / create-pull-request (push) Has been cancelled
test-e2e-project-reset-cron / reset-test-project (push) Has been cancelled
Notify about the top 15 issues/PRs/feature requests (most reacted) in the last 90 days / run (push) Has been cancelled
176 lines
4.8 KiB
Plaintext
176 lines
4.8 KiB
Plaintext
---
|
|
title: Migrating to Cache Components
|
|
nav_title: Migrating to Cache Components
|
|
description: Learn how to migrate from route segment configs to Cache Components in Next.js.
|
|
---
|
|
|
|
When [Cache Components](/docs/app/api-reference/config/next-config-js/cacheComponents) is enabled, route segment configs like `dynamic`, `revalidate`, and `fetchCache` are replaced by [`use cache`](/docs/app/api-reference/directives/use-cache) and [`cacheLife`](/docs/app/api-reference/functions/cacheLife).
|
|
|
|
## `dynamic = "force-dynamic"`
|
|
|
|
**Not needed.** All pages are dynamic by default.
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// Before - No longer needed
|
|
export const dynamic = 'force-dynamic'
|
|
|
|
export default function Page() {
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// Before - No longer needed
|
|
export const dynamic = 'force-dynamic'
|
|
|
|
export default function Page() {
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// After - Just remove it
|
|
export default function Page() {
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// After - Just remove it
|
|
export default function Page() {
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
## `dynamic = "force-static"`
|
|
|
|
Start by removing it. When unhandled uncached or runtime data access is detected during development and build time, Next.js raises an error. Otherwise, the prerendering step automatically extracts the static HTML shell.
|
|
|
|
For uncached data access, add [`use cache`](/docs/app/api-reference/directives/use-cache) as close to the data access as possible with a long [`cacheLife`](/docs/app/api-reference/functions/cacheLife) like `'max'` to maintain cached behavior. If needed, add it at the top of the page or layout.
|
|
|
|
For runtime data access (`cookies()`, `headers()`, etc.), errors will direct you to wrap it with `<Suspense>`. Since you started by using `force-static`, you must remove the runtime data access to prevent any request time work.
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// Before
|
|
export const dynamic = 'force-static'
|
|
|
|
export default async function Page() {
|
|
const data = await fetch('https://api.example.com/data')
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// Before
|
|
export const dynamic = 'force-static'
|
|
|
|
export default async function Page() {
|
|
const data = await fetch('https://api.example.com/data')
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
import { cacheLife } from 'next/cache'
|
|
|
|
// After - Use 'use cache' instead
|
|
export default async function Page() {
|
|
'use cache'
|
|
cacheLife('max')
|
|
const data = await fetch('https://api.example.com/data')
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
import { cacheLife } from 'next/cache'
|
|
|
|
// After - Use 'use cache' instead
|
|
export default async function Page() {
|
|
'use cache'
|
|
cacheLife('max')
|
|
const data = await fetch('https://api.example.com/data')
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
## `revalidate`
|
|
|
|
**Replace with `cacheLife`.** Use the `cacheLife` function to define cache duration instead of the route segment config.
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// Before
|
|
export const revalidate = 3600 // 1 hour
|
|
|
|
export default async function Page() {
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// Before
|
|
export const revalidate = 3600 // 1 hour
|
|
|
|
export default async function Page() {
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// After - Use cacheLife
|
|
import { cacheLife } from 'next/cache'
|
|
|
|
export default async function Page() {
|
|
'use cache'
|
|
cacheLife('hours')
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// After - Use cacheLife
|
|
import { cacheLife } from 'next/cache'
|
|
|
|
export default async function Page() {
|
|
'use cache'
|
|
cacheLife('hours')
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
## `fetchCache`
|
|
|
|
**Not needed.** With `use cache`, all data fetching within a cached scope is automatically cached, making `fetchCache` unnecessary.
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// Before
|
|
export const fetchCache = 'force-cache'
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// Before
|
|
export const fetchCache = 'force-cache'
|
|
```
|
|
|
|
```tsx filename="app/page.tsx" switcher
|
|
// After - Use 'use cache' to control caching behavior
|
|
export default async function Page() {
|
|
'use cache'
|
|
// All fetches here are cached
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
```jsx filename="app/page.js" switcher
|
|
// After - Use 'use cache' to control caching behavior
|
|
export default async function Page() {
|
|
'use cache'
|
|
// All fetches here are cached
|
|
return <div>...</div>
|
|
}
|
|
```
|
|
|
|
## `runtime = 'edge'`
|
|
|
|
**Not supported.** Cache Components requires the Node.js runtime. Switch to the Node.js runtime (the default) by removing the `runtime = 'edge'` export. If you need edge behavior for specific routes, use [Proxy](/docs/app/api-reference/file-conventions/proxy) instead.
|