web-dev-qa-db-ja.com

Nest.jsでは、デコレータ内でサービスインスタンスを取得する方法を教えてください。

CustomDecoratorでは、Nest.jsで定義されたサービスインスタンスにアクセスする方法を教えてください。

export const CustomDecorator = (): MethodDecorator => {
  return (
    target: Object,
    propertyKey: string | symbol,
    descriptor: PropertyDescriptor
    ) => {

    // Here, is possibile to access a Nest.js service (i.e. TestService) instance?

    return descriptor;
  }
};
javascripttypescriptecmascript-6nestjstypescript-decorator
15
gremo

いくつかのポイントがあります：

  • decorated instanceの前に実行されるプロパティデコレータが作成されます。
  • デコレータがsome instanceのインジェクタによって解決されたdecorated instanceを使用したい。

簡単な方法として、some instanceによって挿入されたdecorated instanceを使用します。

@Injectable()
export class CatsService {
  constructor(public myService: MyService){}

  @CustomDecorator()
  foo(){}
}

export const CustomDecorator = (): MethodDecorator => {
  return (
    target: Object,
    propertyKey: string | symbol,
    descriptor: PropertyDescriptor
  ) => {

    const originalMethod = descriptor.value;

    descriptor.value = function () {
      const serviceInstance = this;
      console.log(serviceInstance.myService);

    }

    return descriptor;
  }
};

PS私はそれが どういうわけか であると思うと、インジェクターのインスタンスを使用して目的のインスタンスを取得できます（- angular does など）。

6
Buggy

この質問に出くわし、1日を過ごして良い答えを見つけようとしました。これはすべてのユースケースに適合するとは限りませんが、Nestのコアパッケージに共通のパターンをコピーして自分のニーズに合わせることができました。

イベントを処理するコントローラーメソッドに注釈を付けるための独自のデコレーターを作成したかった（たとえば、@Subscribe('some.topic.key') async handler() { ... })）。

これを実装するために、私のデコレータは@nestjs/commonのSetMetadataを使用して、必要なメタデータ（適用されていたメソッド名、属しているクラス、メソッドへの参照）を登録しました。

export const Subscribe = (topic: string) => {
  return (target: any, propertyKey: string, descriptor: PropertyDescriptor) => {
    SetMetadata<string, RabbitSubscriberMetadataConfiguration>(
      RABBITMQ_SUBSCRIBER,
      {
        topic,
        target: target.constructor.name,
        methodName: propertyKey,
        callback: descriptor.value,
      },
    )(target, propertyKey, descriptor);
  };
};

そこから、Nestのライフサイクルフックにフックする独自のモジュールを作成して、デコレータで装飾したすべてのメソッドを見つけ、それにいくつかのロジックを適用することができました。

@Module({
  imports: [RabbitmqChannelProvider],
  providers: [RabbitmqService, MetadataScanner, RabbitmqSubscriberExplorer],
  exports: [RabbitmqService],
})
export class RabbitmqModule implements OnModuleInit {
  constructor(
    private readonly Explorer: RabbitmqSubscriberExplorer,
    private readonly rabbitmqService: RabbitmqService,
  ) {}

  async onModuleInit() {
    // find everything marked with @Subscribe
    const subscribers = this.Explorer.explore();
    // set up subscriptions
    for (const subscriber of subscribers) {
      await this.rabbitmqService.subscribe(
        subscriber.topic,
        subscriber.callback,
      );
    }
  }
}

Explorerサービスは、@nestjs/coreのいくつかのユーティリティを使用して、コンテナをイントロスペクトし、装飾されたすべての関数とそのメタデータの検索を処理しました。

@Injectable()
export class RabbitmqSubscriberExplorer {
  constructor(
    private readonly modulesContainer: ModulesContainer,
    private readonly metadataScanner: MetadataScanner,
  ) {}

  public explore(): RabbitSubscriberMetadataConfiguration[] {
    // find all the controllers
    const modules = [...this.modulesContainer.values()];
    const controllersMap = modules
      .filter(({ controllers }) => controllers.size > 0)
      .map(({ controllers }) => controllers);

    // munge the instance wrappers into a Nice format
    const instanceWrappers: InstanceWrapper<Controller>[] = [];
    controllersMap.forEach(map => {
      const mapKeys = [...map.keys()];
      instanceWrappers.Push(
        ...mapKeys.map(key => {
          return map.get(key);
        }),
      );
    });

    // find the handlers marked with @Subscribe
    return instanceWrappers
      .map(({ instance }) => {
        const instancePrototype = Object.getPrototypeOf(instance);
        return this.metadataScanner.scanFromPrototype(
          instance,
          instancePrototype,
          method =>
            this.exploreMethodMetadata(instance, instancePrototype, method),
        );
      })
      .reduce((prev, curr) => {
        return prev.concat(curr);
      });
  }

  public exploreMethodMetadata(
    instance: object,
    instancePrototype: Controller,
    methodKey: string,
  ): RabbitSubscriberMetadataConfiguration | null {
    const targetCallback = instancePrototype[methodKey];
    const handler = Reflect.getMetadata(RABBITMQ_SUBSCRIBER, targetCallback);
    if (handler == null) {
      return null;
    }
    return handler;
  }
}

これを処理するための最良の方法であるとは考えていませんが、私にとってはうまくいきました。自己責任でこのコードを使用してください。それであなたは始められるはずです:-)。私はここから利用可能なコードを適合させました： https://github.com/nestjs/nest/blob/5.1.0-stable/packages/microservices/listener-metadata-Explorer.ts

3
Mavrick Laakso

パーティーには遅れましたが、同様の問題が発生したため（ デコレータでグローバルネストモジュールを使用 ）、この質問に遭遇しました。

import { Inject } from '@nestjs/common';
export function yourDecorator() {
  const injectYourService = Inject(YourServiceClass);

  return (target: any, propertyKey: string, propertyDescriptor: PropertyDescriptor) => {
    // this is equivalent to have a constructor like constructor(yourservice: YourServiceClass)
    // note that this will injected to the instance, while your decorator runs for the class constructor
    injectYourService(target, 'yourservice');

    // do something in you decorator

    // we use a ref here so we can type it
    const yourservice: YourServiceClass = this.yourservice;
    yourservice.someMethod(someParam);
  };
}
1
florian norbert bepunkt

私はParamDecorator内で構成サービスを使用しようとしていたので、サービスの新しいインスタンスを作成してサービスにアクセスします。

export const MyParamDecorator = createParamDecorator((data, req) => {

  // ...
  const configService = new ConfigService(`${process.env.NODE_ENV || 'default'}.env`);
  const myConfigValue = configService.getMyValue();
  // ...
});
0
Corentin DUPONT