How to set up a custom server in Next.js

Next.js 默认通过 next start 包含了自己的服务器。如果你有现有的后端，你仍然可以将其与 Next.js 一起使用（这不是自定义服务器）。自定义 Next.js 服务器允许你以编程方式启动服务器以实现自定义模式。大多数情况下，你不需要这种方法。但是，如果你需要脱离默认配置，这个选项是可用的。

值得注意的是：

在决定使用自定义服务器之前，请记住只有当 Next.js 的集成路由器无法满足你的应用需求时才应使用它。自定义服务器将移除重要的性能优化，比如 自动静态优化。

当使用独立输出模式时，它不会跟踪自定义服务器文件。这种模式会输出一个单独的最小化 server.js 文件。这两者不能一起使用。

看看以下自定义服务器的示例：

server.ts

TypeScript

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，如下所示：

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`	`Object`	与 `next.config.js` 中使用的对象相同。默认为 `{}`
`dev`	`Boolean`	（可选）是否以开发模式启动 Next.js。默认为 `false`
`dir`	`String`	（可选）Next.js 项目的位置。默认为 `'.'`
`quiet`	`Boolean`	（可选）隐藏包含服务器信息的错误消息。默认为 `false`
`hostname`	`String`	（可选）服务器运行的主机名
`port`	`Number`	（可选）服务器运行的端口
`httpServer`	`node:http#Server`	（可选）Next.js 运行的 HTTP 服务器
`turbo`	`Boolean`	（可选）启用 Turbopack

然后可以使用返回的 app 让 Next.js 根据需要处理请求。