私はクリーンなアーキテクチャ構造を実装しようとすることでNestjsを実験しており、ソリューションを検証したいと思います。それを行うための最良の方法がわからないためです。この例はほとんど疑似コードであり、多くのタイプは説明の焦点ではないため、欠落しているか汎用的であることに注意してください。
私のドメインロジックから始めて、次のようなクラスに実装することができます。
@Injectable()
export class ProfileDomainEntity {
async addAge(profileId: string, age: number): Promise<void> {
const profile = await this.profilesRepository.getOne(profileId)
profile.age = age
await this.profilesRepository.updateOne(profileId, profile)
}
}
ここでprofileRepository
にアクセスする必要がありますが、クリーンアーキテクチャの原則に従って、今すぐに実装に煩わされたくないので、そのためのインターフェイスを作成します。
interface IProfilesRepository {
getOne (profileId: string): object
updateOne (profileId: string, profile: object): bool
}
次に、ProfileDomainEntity
コンストラクターに依存関係を挿入し、期待されるインターフェイスに従うことを確認します。
export class ProfileDomainEntity {
constructor(
private readonly profilesRepository: IProfilesRepository
){}
async addAge(profileId: string, age: number): Promise<void> {
const profile = await this.profilesRepository.getOne(profileId)
profile.age = age
await this.profilesRepository.updateOne(profileId, profile)
}
}
次に、コードを実行できるようにするシンプルなメモリ内実装を作成します。
class ProfilesRepository implements IProfileRepository {
private profiles = {}
getOne(profileId: string) {
return Promise.resolve(this.profiles[profileId])
}
updateOne(profileId: string, profile: object) {
this.profiles[profileId] = profile
return Promise.resolve(true)
}
}
次に、モジュールを使用してすべてを一緒に配線します。
@Module({
providers: [
ProfileDomainEntity,
ProfilesRepository
]
})
export class ProfilesModule {}
ここでの問題は、明らかにProfileRepository
はIProfilesRepository
を実装していますが、IProfilesRepository
ではないため、私が理解している限り、トークンは異なり、Nestは依存関係を解決できません。 。
私が見つけた唯一の解決策は、カスタムプロバイダーを使用して手動でトークンを設定することです。
@Module({
providers: [
ProfileDomainEntity,
{
provide: 'IProfilesRepository',
useClass: ProfilesRepository
}
]
})
export class ProfilesModule {}
そして、@Inject
で使用するトークンを指定して、ProfileDomainEntity
を変更します。
export class ProfileDomainEntity {
constructor(
@Inject('IProfilesRepository') private readonly profilesRepository: IProfilesRepository
){}
}
これは私のすべての依存関係を処理するために使用するのに合理的なアプローチですか、それとも完全に軌道から外れていますか?より良い解決策はありますか?私はこれらすべてのもの(NestJ、クリーンアーキテクチャ/ DDD、TypeScriptなど)についてはかなり新しいので、ここではまったく間違っているかもしれません。
ありがとう
言語の制限/機能 のため、NestJS のインターフェースによる依存関係を 解決することはできません(構造と名目タイピング) 。
また、インターフェイスを使用して依存関係(のタイプ)を定義する場合は、文字列トークンを使用する必要があります。ただし、クラス自体、またはその名前を文字列リテラルとして使用することもできるため、依存関係のコンストラクターなどで、インジェクション中にそれを言及する必要はありません。
例:
_// *** app.module.ts ***
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { AppServiceMock } from './app.service.mock';
process.env.NODE_ENV = 'test'; // or 'development'
const appServiceProvider = {
provide: AppService, // or string token 'AppService'
useClass: process.env.NODE_ENV === 'test' ? AppServiceMock : AppService,
};
@Module({
imports: [],
controllers: [AppController],
providers: [appServiceProvider],
})
export class AppModule {}
// *** app.controller.ts ***
import { Get, Controller } from '@nestjs/common';
import { AppService } from './app.service';
@Controller()
export class AppController {
constructor(private readonly appService: AppService) {}
@Get()
root(): string {
return this.appService.root();
}
}
_
インターフェースの代わりに抽象クラスを使用したり、インターフェースと実装クラスの両方に同様の名前を付けたりすることもできます(その場でエイリアスを使用します)。
はい、C#/ Javaと比較すると、これは汚いハックのように見えるかもしれません。インターフェイスはデザイン時のみであることを覚えておいてください。私の例では、AppServiceMock
とAppService
は、インターフェースや抽象/基本クラスからも継承しておらず(もちろん、実際にはそうする必要があります)、メソッドを実装している限り、すべてが機能しますroot(): string
。
このトピックに関するNestJSドキュメントから引用:
通知
カスタムトークンの代わりに、ConfigServiceクラスを使用しているため、デフォルトの実装をオーバーライドしています。
実際に、抽象クラスであるインターフェースを使用できます。 TypeScript機能の1つは、クラス(JSの世界で維持されている)からインターフェースを推測するため、このようなものが機能します
IFoo.ts
export abstract class IFoo {
public abstract bar: string;
}
Foo.ts
export class Foo
extends IFoo
implement IFoo
{
public bar: string
constructor(init: Partial<IFoo>) {
Object.assign(this, init);
}
}
const appServiceProvider = {
provide: IFoo,
useClass: Foo,
};