How to set up a custom server in Next.js

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

值得注意的是：

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

当使用 standalone 输出模式时，它不会追踪自定义服务器文件。此模式会输出一个单独的最小化 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 Compiler 或打包过程运行。确保此文件所需的语法和源代码与你正在使用的当前 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 导入是一个函数，它接收一个具有以下选项的对象：

Option	Type	Description
`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 Server
`turbopack`	`Boolean`	（可选）启用 Turbopack（默认启用）
`webpack`	`Boolean`	（可选）启用 webpack

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

禁用文件系统路由

默认情况下，Next 将在与文件名匹配的路径名下提供 pages 文件夹中的每个文件。如果你的项目使用自定义服务器，此行为可能会导致从多个路径提供相同的内容，这可能会带来 SEO 和 UX 问题。

要禁用此行为并防止基于 pages 中文件的路由，请打开 next.config.js 并禁用 useFileSystemPublicRoutes 配置：

next.config.js

module.exports = {
  useFileSystemPublicRoutes: false,
}

请注意，useFileSystemPublicRoutes 会禁用来自 SSR 的文件名路由；客户端路由可能仍然可以访问这些路径。使用此选项时，你应该防止导航到你不希望以编程方式访问的路由。

你可能还希望配置客户端路由器以禁止客户端重定向到文件名路由；为此请参阅 router.beforePopState。