如何在NestJS中结合ConfigService配置PostgreSQL（使用pg包）

核心问题分析 #

你之前的尝试存在两个关键问题：

1. 直接实例化ConfigService无法获取Nest配置模块加载的环境变量，因为ConfigService依赖Nest容器的初始化上下文。
2. 静态成员无法访问实例的this上下文，导致静态pool无法获取实例化的配置参数。

正确实现方式：利用Nest依赖注入管理连接池 #

Nest的依赖注入（DI）系统是处理这类配置的标准方式，既可以正确获取ConfigService，又能保证连接池的生命周期由Nest管理。

方式1：直接注册Pool作为可注入提供者

1. 创建数据库提供者文件（database.providers.ts）

import { Provider } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { Pool } from 'pg';
import configJson from './config/database.json';

export const databaseProviders: Provider[] = [
  {
    provide: 'PG_POOL', // 自定义注入令牌
    useFactory: async (configService: ConfigService) => {
      // 通过ConfigService获取当前环境
      const env = configService.get<string>('NODE_ENV') || 'development';
      const dbConfig = configJson[env];

      // 创建连接池
      const pool = new Pool({
        user: dbConfig.username,
        host: dbConfig.host,
        database: dbConfig.database,
        password: dbConfig.password,
        port: dbConfig.port,
        max: dbConfig.maxClients,
      });

      // 可选：启动时测试连接
      try {
        await pool.connect();
        console.log('PostgreSQL连接成功');
      } catch (err) {
        console.error('PostgreSQL连接失败', err);
        throw err; // 连接失败时终止应用启动
      }

      return pool;
    },
    inject: [ConfigService], // 注入ConfigService依赖
  },
];

2. 创建数据库模块（database.module.ts）

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { databaseProviders } from './database.providers';

@Module({
  imports: [ConfigModule], // 导入ConfigModule以使用ConfigService
  providers: [...databaseProviders],
  exports: [...databaseProviders], // 导出提供者，供其他模块使用
})
export class DatabaseModule {}

3. 在服务中注入连接池

import { Injectable, Inject } from '@nestjs/common';
import { Response } from 'express';
import { Pool } from 'pg';

@Injectable()
export class MyService {
  // 通过注入令牌获取Pool实例
  constructor(@Inject('PG_POOL') private readonly pool: Pool) {}

  async getDocumentByName(res: Response, name: string) {
    try {
      const result = await this.pool.query('SELECT * FROM documents WHERE name = $1', [name]);
      res.json(result.rows);
    } catch (err) {
      res.status(500).json({ error: err.message });
    }
  }

  // 其他数据库操作方法...
}

4. 在根模块中导入DatabaseModule

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { DatabaseModule } from './database/database.module';
import { MyService } from './my.service';
import { MyController } from './my.controller';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true, // 全局模块，避免重复导入
      envFilePath: `.env.${process.env.NODE_ENV || 'development'}`, // 根据环境加载对应env文件
    }),
    DatabaseModule,
  ],
  controllers: [MyController],
  providers: [MyService],
})
export class AppModule {}

方式2：封装成Injectable服务类

如果你希望封装更多数据库相关逻辑，可以创建一个服务类持有连接池：

import { Injectable } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { Pool } from 'pg';
import configJson from './config/database.json';

@Injectable()
export class PgService {
  public readonly pool: Pool;

  constructor(private configService: ConfigService) {
    const env = configService.get<string>('NODE_ENV') || 'development';
    const dbConfig = configJson[env];
    this.pool = new Pool({
      user: dbConfig.username,
      host: dbConfig.host,
      database: dbConfig.database,
      password: dbConfig.password,
      port: dbConfig.port,
      max: dbConfig.maxClients,
    });
  }
}

然后在DatabaseModule中导出这个服务，在业务服务中注入PgService即可使用pgService.pool。

更优的PostgreSQL配置实践 #

1. 使用环境变量替代JSON配置文件
   遵循12-Factor应用原则，将数据库配置存入环境变量，比如创建.env.development、.env.production文件：

   PG_USER=dev_user
   PG_HOST=localhost
   PG_DATABASE=dev_db
   PG_PASSWORD=dev_pass
   PG_PORT=5432
   PG_MAX_CLIENTS=10
   

   然后在提供者中直接从ConfigService读取：

   useFactory: (configService: ConfigService) => {
     return new Pool({
       user: configService.get<string>('PG_USER'),
       host: configService.get<string>('PG_HOST'),
       database: configService.get<string>('PG_DATABASE'),
       password: configService.get<string>('PG_PASSWORD'),
       port: configService.get<number>('PG_PORT'),
       max: configService.get<number>('PG_MAX_CLIENTS'),
     });
   },
   

2. 添加连接池优化配置
   根据业务需求配置连接池的超时、闲置回收等参数：

   const pool = new Pool({
     // ...基础配置
     idleTimeoutMillis: 30000, // 闲置连接30秒后回收
     connectionTimeoutMillis: 2000, // 连接超时时间2秒
   });
   

3. 集成健康检查
   使用Nest的@nestjs/terminus包添加数据库健康检查，实时监控连接状态。

内容的提问来源于stack exchange，提问作者Nelson Teixeira