リダイレクト
リダイレクトを使用すると、受信したリクエストパスを別の宛先パスに転送できます。
リダイレクトを使用するには、next.config.js
でredirects
キーを使用します:
module.exports = {
async redirects() {
return [
{
source: '/about',
destination: '/',
permanent: true,
},
]
},
}
redirects
は非同期関数で、source
、destination
、permanent
プロパティを持つオブジェクトの配列を返す必要があります:
source
:受信リクエストのパスパターンdestination
:ルーティングしたいパスpermanent
:true
またはfalse
-true
の場合、クライアント/検索エンジンにリダイレクトを永久にキャッシュするよう指示する308ステータスコードを使用します。false
の場合、一時的でキャッシュされない307ステータスコードを使用します
Next.jsが307と308を使用する理由:従来、一時的なリダイレクトには302が、永続的なリダイレクトには301が使用されていましたが、多くのブラウザは元のメソッドに関係なく、リダイレクトのリクエストメソッドを
GET
に変更していました。例えば、ブラウザがPOST /v1/users
にリクエストを送信し、ステータスコード302
とロケーション/v2/users
が返された場合、後続のリクエストは予想されるPOST /v2/users
ではなくGET /v2/users
になる可能性があります。Next.jsは、リクエストメソッドを明示的に保持するために307(一時的)と308(永続的)のリダイレクトステータスコードを使用します。
basePath
:false
またはundefined
- falseの場合、マッチング時にbasePath
が含まれません。外部リダイレクトのみに使用できますlocale
:false
またはundefined
- マッチング時にロケールを含めるかどうかhas
:hasオブジェクトの配列で、type
、key
、value
プロパティを持ちますmissing
:missingオブジェクトの配列で、type
、key
、value
プロパティを持ちます
リダイレクトは、ページや/public
ファイルを含むファイルシステムよりも前にチェックされます。
Pages Routerを使用する場合、リダイレクトはクライアントサイドルーティング(Link
、router.push
)には適用されません(Middlewareが存在し、パスに一致する場合を除く)。
リダイレクトが適用されると、リクエストで提供されたクエリ値はリダイレクト先に渡されます。例えば、次のリダイレクト設定を参照してください:
{
source: '/old-blog/:path*',
destination: '/blog/:path*',
permanent: false
}
/old-blog/post-1?hello=world
がリクエストされると、クライアントは/blog/post-1?hello=world
にリダイレクトされます。
パスマッチング
パスマッチが許可されています。例えば、/old-blog/:slug
は/old-blog/hello-world
に一致します(ネストされたパスは含まれません):
module.exports = {
async redirects() {
return [
{
source: '/old-blog/:slug',
destination: '/news/:slug', // マッチしたパラメータを宛先で使用できます
permanent: true,
},
]
},
}
ワイルドカードパスマッチング
ワイルドカードパスに一致させるには、パラメータの後に*
を使用します。例えば、/blog/:slug*
は/blog/a/b/c/d/hello-world
に一致します:
module.exports = {
async redirects() {
return [
{
source: '/blog/:slug*',
destination: '/news/:slug*', // マッチしたパラメータを宛先で使用できます
permanent: true,
},
]
},
}
正規表現パスマッチング
正規表現パスに一致させるには、パラメータの後に正規表現を括弧で囲みます。例えば、/post/:slug(\\d{1,})
は/post/123
に一致しますが、/post/abc
には一致しません:
module.exports = {
async redirects() {
return [
{
source: '/post/:slug(\\d{1,})',
destination: '/news/:slug', // マッチしたパラメータを宛先で使用できます
permanent: false,
},
]
},
}
次の文字(
、)
、{
、}
、:
、*
、+
、?
は正規表現パスマッチングに使用されるため、source
で特殊値として使用されない場合は、\\
を前に付けてエスケープする必要があります:
module.exports = {
async redirects() {
return [
{
// これは`/english(default)/something`がリクエストされた場合に一致します
source: '/english\\(default\\)/:slug',
destination: '/en-us/:slug',
permanent: false,
},
]
},
}
ヘッダー、クッキー、クエリのマッチング
ヘッダー、クッキー、またはクエリ値も一致する場合にのみリダイレクトを一致させるには、has
フィールドを使用するか、missing
フィールドに一致しない場合に使用できます。リダイレクトが適用されるには、source
とすべてのhas
アイテムが一致し、すべてのmissing
アイテムが一致しない必要があります。
has
とmissing
アイテムには次のフィールドがあります:
type
:String
-header
、cookie
、host
、またはquery
のいずれかでなければなりませんkey
:String
- 一致させる選択されたタイプのキーvalue
:String
またはundefined
- チェックする値。undefinedの場合、任意の値が一致します。正規表現のような文字列を使用して値の特定の部分をキャプチャできます。例えば、first-(?<paramName>.*)
という値がfirst-second
に使用された場合、second
は:paramName
を使用して宛先で使用できます
module.exports = {
async redirects() {
return [
// ヘッダー`x-redirect-me`が存在する場合、
// このリダイレクトが適用されます
{
source: '/:path((?!another-page$).*)',
has: [
{
type: 'header',
key: 'x-redirect-me',
},
],
permanent: false,
destination: '/another-page',
},
// ヘッダー`x-dont-redirect`が存在する場合、
// このリダイレクトは適用されません
{
source: '/:path((?!another-page$).*)',
missing: [
{
type: 'header',
key: 'x-do-not-redirect',
},
],
permanent: false,
destination: '/another-page',
},
// ソース、クエリ、クッキーが一致する場合、
// このリダイレクトが適用されます
{
source: '/specific/:path*',
has: [
{
type: 'query',
key: 'page',
// 値が提供され、名前付きキャプチャグループ(例:(?<page>home))が使用されていないため、
// ページ値は宛先で利用できません
value: 'home',
},
{
type: 'cookie',
key: 'authorized',
value: 'true',
},
],
permanent: false,
destination: '/another/:path*',
},
// ヘッダー`x-authorized`が存在し、
// 一致する値が含まれている場合、このリダイレクトが適用されます
{
source: '/',
has: [
{
type: 'header',
key: 'x-authorized',
value: '(?<authorized>yes|true)',
},
],
permanent: false,
destination: '/home?authorized=:authorized',
},
// ホストが`example.com`の場合、
// このリダイレクトが適用されます
{
source: '/:path((?!another-page$).*)',
has: [
{
type: 'host',
value: 'example.com',
},
],
permanent: false,
destination: '/another-page',
},
]
},
}
basePathをサポートしたリダイレクト
basePath
サポートをリダイレクトで活用する場合、各source
とdestination
には自動的にbasePath
がプレフィックスとして追加されます(リダイレクトにbasePath: false
を追加しない限り):
module.exports = {
basePath: '/docs',
async redirects() {
return [
{
source: '/with-basePath', // 自動的に/docs/with-basePathになります
destination: '/another', // 自動的に/docs/anotherになります
permanent: false,
},
{
// basePath: falseが設定されているため/docsを追加しません
source: '/without-basePath',
destination: 'https://example.com',
basePath: false,
permanent: false,
},
]
},
}
i18nをサポートしたリダイレクト
i18n
サポートをリダイレクトで活用する場合、各source
とdestination
には自動的に設定されたlocales
を処理するためのプレフィックスが追加されます(リダイレクトにlocale: false
を追加しない限り)。locale: false
を使用する場合、source
とdestination
にロケールをプレフィックスとして付ける必要があります。
module.exports = {
i18n: {
locales: ['en', 'fr', 'de'],
defaultLocale: 'en',
},
async redirects() {
return [
{
source: '/with-locale', // すべてのロケールを自動的に処理します
destination: '/another', // ロケールを自動的に渡します
permanent: false,
},
{
// locale: falseが設定されているため、ロケールを自動的に処理しません
source: '/nl/with-locale-manual',
destination: '/nl/another',
locale: false,
permanent: false,
},
{
// `en`がdefaultLocaleであるため、これは'/'に一致します
source: '/en',
destination: '/en/another',
locale: false,
permanent: false,
},
// locale: falseが設定されていても、すべてのロケールを一致させることが可能です
{
source: '/:locale/page',
destination: '/en/newpage',
permanent: false,
locale: false,
},
{
// これは/(en|fr|de)/(.*)に変換されるため、
// `/:path*`のようにトップレベルの`/`や`/fr`ルートには一致しません
source: '/(.*)',
destination: '/another',
permanent: false,
},
]
},
}
まれなケースでは、古いHTTPクライアントが適切にリダイレクトするためにカスタムステータスコードを割り当てる必要がある場合があります。これらの場合、permanent
プロパティの代わりにstatusCode
プロパティを使用できますが、両方を使用することはできません。IE11との互換性を確保するために、308ステータスコードには自動的にRefresh
ヘッダーが追加されます。
その他のリダイレクト
- API RoutesとRoute Handlers内では、受信リクエストに基づいてリダイレクトできます
getStaticProps
とgetServerSideProps
内では、リクエスト時に特定のページをリダイレクトできます
バージョン履歴
バージョン | 変更内容 |
---|---|
v13.3.0 | missing を追加 |
v10.2.0 | has を追加 |
v9.5.0 | redirects を追加 |