コンテンツにスキップ
アプリケーションの構築ルーティングカスタムエラー

カスタムエラー

404 ページ

404 ページは非常に頻繁にアクセスされる可能性があります。アクセスごとにエラーページをサーバーレンダリングすると、Next.jsサーバーの負荷が増加します。これにより、コストの増加とエクスペリエンスの低下につながる可能性があります。

上記の落とし穴を回避するために、Next.js は追加のファイルを追加しなくても、デフォルトで静的な 404 ページを提供します。

404 ページをカスタマイズする

カスタムの 404 ページを作成するには、pages/404.js ファイルを作成します。このファイルはビルド時に静的に生成されます。

pages/404.js
export default function Custom404() {
  return <h1>404 - Page Not Found</h1>
}

知っておくと良いこと: ビルド時にデータをフェッチする必要がある場合は、このページ内でgetStaticPropsを使用できます。

500 ページ

アクセスごとにエラーページをサーバーレンダリングすると、エラーへの対応が複雑になります。エラーへの応答をできるだけ早くユーザーに届けるために、Next.js は追加のファイルを追加しなくても、デフォルトで静的な 500 ページを提供します。

500 ページをカスタマイズする

500 ページをカスタマイズするには、pages/500.js ファイルを作成します。このファイルはビルド時に静的に生成されます。

pages/500.js
export default function Custom500() {
  return <h1>500 - Server-side error occurred</h1>
}

知っておくと良いこと: ビルド時にデータをフェッチする必要がある場合は、このページ内でgetStaticPropsを使用できます。

さらに高度なエラーページのカスタマイズ

500 エラーは、クライアント側とサーバー側の両方で Error コンポーネントによって処理されます。これをオーバーライドしたい場合は、ファイル pages/_error.js を定義し、次のコードを追加します

function Error({ statusCode }) {
  return (
    <p>
      {statusCode
        ? `An error ${statusCode} occurred on server`
        : 'An error occurred on client'}
    </p>
  )
}
 
Error.getInitialProps = ({ res, err }) => {
  const statusCode = res ? res.statusCode : err ? err.statusCode : 404
  return { statusCode }
}
 
export default Error

pages/_error.js は本番環境でのみ使用されます。開発環境では、エラーが発生した場所を知るためのコールスタック付きのエラーが表示されます。

組み込みのエラーページの再利用

組み込みのエラーページをレンダリングしたい場合は、Errorコンポーネントをインポートすることで可能です。

import Error from 'next/error'
 
export async function getServerSideProps() {
  const res = await fetch('https://api.github.com/repos/vercel/next.js')
  const errorCode = res.ok ? false : res.status
  const json = await res.json()
 
  return {
    props: { errorCode, stars: json.stargazers_count },
  }
}
 
export default function Page({ errorCode, stars }) {
  if (errorCode) {
    return <Error statusCode={errorCode} />
  }
 
  return <div>Next stars: {stars}</div>
}

Errorコンポーネントは、statusCodeとともにテキストメッセージを渡したい場合に、titleをプロパティとして受け取ります。

カスタムのErrorコンポーネントがある場合は、代わりにそちらをインポートしてください。next/errorは、Next.jsで使用されるデフォルトのコンポーネントをエクスポートします。

注意点