404 ページは頻繁にアクセスされます。アクセスのたびにエラーページをサーバーサイドレンダリングすると、Next.js サーバーの負荷が高くなってしまいます。その結果、コストが増加したり、体験が遅くなったりすることがあります。
これを避けるために、Next.js ではファイルを追加することなく標準で静的な 404 ページを提供しています。
pages/404.js
ファイルを作成することで、カスタマイズされた 404 ページを作ることができます。このファイルはビルド時に静的に生成されます。
// pages/404.js
export default function Custom404() {
return <h1>404 - Page Not Found</h1>;
}
追記: ビルド時にデータ取得が必要であるのならば、getStaticProps をこのページで利用できます。
訪問されるたびにエラーページをサーバーでレンダリングすることは、エラーへの対応を複雑にします。ユーザーができるだけ早くエラーへのアプリケーションの反応を得られるように、Next.js はデフォルトで性的な 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/zeit/next.js');
const errorCode = res.ok ? false : res.statusCode;
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>;
}
もし statusCode
と共にテキストメッセージもページへと伝播させたい場合は、Error
コンポーネントは title
もプロパティとして受け取れます。
カスタムの Error
があるならば代わりにそちらをインポートしてください。 next/error
は Next.js がデフォルトで利用するコンポーネントをエクスポートしています。
Error
コンポーネントは現在 getStaticProps や getServerSideProps といった Next.js のデータ取得メソッド をサポートしていません。