如何在Remix服务器启动时仅运行一次初始化代码？

由于entry.server.tsx会在每个请求时都被执行，所以不适合存放仅需启动时运行一次的初始化逻辑。针对默认Remix服务器（通过remix serve启动），有两种可靠方案：

1. 修改项目根目录的server.ts/server.js文件 #

默认Remix服务器的入口是项目根目录下的server.ts（或JS版本），这里的代码只会在服务器启动时执行一次。你可以在启动Express实例并监听端口前，加入初始化逻辑：

import { createRequestHandler } from "@remix-run/express";
import express from "express";

// 定义初始化函数，仅在服务器启动时执行
async function runServerInit() {
  // 这里写你的初始化逻辑：比如连接数据库、加载全局配置、预缓存数据等
  console.log("服务器启动初始化完成 - 仅执行一次");
}

// 先完成初始化，再启动服务器
runServerInit()
  .then(() => {
    const app = express();

    // 保留原有的中间件和请求处理器配置
    app.use(express.static("public"));

    app.all(
      "*",
      createRequestHandler({
        build: require("./build"),
        mode: process.env.NODE_ENV,
      })
    );

    const port = process.env.PORT || 3000;
    app.listen(port, () => {
      console.log(`服务器运行在 http://localhost:${port}`);
    });
  })
  .catch((err) => {
    console.error("初始化失败，终止服务器启动:", err);
    process.exit(1);
  });

2. 开发环境（Vite）下的补充方案 #

如果你使用Remix Vite开发服务器（remix vite dev），可以在vite.config.ts中通过插件钩子实现启动时初始化：

import { vitePlugin as remix } from "@remix-run/dev";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [
    remix(),
    {
      name: "server-init-plugin",
      configureServer(server) {
        // 仅在Vite开发服务器启动时执行一次
        console.log("Vite开发服务器启动初始化");
        // 开发环境专属初始化逻辑
      },
    },
  ],
});

关键注意事项 #

• 确保初始化逻辑是异步安全的：比如数据库连接这类异步操作，要等待Promise完成后再启动服务器，避免出现服务已启动但初始化未完成的问题。
• 生产环境下，server.ts会被编译到build目录，所以修改后需要重新构建或重启服务器才能生效。

内容的提问来源于stack exchange，提问作者Adam A