Nestjs 使用node-config&dotenv

封装config库,在项目其它app内使用。配合docker部署,效果更好。

// libs/config/src/config.module.ts
import { resolve } from 'path';
import { Module } from '@nestjs/common';
import { IConfig } from 'config';
import * as dotenv from 'dotenv';

const path = resolve(__dirname, '..', '..', '..');

dotenv.config();
// config目录放在 apps libs 同级,config内的文件,和config库的配置完全一致
process.env['NODE_CONFIG_DIR'] = resolve(path, 'config');
/* eslint @typescript-eslint/no-var-requires: "off" */
const config = require('config');

config.env.current = process.env.NODE_ENV || 'development';
config.env.app = process.env.NODE_APP_INSTANCE;
config.env.isProduction = process.env.NODE_ENV === 'production';
config.env.isProd =
  process.env.NODE_APP_INSTANCE === 'production' &&
  process.env.NODE_ENV === 'production';
// 这个是挂载一个config目录下的文件路径,方便使用
config.env.wsdl = resolve(path, 'config', 'SMS.wsdl');

const provider = {

  // 这个地方可以写常量,方便其它地方使用
  provide: 'NODE_CONFIG',
  useValue: config,
};

@Module({
  providers: [provider],
  exports: [provider],
})
export class ConfigModule {}

export type IConfig = IConfig;
// libs/config/src/index.ts
export * from './config.module';
// 这个是创建config lib 的时候自动生成的,其它的自动生成的文件都可以删除,这个留着就可以了
{
  "extends": "../../tsconfig.json",
  "compilerOptions": {
    "declaration": true,
    "outDir": "../../dist/libs/config"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
}

注意,使用docker部署时,需要把config目录复制到容器内,因为config目录不会被build到dist中。

Nestjs入门

依赖注入几种方式。

封装为库

以pulsar的使用为例。特点:需要注入配置,创建client单例。

实现方式:在module中定义static register方法,返回DynamicModule。

  static register(options: any): DynamicModule {
    return {
      // 封装的模块的名字,即当前模块的名字
      module: PulsarModule,
      imports: options.imports || [],
      providers: [
        {
          // 可以在其它模块使用此字符串注入
          provide: 'PULSAR_CLIENT_URL',
          useFactory: options.useFactory,
          inject: options.inject,
        },
      ],
    };
  }

然后在对应service中提供client的方法:

import { Injectable, Inject } from '@nestjs/common';

import {
  Client,
  Consumer,
  Producer,
  ProducerOpts,
  SubscribeOpts,
} from 'pulsar-client';

@Injectable()
export class PulsarService {
  pulsar: Client;
  constructor(@Inject('PULSAR_CLIENT_URL') private url) {
    this.pulsar = new Client({ serviceUrl: url });
  }

  async buildConsumer(options: SubscribeOpts): Promise<Consumer> {
    return this.pulsar.subscribe(options);
  }

  async buildProducer(options: ProducerOpts): Promise<Producer> {
    return this.pulsar.createProducer(options);
  }

  async closeArr(arr: Consumer[] | Producer[]) {
    if (!arr || !arr.length) return;
    for (const ele of arr) ele.close();
  }

  async close(consumers?: Consumer[], producers?: Producer[]) {
    this.closeArr(consumers);
    this.closeArr(producers);
    if (this.pulsar) {
      this.pulsar.close();
    }
  }
}

关于pulsar,一个消息中间件,已经封装为一个npm库,欢迎使用,star。https://www.npmjs.com/package/nestjs-pulsar