跳到內容

自訂伺服器

Next.js 預設包含了自己的伺服器,透過 next start 啟動。如果你已有現有的後端,你仍然可以搭配 Next.js 使用(這不是自訂伺服器)。自訂 Next.js 伺服器允許你針對自訂模式以程式化的方式啟動伺服器。大多數情況下,你不需要這種方法。然而,如果你需要彈性調整,它仍然可用。

要知道:

  • 在決定使用自訂伺服器之前,請記住它應該只在 Next.js 的整合路由無法滿足你的應用程式需求時使用。自訂伺服器會移除重要的效能最佳化,例如自動靜態最佳化
  • 自訂伺服器無法部署在 Vercel 上。
  • 當使用獨立輸出模式時,它不會追蹤自訂伺服器檔案。此模式會輸出一個獨立的最小 server.js 檔案。這些不能一起使用。

看看以下自訂伺服器的範例

server.ts
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://127.0.0.1:${port} as ${
      dev ? 'development' : process.env.NODE_ENV
    }`
  )
})

server.js 不會經過 Next.js 編譯器或捆綁程序。請確保此檔案所需的語法和原始碼與你目前使用的 Node.js 版本相容。查看範例

要執行自訂伺服器,你需要更新 package.json 中的 scripts,如下所示

package.json
{
  "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({})

上面的 next import 是一個函數,它接收一個具有以下選項的物件

選項類型描述
conf物件你將在 next.config.js 中使用的相同物件。預設為 {}
dev布林值選用)是否在開發模式下啟動 Next.js。預設為 false
dir字串選用)Next.js 專案的位置。預設為 '.'
quiet布林值選用)隱藏包含伺服器資訊的錯誤訊息。預設為 false
hostname字串選用)伺服器在其後運行的主機名稱
port數字選用)伺服器在其後運行的埠號
httpServernode:http#Server選用)Next.js 在其後運行的 HTTP 伺服器
turbo布林值選用)啟用 Turbopack

返回的 app 然後可以用來讓 Next.js 處理所需的請求。