跳到内容
构建你的应用配置自定义服务器

自定义服务器

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 (示例)。自定义服务器使用以下导入将服务器与 Next.js 应用程序连接起来

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

上面的 next 导入是一个函数,它接收一个具有以下选项的对象

选项类型描述
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 根据需要处理请求。