Menu

Next.jsでリダイレクトを処理する方法

Next.jsでリダイレクトを処理する方法はいくつかあります。このページでは、利用可能なすべてのオプション、ユースケース、大量のリダイレクトを管理する方法について説明します。

API目的使用場所ステータスコード
useRouterクライアント側のナビゲーションを実行ComponentsN/A
redirects in next.config.jsパスに基づいて受信リクエストをリダイレクトnext.config.js ファイル307 (一時的) または 308 (永続)
NextResponse.redirect条件に基づいて受信リクエストをリダイレクトProxy任意

useRouter() フック

コンポーネント内でリダイレクトする必要がある場合は、useRouter フックの push メソッドを使用できます。たとえば:

app/page.tsx
TypeScript
import { useRouter } from 'next/router'
 
export default function Page() {
  const router = useRouter()
 
  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      Dashboard
    </button>
  )
}

補足:

  • ユーザーをプログラムでナビゲートする必要がない場合は、<Link> コンポーネントを使用する必要があります。

詳細については、useRouter APIリファレンス を参照してください。

next.config.jsredirects

next.config.js ファイルの redirects オプションを使用すると、受信リクエストのパスを別の宛先パスにリダイレクトできます。これは、ページのURL構造を変更した場合や、事前にわかっているリダイレクトのリストがある場合に便利です。

redirectsパスマッチングヘッダー、クッキー、クエリマッチングをサポートしており、受信リクエストに基づいてユーザーをリダイレクトする柔軟性を提供します。

redirects を使用するには、next.config.js ファイルにオプションを追加します:

next.config.ts
TypeScript
import type { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  async redirects() {
    return [
      // 基本的なリダイレクト
      {
        source: '/about',
        destination: '/',
        permanent: true,
      },
      // ワイルドカードパスマッチング
      {
        source: '/blog/:slug',
        destination: '/news/:slug',
        permanent: true,
      },
    ]
  },
}
 
export default nextConfig

詳細については、redirects APIリファレンス を参照してください。

補足:

  • redirectspermanent オプションで 307 (一時的リダイレクト) または 308 (永続リダイレクト) ステータスコードを返すことができます。
  • redirects はプラットフォームに制限がある場合があります。たとえば、Vercel では 1,024 リダイレクトという制限があります。大量のリダイレクト (1000+) を管理するには、Proxy を使用してカスタムソリューションの作成を検討してください。詳細については、大規模なリダイレクト管理 を参照してください。
  • redirects は Proxy 前に実行されます。

Proxy の NextResponse.redirect

Proxy を使用すると、リクエストが完了する前にコードを実行できます。その後、受信リクエストに基づいて、NextResponse.redirect を使用して別のURLにリダイレクトできます。これは、条件 (認証、セッション管理など) に基づいてユーザーをリダイレクトしたい場合や、大量のリダイレクト がある場合に便利です。

たとえば、ユーザーが認証されていない場合は /login ページにリダイレクトするには:

proxy.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { authenticate } from 'auth-provider'
 
export function proxy(request: NextRequest) {
  const isAuthenticated = authenticate(request)
 
  // ユーザーが認証されている場合、通常通り続行
  if (isAuthenticated) {
    return NextResponse.next()
  }
 
  // 認証されていない場合はログインページにリダイレクト
  return NextResponse.redirect(new URL('/login', request.url))
}
 
export const config = {
  matcher: '/dashboard/:path*',
}

補足:

  • Proxy は next.config.jsredirects 後に実行され、レンダリング前に実行されます。

詳細については、Proxy ドキュメントを参照してください。

大規模なリダイレクト管理 (上級)

大量のリダイレクト (1000+) を管理するには、Proxy を使用してカスタムソリューションの作成を検討してください。これにより、アプリケーションを再デプロイすることなく、プログラムでリダイレクトを処理できます。

これを行うには、以下を考慮する必要があります:

  1. リダイレクトマップの作成と保存。
  2. データ検索パフォーマンスの最適化。

Next.js の例: 以下の推奨事項の実装については、Bloom フィルタ付きProxy の例を参照してください。

1. リダイレクトマップの作成と保存

リダイレクトマップは、データベース (通常はキー値ストア) またはJSONファイルに保存できるリダイレクトのリストです。

