Nest.js+Postgres+Docker生产极简配置及数据库连接问题

在排查NestJS + TypeORM + Docker场景下的「[TypeOrmModule] Unable to connect to the database.」错误时，发现Postgres/TypeORM的生产环境配置和本地开发不仅参数值不同，还需要额外属性。

本地可运行配置 #

TypeORM 配置代码 #

import { Module as NestJS_Module } from "@nestjs/common";
import { TypeOrmModule, TypeOrmModule as TypeORM_Module } from "@nestjs/typeorm";
import type { TypeOrmModuleOptions } from "@nestjs/typeorm";
import ConfigurationRepresentative from "./Configuration/ConfigurationRepresentative";

@NestJS_Module({
  imports: [
    TypeORM_Module.forRootAsync({
      useFactory: (): TypeOrmModuleOptions => ({
      type: "postgres",
      host: "localhost",
      port: 5432,
      username: "postgres",
      password: "pass1234",
      autoLoadEntities: true,
      synchronize: ConfigurationRepresentative.isLocalExecutionEnvironment
      })
    }),
  ]
})
export default class NestJS_ApplicationRootModule {}

本地开发 docker-compose.yml #

version: "3"

services:
  Database:
    image: postgres
    container_name: LocalDatabase
    restart: always
    ports:
      - "5432:5432"
    volumes:
      - DataBaseData:/var/lib/postgresql/data

volumes:
  DataBaseData:
    driver: local

StackOverflow 配置相关疑问 #

参考StackOverflow上的配置时发现存在重复环境变量，有以下疑问：

• SEQ_DB已定义数据库名，为何DATABASE_URL还要重复？
• SEQ_USER、SEQ_PW与DATABASE_URL中的信息重复，是否冗余？
• 是否必须显式定义DATABASE_URL，能否自动生成？

生产环境配置调整建议 #

生产环境 docker-compose.yaml 调整 #

当前生产环境配置可做如下优化：

version: "3"

services:
  node_js:
    container_name: FrontServer
    build: .
    ports: [ "3000:3000" ]
    depends_on: [ "database" ]
    # 添加环境变量，让NestJS能获取数据库连接信息
    environment:
      - DB_HOST=database
      - DB_PORT=5432
      - DB_USER=postgres
      - DB_PASSWORD=pass1234
      - DB_NAME=postgres # Postgres默认数据库名，若需自定义可在database服务中添加POSTGRES_DB环境变量
  database:
    container_name: Database
    image: postgres
    ports: [ "5432:5432" ]
    environment:
      - POSTGRES_PASSWORD=pass1234
      # 若需自定义数据库名和用户名，可添加以下配置
      # - POSTGRES_DB=your_db_name
      # - POSTGRES_USER=your_db_user
    volumes:
      - Database:/var/lib/postgresql/data # 修正路径，Postgres数据默认存储在/var/lib/postgresql/data

volumes:
  Database: {}

TypeORM_Module.forRootAsync 配置调整 #

需要修改host、添加数据库名，并建议通过环境变量获取配置（增强灵活性）：

import { Module as NestJS_Module } from "@nestjs/common";
import { TypeOrmModule, TypeOrmModule as TypeORM_Module } from "@nestjs/typeorm";
import type { TypeOrmModuleOptions } from "@nestjs/typeorm";
import ConfigurationRepresentative from "./Configuration/ConfigurationRepresentative";

@NestJS_Module({
  imports: [
    TypeORM_Module.forRootAsync({
      useFactory: (): TypeOrmModuleOptions => ({
        type: "postgres",
        host: process.env.DB_HOST || "localhost", // 生产环境取容器服务名'database'
        port: parseInt(process.env.DB_PORT) || 5432,
        username: process.env.DB_USER || "postgres",
        password: process.env.DB_PASSWORD || "pass1234",
        database: process.env.DB_NAME || "postgres", // 必须指定数据库名，生产环境不能省略
        autoLoadEntities: true,
        synchronize: ConfigurationRepresentative.isLocalExecutionEnvironment,
        // 生产环境建议添加的额外属性
        ssl: ConfigurationRepresentative.isProductionEnvironment ? { rejectUnauthorized: false } : false,
        extra: {
          connectionTimeoutMillis: 5000, // 连接超时时间
        }
      })
    }),
  ]
})
export default class NestJS_ApplicationRootModule {}

环境变量重复疑问解答 #

1. SEQ_DB与DATABASE_URL重复的原因：DATABASE_URL是部分框架/工具（如TypeORM迁移工具）支持的标准连接字符串格式，SEQ_DB这类变量是为了直观拆分配置项，方便单独修改或在代码中单独引用。
2. SEQ_USER、SEQ_PW与DATABASE_URL是否冗余：不算完全冗余。拆分的变量更便于代码灵活使用，DATABASE_URL适合直接传入支持该格式的工具。如果代码只使用其中一种方式，另一种可以省略，避免冗余。
3. 是否必须显式定义DATABASE_URL：不是必须的。可以通过拆分的环境变量（如DB_HOST、DB_USER等）构建TypeORM配置；如果需要使用DATABASE_URL，也可以在代码中自动拼接生成，例如：

const databaseUrl = `postgres://${process.env.DB_USER}:${process.env.DB_PASSWORD}@${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_NAME}`;

内容的提问来源于stack exchange，提问作者Takeshi Tokugawa YD