Nestjs - 使用 3rd 方库提供自定义类的正确方法是什么

Question

我是 NestJS 的新手，我没有找到任何明确的指示来做我需要做的事情。

我想使用我以前从未使用过但只听说过好东西的 NestJS 来构建我的后端。所以我要构建的后端服务器将使用来自 npmjs 的名为 ccxt 的第 3 方模块。在一个普通的节点应用程序中，我只会创建一个随机类，例如 CryptoManager，导入 ccxt 模块并编写一些按设定间隔或其他方式运行的函数。然后我会创建一个控制器类来实例化 CryptoManager 类的一个对象，然后我可以从那里返回它的响应。

但是我应该如何使用 NestJS 做到这一点？为了让自定义类运行其他嵌套控制器/服务等中可用的后台任务，我需要做什么？

这个类只是应该执行第 3 方 (ccxt) 模块函数并将结果存储在数据库中。但我希望能够从 nestjs 应用程序中的所有点（从所有模块）执行这些类方法。

我希望我的问题很清楚，如果没有，请告诉我。

Answer 1

您需要结合使用 Modules 和 Providers 以“嵌套方式”执行此操作，然后您可以在整个应用中使用依赖注入。

一般来说，您添加 3rd 方库的方式如下：

1. 创建一个模块来包装您的库，例如“CryptoManagerModule”。
2. 创建一个提供 CCXT 库的自定义提供程序，并将其添加到您的 providers 数组中。
3. 创建服务“CryptoManagerService”，并将 CCXT 注入构造函数。
4. 从您的模块中导出“CryptoManagerService”，以便您可以将其注入应用的其余部分。
5. （可选）将您的模块标记为“全局”，这样您只需在 AppModule 中配置该模块一次，即可使其可用于所有其他模块。

内部crypto-manager.module.ts

import { DynamicModule, Module, Provider } from '@nestjs/common';
import { CryptoManagerService } from './crypto-manager.service';
import * as ccxt from 'ccxt';

// Add any config options you need, like API keys, etc
export interface CryptoManagerModuleOptions {
  global?: boolean;
}

export const KRAKEN_CLIENT_TOKEN = 'KRAKEN_CLIENT_TOKEN';

export class CryptoManagerModule {
  static forRoot(options: CryptoManagerModuleOptions): DynamicModule {
    // An example of injecting a single class of ccxt.  Note this is only available
    // within this module.
    const krakenProvider: Provider = {
      provide: KRAKEN_CLIENT_TOKEN,
      useValue: new ccxt.kraken(),
    };

    return {
      module: CryptoManagerModule,
      providers: [krakenProvider, CryptoManagerService],
      // Exports can be @Inject()'ed to other files, and if global
      // is set, then forRoot only needs to be called in the AppModule
      exports: [CryptoManagerService],
      global: options.global,
    };
  }
}

内部crypto-manager.service.ts

import { Inject, Injectable } from '@nestjs/common';
import { KRAKEN_CLIENT_TOKEN } from './crypto-manager.module';
import { kraken } from 'ccxt';

@Injectable()
export class CryptoManagerService {
  constructor(@Inject(KRAKEN_CLIENT_TOKEN) private kraken: kraken) {}

  loadKrakenMarkets() {
    return this.kraken.loadMarkets();
  }
}

内部app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { CryptoManagerModule } from './crypto-manager/crypto-manager.module';

@Module({
  controllers: [AppController],
  providers: [AppService],
  // Make sure to call forRoot
  imports: [CryptoManagerModule.forRoot({ global: true })],
})
export class AppModule {}

最后，在app.service.ts 中使用它的一个例子。我没有对这个文件做任何特别的事情，你只会看到记录到控制台的结果。

import { Inject, Injectable } from '@nestjs/common';
import { CryptoManagerService } from './crypto-manager/crypto-manager.service';

@Injectable()
export class AppService {
  constructor(private cryptoManagerService: CryptoManagerService) {}

  getHello(): string {
    this.cryptoManagerService.loadKrakenMarkets().then(console.log);
    return 'Hello World!';
  }
}

这样做可以让您在测试时轻松地模拟出kraken，允许您在 forRoot 中传递配置变量以防您想跨项目重用它，并且这种模式在已经是 Nest 社区了。

Answer 2

我为此创建了nestjs-ccxt NestJS CCXT 模块包装器https://www.npmjs.com/package/nestjs-ccxt

首先将CcxtModule 导入为任何其他模块

import { CcxtModule } from 'nestjs-ccxt';

@Module({
  imports: [CcxtModule.forRoot({ ... })],
})
export class AppModule {}

接下来在您的服务中使用普通构造函数注入 CcxtService。

@Injectable()
export class ExchangeService {
  constructor(private ccxtService: CcxtService) {}

  async getBtcUsdtTicker() {
    const client = await this.ccxtService.getClient('binance');
    const ticker = await client.fetchTicker('BTC/USDT');
    return ticker;
  }
}