ES6+环境下PostgreSQL+Sequelize+Umzug集成配置求助

我正在ES6+环境下开发一个基于PostgreSQL、Sequelize和Umzug的项目，环境配置阶段遇到问题，寻求三者无缝集成的最佳实践及可行解决方案。以下是我已尝试的配置：

已尝试的配置 #

config.js #

// config/config.js
require('dotenv').config(); // 加载环境变量

module.exports = {
  development: {
    username: process.env.DB_USER,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    host: process.env.DB_HOST,
    port: process.env.DB_PORT,
    dialect: "postgres"
  },
  test: {
    dialect: "postgres"
  },
  production: {
    dialect: "postgres"
  }
};

database.js #

// config/database.js
import Sequelize from 'sequelize';
import dotenv from 'dotenv';

// 加载环境变量
dotenv.config();

const { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_NAME } = process.env;

if (!DB_HOST || !DB_PORT || !DB_USER || !DB_PASSWORD || !DB_NAME || DB_NAME.trim() === '') {
    throw new Error('数据库环境变量缺失或无效。');
}

const sequelize = new Sequelize({
    dialect: 'postgres',
    host: DB_HOST,
    port: DB_PORT,
    username: DB_USER,
    password: DB_PASSWORD,
    database: DB_NAME,
    dialectOptions: {
        ssl: {
            require: true,
            rejectUnauthorized: false, // 本地开发时这行尤为重要
        },
    },
    pool: {
        max: 5, // 最大连接数
        min: 0, // 最小连接数
        acquire: 30000,
        idle: 10000, // 空闲超时时间（毫秒）
    },
});

const connectToPostgres = async () => {
    try {
        await sequelize.authenticate();
        console.log('数据库连接已成功建立。');
    } catch (error) {
        console.error('无法连接到数据库:', error.message);
        // 可选：处理特定错误场景（如不同错误码）
    }
};

const closeConnection = async () => {
    try {
        await sequelize.close();
        console.log('数据库连接已关闭');
    } catch (error) {
        console.error('关闭数据库连接时出错:', error.message);
    }
};

export { sequelize, connectToPostgres, closeConnection };

migrations/umzug.mjs #

// migrations/umzug.mjs
import { Umzug, SequelizeStorage } from 'umzug';
import sequelize from '../config/database.mjs'; // 导入Sequelize实例
import { fileURLToPath } from 'url'; // 导入'url'模块中的fileURLToPath函数
import path, { dirname } from 'path'; // 导入'path'模块中的path和dirname函数

// 将import.meta.url转换为文件路径
const __filename = fileURLToPath(import.meta.url);
const __dirname = dirname(__filename);

// 定义迁移文件目录路径
const migrationsPath = path.join(__dirname, 'migrations');

// 创建Umzug实例
const migrator = new Umzug({
    migrations: {
        glob: ['*.{js,cjs,mjs}', { cwd: migrationsPath }],
    },
    context: sequelize.getQueryInterface(),
    storage: new SequelizeStorage({
        sequelize,
    }),
    logger: console,
});

// 运行Umzug CLI
migrator.runAsCLI();

最佳实践与可行解决方案 #

1. 统一模块格式 #

• 项目同时混用CommonJS和ES模块容易引发加载冲突，建议统一为ES模块：
  • 将config/config.js重命名为config/config.mjs，把module.exports改为export default，require('dotenv').config()替换为import dotenv from 'dotenv'; dotenv.config();
  • 在项目package.json中添加"type": "module"，彻底避免模块格式混淆

2. 环境变量加载优化 #

• 不要在多个文件中重复调用dotenv.config()，建议在项目入口文件（如index.mjs）中一次性加载，确保所有模块能获取到环境变量
• 为不同环境创建独立env文件（如.env.development、.env.production），使用dotenv-flow+cross-env加载对应环境变量：

  npm install dotenv-flow cross-env --save-dev
  

  在package.json中配置环境脚本：

  "scripts": {
    "start:dev": "cross-env NODE_ENV=development node index.mjs",
    "migrate:dev": "cross-env NODE_ENV=development node migrations/umzug.mjs"
  }
  

3. Sequelize配置优化 #

• 复用多环境配置文件，避免重复定义数据库参数：

  // config/database.mjs
  import Sequelize from 'sequelize';
  import dotenvFlow from 'dotenv-flow';
  import config from './config.mjs';
  
  dotenvFlow.config();
  const env = process.env.NODE_ENV || 'development';
  const dbConfig = config[env];
  
  if (!dbConfig.username || !dbConfig.password || !dbConfig.database || !dbConfig.host || !dbConfig.port) {
      throw new Error(`环境${env}下的数据库配置缺失或无效`);
  }
  
  const sequelize = new Sequelize(dbConfig.database, dbConfig.username, dbConfig.password, {
      host: dbConfig.host,
      port: dbConfig.port,
      dialect: dbConfig.dialect,
      dialectOptions: {
          ssl: env === 'production' ? { require: true, rejectUnauthorized: true } : { require: false }
      },
      pool: {
          max: 5,
          min: 0,
          acquire: 30000,
          idle: 10000
      }
  });
  

• 根据环境动态设置SSL：本地开发关闭SSL，生产环境启用严格验证，降低安全风险

4. Umzug配置修正 #

• 修复迁移路径错误：当前代码会指向migrations/migrations，直接使用__dirname即可（因为umzug.mjs已在migrations目录下）：

  // migrations/umzug.mjs
  const migrationsPath = __dirname;
  

• 添加ES模块格式的迁移模板，统一迁移文件规范：

  // 在Umzug配置中补充
  migrations: {
      glob: ['*.mjs', { cwd: migrationsPath }],
      template: {
          content: ({ name }) => `export const up = async (queryInterface) => {
  // 迁移逻辑
  

};

export const down = async (queryInterface) => {
// 回滚逻辑
};
, filename: (name) => ${Date.now()}-${name}.mjs`
}
}

### 5. 标准化脚本命令
在`package.json`中添加常用数据库操作脚本，简化日常操作：
```json
"scripts": {
"db:connect": "node -e \"import('./config/database.mjs').then(m => m.connectToPostgres())\"",
"db:close": "node -e \"import('./config/database.mjs').then(m => m.closeConnection())\"",
"migrate:create": "node migrations/umzug.mjs create --name",
"migrate:up": "node migrations/umzug.mjs up",
"migrate:down": "node migrations/umzug.mjs down",
"migrate:status": "node migrations/umzug.mjs status"
}

6. 增强错误处理 #

• 数据库连接失败时主动退出进程，避免无意义挂起：

  const connectToPostgres = async () => {
      try {
          await sequelize.authenticate();
          console.log('数据库连接已成功建立。');
      } catch (error) {
          console.error('无法连接到数据库:', error.message);
          process.exit(1);
      }
  };
  

• 为Umzug迁移添加全局错误捕获，输出详细日志并退出：

  // migrations/umzug.mjs
  try {
      await migrator.runAsCLI();
  } catch (error) {
      console.error('迁移执行失败:', error);
      process.exit(1);
  }
  

内容的提问来源于stack exchange，提问作者Sourav Dishri