Next.jsでカスタムサーバーを設定する方法

Next.jsはデフォルトでnext startを使用して独自のサーバーを含んでいます。既存のバックエンドがある場合でも、Next.jsと併用できます（これはカスタムサーバーではありません）。カスタムNext.jsサーバーを使用すると、カスタムパターン用にプログラムでサーバーを起動できます。ほとんどの場合、このアプローチは必要ありません。ただし、必要であればエジェクトすることも可能です。

知っておくと良いこと:

• カスタムサーバーの使用を決定する前に、Next.jsの統合ルーターではアプリの要件を満たせない場合にのみ使用すべきであることを覚えておいてください。カスタムサーバーは、自動静的最適化のような重要なパフォーマンス最適化を削除します。
• スタンドアロン出力モードを使用する場合、カスタムサーバーファイルはトレースされません。代わりに、このモードでは個別の最小限のserver.jsファイルが出力されます。これらを一緒に使用することはできません。

カスタムサーバーの以下の例をご覧ください。

import { createServer } from 'http'
import { parse } from 'url'
import next from 'next'
 
const port = parseInt(process.env.PORT || '3000', 10)
const dev = process.env.NODE_ENV !== 'production'
const app = next({ dev })
const handle = app.getRequestHandler()
 
app.prepare().then(() => {
  createServer((req, res) => {
    const parsedUrl = parse(req.url!, true)
    handle(req, res, parsedUrl)
  }).listen(port)
 
  console.log(
    `> Server listening at https://:${port} as ${
      dev ? 'development' : process.env.NODE_ENV
    }`
  )
})

server.jsはNext.jsコンパイラまたはバンドリングプロセスを通過しません。このファイルが必要とする構文とソースコードが、使用している現在のNode.jsバージョンと互換性があることを確認してください。例を表示。

カスタムサーバーを実行するには、package.jsonのscriptsを次のように更新する必要があります。

{
  "scripts": {
    "dev": "node server.js",
    "build": "next build",
    "start": "NODE_ENV=production node server.js"
  }
}

または、nodemonを設定することもできます（例）。カスタムサーバーは、サーバーをNext.jsアプリケーションに接続するために次のインポートを使用します。

import next from 'next'
 
const app = next({})

上記のnextインポートは、次のオプションを持つオブジェクトを受け取る関数です。

返されたappを使用して、必要に応じてNext.jsにリクエストを処理させることができます。

ファイルシステムルーティングの無効化

デフォルトでは、Nextはpagesフォルダー内の各ファイルをファイル名に一致するパス名で提供します。プロジェクトがカスタムサーバーを使用している場合、この動作により同じコンテンツが複数のパスから提供される可能性があり、SEOやUXの問題が発生する可能性があります。

この動作を無効にし、pagesのファイルに基づいたルーティングを防ぐには、next.config.jsを開き、useFileSystemPublicRoutes設定を無効にします。

module.exports = {
  useFileSystemPublicRoutes: false,
}

useFileSystemPublicRoutesはSSRのファイル名ルートを無効にすることに注意してください。クライアントサイドルーティングでは、これらのパスにアクセスできる可能性があります。このオプションを使用する場合は、プログラムで意図しないルートへのナビゲーションを防ぐ必要があります。

クライアントサイドルーターを設定して、ファイル名ルートへのクライアントサイドリダイレクトを許可しないようにすることもできます。その場合は、router.beforePopStateを参照してください。