Nestjs Subscriber +TypeOrm通过yml文件注入

基础概念

NestJS Subscriber: 在NestJS中，Subscriber是一种特殊的类，用于监听应用程序中的事件。它可以订阅应用程序生命周期事件、模块加载事件等，并在这些事件发生时执行特定的逻辑。

TypeORM: 是一个强大的ORM（对象关系映射）库，用于Node.js，支持多种数据库。它允许开发者通过类和装饰器来定义数据库实体，并提供了丰富的查询构建器和事务管理功能。

YML文件注入: YML（YAML）是一种人类可读的数据序列化标准，常用于配置文件。通过YML文件注入，可以在应用程序启动时读取配置信息，并将其应用到TypeORM或其他服务中。

类型与应用场景

类型:

数据库连接配置: 包括数据库类型、主机地址、端口、用户名、密码等。
实体映射: 定义数据库表与实体类的对应关系。
应用配置: 如日志级别、缓存策略等。

应用场景:

多环境配置: 开发、测试、生产环境的配置分离。
动态配置加载: 应用启动时根据YML文件动态加载配置。
模块化设计: 不同模块可以有自己的配置文件，便于管理和扩展。

示例代码

假设我们有一个database.yml文件，内容如下：

default:
  type: 'mysql'
  host: 'localhost'
  port: 3306
  username: 'root'
  password: 'password'
  database: 'mydb'
  entities:
    - './src/entities/**/*.entity{.ts,.js}'
  synchronize: true

在NestJS中使用这个配置文件：

import { TypeOrmModuleOptions, TypeOrmModule } from '@nestjs/typeorm';
import * as yaml from 'js-yaml';
import * as fs from 'fs';

// 读取YML文件并解析为对象
const dbConfig = yaml.safeLoad(fs.readFileSync('./config/database.yml', 'utf8'));

@Module({
  imports: [
    TypeOrmModule.forRootAsync({
      useFactory: () => ({
        type: dbConfig.default.type,
        host: dbConfig.default.host,
        port: dbConfig.default.port,
        username: dbConfig.default.username,
        password: dbConfig.default.password,
        database: dbConfig.default.database,
        entities: dbConfig.default.entities,
        synchronize: dbConfig.default.synchronize,
      }),
    }),
  ],
})
export class AppModule {}

遇到问题及解决方法

问题: 配置文件读取失败或解析错误。

原因:

文件路径错误。
文件格式不正确或包含非法字符。
权限问题导致无法读取文件。

解决方法:

检查文件路径: 确保文件路径正确无误。
验证文件格式: 使用在线YAML验证工具检查文件格式是否正确。
权限设置: 确保应用程序有足够的权限读取配置文件。

示例错误处理代码:

try {
  const dbConfig = yaml.safeLoad(fs.readFileSync('./config/database.yml', 'utf8'));
} catch (error) {
  console.error('Failed to load database configuration:', error);
  process.exit(1); // 终止进程
}

通过这种方式，可以在启动时捕获并处理配置文件相关的错误，避免应用程序因配置问题而崩溃。