如何实现 NestJs 配置文件、.env (DOTENV)、TypeOrm 数据库配置和迁移

Question

我一直在尝试让我的 TypeOrm Config 与 Migrations 和 .env 很好地配合工作，而不需要在两个地方指定它。

困难在于 - 我的迁移脚本需要读取立即返回的对象 -

{
  type: 'postgres',
  host: '127.0.0.1',
  port: 5432,
  username: 'postgres',
  password: 'myPassword',
  database: 'postgres',
  entities: [ 'dist/**/*.entity.js' ],
  logging: [ 'query', 'error', 'schema' ],
  synchronize: false,
  migrations: [ 'dist/app/database/migrations/*.js' ],
  cli: { migrationsDir: 'src/app/database/migrations' },
  namingStrategy: SnakeNamingStrategy {
    nestedSetColumnNames: { left: 'nsleft', right: 'nsright' },
    materializedPathColumnName: 'mpath'
  },
  subscribers: [],
  migrationsRun: false,
  dropSchema: false
}

但是当我使用 NestJs 建议的配置同时还利用 .env (DOTENV) 文件时，解决方案如下所示：

import {TypeOrmModuleOptions, TypeOrmOptionsFactory} from "@nestjs/typeorm";
import {SnakeNamingStrategy} from "typeorm-naming-strategies";

export class DatabaseConfiguration implements TypeOrmOptionsFactory {
  createTypeOrmOptions(): TypeOrmModuleOptions | Promise<TypeOrmModuleOptions> {
    return {
      type: "postgres",
      host: process.env.POSTGRES_HOST,
      port: parseInt(process.env.POSTGRES_PORT, 10) || 5432,
      username: process.env.POSTGRES_USERNAME,
      password: process.env.POSTGRES_PASSWORD,
      database: process.env.POSTGRES_DATABASE,

      entities: [process.env.TYPEORM_ENTITIES],
      logging: true,
      synchronize: false,
      migrations: [process.env.TYPEORM_MIGRATIONS],
      cli: {
        migrationsDir: process.env.TYPEORM_MIGRATIONS_DIR,
      },
      namingStrategy: new SnakeNamingStrategy(),
    };
  }
}

我已经告诉 TypeOrm 在哪里可以找到配置文件（非常重要）在我的 package.json 中，如下所示（参见 --config 标记）：

"typeorm": "node --require ts-node/登记./node_modules/typeorm/cli.js --config dist/app/config/database.configuration.js"

这意味着我的迁移需要调用 (new DatabaseConfiguration()).createTypeOrmOptions() 来获取对象。否则，它将隐藏在 DatabaseConfiguration 类的 createTypeOrmOptions 函数内。

这导致了 TypeOrm 错误： MissingDriverError：错误的驱动程序：给出“未定义”。支持的驱动程序有：“aurora-data-api”、“aurora-data-api-pg”、“better-sqlite3”、“capacitor”、“cockroachdb”、“cordova”、“expo”、“mariadb”、“mongodb” ”、“mssql”、“mysql”、“nativescript”、“oracle”、“postgres”、“react-native”、“sap”、“sqlite”、 “sqljs”

因为正如您在 node_modules/typeorm/driver/DriverFactory.js 文件中看到的，它正在寻找作为对象 connection.options< 的连接/code> 可以获取 type 来创建正确的驱动程序）-

DriverFactory.prototype.create = function (connection) {
        console.log(connection.options);
        var type = connection.options.type;
        switch (type) {
            case "mysql":
                return new MysqlDriver_1.MysqlDriver(connection);
            case "postgres":
                return new PostgresDriver_1.PostgresDriver(connection);
        ...
       }
    }
};

我的 type 未定义。

因此，对于那些不想花几个小时调试这个的人，请参阅下面我的详细设置...如果有帮助的话，请投票我的问题和答案，因为我在任何地方都找不到全面的答案。

Answer 1

这是我的设置从开始到结束。

首先，让我们解决使用 NestJs、dotenv 和配置文件运行数据库的基本设置。显然，我们已经放弃了不支持 .env 的 ormconfig.json。

