Next.js服务端一次性初始化技巧与实践

发表于 更新于 分类于 阅读次数：

在Next.js项目中，你可能想要在服务端执行一些只需要初始化一次的代码。这样的代码通常包含配置数据库连接、设置缓存、初始化第三方服务等。

你可以在以下几个地方进行初始化:

  1. 自定义 server.js 文件: 创建一个自定义的 server.js 文件(如果你没有的话)，这个文件允许你设置一个自定义的Express服务器或者其他类型的HTTP服务器。在这个文件里，你可以在服务器启动时执行一次性的初始化代码。 请注意，这种方式在使用Vercel部署时是不推荐的，因为Vercel优化了无服务器的部署。

  2. API路由: 如果你使用的是Next.js的API路由，你可以在一个API路由文件中使用全局变量来存储初始化状态。然后，你可以检查这个变量是否已经被初始化，如果没有，则执行初始化代码。这样的话，初始化代码只会在API路由第一次被调用时执行。

  3. 在_app.js或者_document.js中: 在Next.js项目中，_app.js和_document.js文件允许你控制应用程序级别的布局和样式。你可以在这些文件的服务端代码部分执行初始化代码。

在这些选择中，使用自定义server.js文件通常是最直接的方式，但需要注意的是，如果你使用的是Vercel进行部署，那么这种方法可能不适用。如果你不打算使用自定义服务器或者需要确保代码在Vercel上运行，那么使用API路由的方式可能更适合你。

这是一个使用自定义server.js的简单示例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// server.js
const express = require('express');
const next = require('next');

const dev = process.env.NODE_ENV !== 'production';
const app = next({ dev });
const handle = app.getRequestHandler();

app.prepare().then(() => {
  const server = express();

  // 在这里初始化你的代码
  console.log("初始化代码在这里执行...");

  server.all('*', (req, res) => {
    return handle(req, res);
  });

  server.listen(3000, err => {
    if (err) throw err;
    console.log('> Ready on http://localhost:3000');
  });
});

你可以将server.js文件放在项目的根目录。一旦你创建了server.js，它将成为你应用程序的入口点，这意味着你需要用 Node.js 执行它来启动你的应用程序。

在你的package.json文件中，你需要更新或添加一个scripts部分来启动你的自定义服务器。例如，你可以设置如下的start脚本：

1
2
3
4
5
"scripts": {
  "dev": "node server.js",
  "build": "next build",
  "start": "NODE_ENV=production node server.js"
}

在这个例子中，dev脚本将启动开发服务器，而start脚本将以生产模式启动服务器。使用这些脚本，你可以通过运行npm run dev或者npm run start来启动你的应用程序。

请注意，使用自定义服务器时，你会失去Next.js的一些优化和功能，如自动静态优化和无服务器功能。因此，只有在必要的情况下，你才应该使用自定义服务器。