跳到内容
页面路由指南自定义服务器

如何在 Next.js 中设置自定义服务器

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

须知:

  • 在决定使用自定义服务器之前，请记住，只有当 Next.js 的集成路由器无法满足你的应用程序需求时，才应该使用它。自定义服务器会移除重要的性能优化，例如自动静态优化。
  • 当使用独立输出模式时，它不会跟踪自定义服务器文件。这种模式会输出一个单独的最小 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://:${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 服务器
turbopack布尔值（可选）启用 Turbopack（默认启用）
webpack布尔值（可选）启用 webpack

返回的 app 可用于让 Next.js 按需处理请求。

禁用文件系统路由

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

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

next.config.js
module.exports = {
  useFileSystemPublicRoutes: false,
}

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

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