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 http://localhost:${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をセットアップすることもできます（例）。カスタムサーバーは次のimportを使用して、サーバーをNext.jsアプリケーションと接続します：

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

上記のnextimportは、以下のオプションを含むオブジェクトを受け取る関数です：

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

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

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

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

module.exports = {
  useFileSystemPublicRoutes: false,
}

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

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