如何在Remix Web应用启动时运行自定义代码？

方法：自定义服务器入口文件 #

Remix允许你创建自定义的服务器入口，替代默认的Remix App Server启动逻辑，以此在服务器启动时执行一次性初始化操作，比如数据库连接池初始化与测试。

步骤1：创建自定义服务器文件 #

在项目根目录新建server.js（TypeScript项目则用server.ts）。

步骤2：编写初始化逻辑与服务器启动代码 #

以下是包含数据库初始化的完整示例：

import { createRequestHandler } from "@remix-run/express";
import express from "express";
import { initDbPool, testDbConnection } from "./app/utils/db.server";

// 启动阶段初始化流程
async function bootstrap() {
  try {
    // 初始化数据库连接池
    await initDbPool();
    // 执行测试查询验证连接可用性
    await testDbConnection();
    console.log("数据库连接初始化成功");
  } catch (error) {
    console.error("启动阶段初始化失败:", error);
    // 初始化失败直接退出进程，避免服务带病运行
    process.exit(1);
  }

  // 启动Remix服务器
  const app = express();
  const build = await import("./build/server");

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

  const port = process.env.PORT || 3000;
  app.listen(port, () => {
    console.log(`Remix服务器启动在 http://localhost:${port}`);
  });
}

// 执行启动流程
bootstrap();

步骤3：修改启动脚本 #

更新package.json中的start脚本，指向自定义服务器文件：

{
  "scripts": {
    "start": "node server.js",
    "dev": "remix vite:dev"
  }
}

步骤4：编写数据库工具函数 #

在app/utils/db.server.js中实现连接池逻辑：

import pg from "pg";

let pool;

export async function initDbPool() {
  pool = new pg.Pool({
    connectionString: process.env.DATABASE_URL,
    // 可添加连接数限制等配置
  });
}

export async function testDbConnection() {
  const client = await pool.connect();
  try {
    // 执行简单测试查询
    await client.query("SELECT 1");
  } finally {
    client.release();
  }
}

// 对外提供连接池实例
export function getDbPool() {
  if (!pool) {
    throw new Error("数据库连接池未初始化，请先调用initDbPool");
  }
  return pool;
}

注意事项 #

• 初始化逻辑必须放在服务器启动前，确保所有准备工作完成后再处理用户请求。
• 开发环境下热重载会重启服务器，初始化逻辑会重复执行，属于正常现象；生产环境仅在启动时执行一次。

内容的提问来源于stack exchange，提问作者Danilo Ferreira