app.module.ts

imports: [
    ConfigModule.forRoot({ isGlobal: true }),
    TypeOrmModule.forRootAsync({
      useClass: DatabaseConfiguration,
    }),
    ...
]

database.configuration.ts

import {TypeOrmModuleOptions, TypeOrmOptionsFactory} from "@nestjs/typeorm";
import {SnakeNamingStrategy} from "typeorm-naming-strategies";

export class DatabaseConfiguration implements TypeOrmOptionsFactory {
  createTypeOrmOptions(): TypeOrmModuleOptions | Promise<TypeOrmModuleOptions> {
    return {
      type: "postgres",
      host: process.env.POSTGRES_HOST,
      port: parseInt(process.env.POSTGRES_PORT, 10) || 5432,
      username: process.env.POSTGRES_USERNAME,
      password: process.env.POSTGRES_PASSWORD,
      database: process.env.POSTGRES_DATABASE,

      entities: [process.env.TYPEORM_ENTITIES],
      logging: true,
      synchronize: false,
      migrations: [process.env.TYPEORM_MIGRATIONS],
      cli: {
        migrationsDir: process.env.TYPEORM_MIGRATIONS_DIR,
      },
      namingStrategy: new SnakeNamingStrategy(),
    };
  }
}

.env

POSTGRES_TYPE="postgres"
POSTGRES_HOST=127.0.0.1
POSTGRES_PORT=5432
POSTGRES_USERNAME="postgres"
POSTGRES_PASSWORD="takeMyPassword123"
POSTGRES_DATABASE=postgres

TYPEORM_ENTITIES="dist/**/*.entity.js"
TYPEORM_MIGRATIONS="dist/database/migrations/*.js"
TYPEORM_MIGRATIONS_DIR="src/database/migrations"

这样，您的应用程序应该连接到 postgres 数据库并运行 TypeOrm 查询。
但是如果您想支持迁移怎么办？

我们需要在database.configuration.ts文件之上添加一个小的附加层来提取需要返回的迁移对象。

所以这是一个新的配置文件：

migration.configuration.ts

import {DatabaseConfiguration} from "./database.configuration";

export default (new DatabaseConfiguration()).createTypeOrmOptions()

然后剩下要做的就是更新我们的 package.json 以查看 migration.configuration。 ts 文件调用我们的databaseConfig 文件并返回渲染的对象。

package.json

"scripts": {
    ...
    "typeorm": "node --require ts-node/register ./node_modules/typeorm/cli.js --config dist/app/config/migration.configuration.js",
    "make:migration-initial": "npm run build && npm run typeorm migration:generate -- -n initial",
    "migrate": "npm run build && npm run typeorm migration:run",
    "migrate:rollback": "npm run build && npm run typeorm migration:revert",
    "migrate:destroy": "npm run build && npm run typeorm migration:revert && rimraf src/app/database/migrations"
    ...
  },

我在那里留下了一些其他脚本...但重要的是 typeorm 脚本，再次参见 --config它定义了 TypeOrm 配置对象将返回的位置。

Answer 2

@Jay 提出的解决方案对我有用，但迁移除外。我通过稍微修改 migration.configuration.ts 来修复它，如下所示：

import { DatabaseConfiguration } from './database.configuration';
import { DataSource, DataSourceOptions } from 'typeorm';
import { NestFactory } from '@nestjs/core';
import { ConfigModule } from '@nestjs/config';

export default NestFactory.create(
  ConfigModule.forRoot(),
).then(() => {
  const dataSourceOptions =
    new DatabaseConfiguration().createTypeOrmOptions() as DataSourceOptions;
  return new DataSource(dataSourceOptions);
});

技巧是实例化 ConfigModule 以读取 .env 文件存在于项目的根目录中。
为了利用不同的 *.env 文件，人们可能希望将其作为参数传递给 forRoot() 方法（如 文档），例如：

ConfigModule.forRoot({
  envFilePath: '.development.env',
});