次のデータ構造を考えてください:

{
  "/old": {
    "destination": "/new",
    "permanent": true
  },
  "/blog/post-old": {
    "destination": "/blog/post-new",
    "permanent": true
  }
}

Proxy で、Vercel の Edge ConfigRedis などのデータベースから読み取り、受信リクエストに基づいてユーザーをリダイレクトできます:

proxy.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { get } from '@vercel/edge-config'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
export async function proxy(request: NextRequest) {
  const pathname = request.nextUrl.pathname
  const redirectData = await get(pathname)
 
  if (redirectData && typeof redirectData === 'string') {
    const redirectEntry: RedirectEntry = JSON.parse(redirectData)
    const statusCode = redirectEntry.permanent ? 308 : 307
    return NextResponse.redirect(redirectEntry.destination, statusCode)
  }
 
  // リダイレクトが見つからない場合、リダイレクトなしで続行
  return NextResponse.next()
}

2. データ検索パフォーマンスの最適化

すべての受信リクエストに対して大規模なデータセットを読み取ることは遅く、コストがかかる場合があります。データ検索パフォーマンスを最適化する2つの方法があります:

  • 高速読み取りに最適化されたデータベースを使用する
  • Bloom フィルタ などのデータ検索戦略を使用して、より大きなリダイレクトファイルまたはデータベースを読み取る前にリダイレクトが存在するかどうかを効率的に確認する

前の例を考慮して、生成された Bloom フィルタファイルを Proxy にインポートし、受信リクエストのパス名が Bloom フィルタに存在するかどうかを確認できます。

それが存在する場合、リクエストを API Routes に転送します。このハンドラは実際のファイルをチェックし、ユーザーを適切なURLにリダイレクトします。これにより、大きなリダイレクトファイルを Proxy にインポートすることを避け、すべての受信リクエストを遅くする可能性があります。

proxy.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { ScalableBloomFilter } from 'bloom-filters'
import GeneratedBloomFilter from './redirects/bloom-filter.json'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
// 生成されたJSONファイルから Bloom フィルタを初期化
const bloomFilter = ScalableBloomFilter.fromJSON(GeneratedBloomFilter as any)
 
export async function proxy(request: NextRequest) {
  // 受信リクエストのパスを取得
  const pathname = request.nextUrl.pathname
 
  // パスが Bloom フィルタにあるかを確認
  if (bloomFilter.has(pathname)) {
    // パス名を Route Handler に転送
    const api = new URL(
      `/api/redirects?pathname=${encodeURIComponent(request.nextUrl.pathname)}`,
      request.nextUrl.origin
    )
 
    try {
      // Route Handler からリダイレクトデータを取得
      const redirectData = await fetch(api)
 
      if (redirectData.ok) {
        const redirectEntry: RedirectEntry | undefined =
          await redirectData.json()
 
        if (redirectEntry) {
          // ステータスコードを決定
          const statusCode = redirectEntry.permanent ? 308 : 307
 
          // 宛先にリダイレクト
          return NextResponse.redirect(redirectEntry.destination, statusCode)
        }
      }
    } catch (error) {
      console.error(error)
    }
  }
 
  // リダイレクトが見つからない場合、リダイレクトなしでリクエストを続行
  return NextResponse.next()
}

その後、API Route で:

pages/api/redirects.ts
TypeScript
import type { NextApiRequest, NextApiResponse } from 'next'
import redirects from '@/app/redirects/redirects.json'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
export default function handler(req: NextApiRequest, res: NextApiResponse) {
  const pathname = req.query.pathname
  if (!pathname) {
    return res.status(400).json({ message: 'Bad Request' })
  }
 
  // redirects.json ファイルからリダイレクトエントリを取得
  const redirect = (redirects as Record<string, RedirectEntry>)[pathname]
 
  // Bloom フィルタの偽陽性を考慮
  if (!redirect) {
    return res.status(400).json({ message: 'No redirect' })
  }
 
  // リダイレクトエントリを返却
  return res.json(redirect)
}

補足:

  • Bloom フィルタを生成するには、bloom-filters などのライブラリを使用できます。
  • 悪意のあるリクエストを防ぐため、Route Handler へのリクエストを検証する必要があります。