Skip to content

Latest commit

 

History

History
137 lines (107 loc) · 3.24 KB

readme_kr.md

File metadata and controls

137 lines (107 loc) · 3.24 KB
Raw

Logo

@toss/nestjs-aop · npm version

NestJS에 우아하게 AOP를 적용하는 방법
NestJS 관리 인스턴스를 모든 데코레이터에서 우아하게 사용하세요


목차
  1. 설치 방법
  2. 사용 예시
  3. 참고자료
  4. 기여하기
  5. 라이센스

설치 방법

npm install @toss/nestjs-aop
pnpm add @toss/nestjs-aop
yarn add @toss/nestjs-aop

사용 예시

1. AopModule Import 하기

@Module({
  imports: [
    // ...
    AopModule,
  ],
})
export class AppModule {}

2. LazyDecorator를 위한 심볼 생성

export const CACHE_DECORATOR = Symbol('CACHE_DECORATOR');

3. NestJS 프로바이더로 LazyDecorator 구현하기

metadata는 createDecorator의 두 번째 매개변수입니다.

@Aspect(CACHE_DECORATOR)
export class CacheDecorator implements LazyDecorator<any, CacheOptions> {
  constructor(private readonly cache: Cache) {}

  wrap({ method, metadata: options }: WrapParams<any, CacheOptions>) {
    return (...args: any) => {
      let cachedValue = this.cache.get(...args);
      if (!cachedValue) { 
        cachedValue = method(...args);
        this.cache.set(cachedValue, ...args);
      }
      return cachedValue;
    };
  }
}

4. 모듈의 프로바이더에 LazyDecoratorImpl 추가하기

@Module({
  providers: [CacheDecorator],
})
export class CacheModule {}

5. LazyDecorator의 metadata를 나타내는 데코레이터 생성

options는 wrap 메소드에서 얻을 수 있으며 사용될 수 있습니다.

export const Cache = (options: CacheOptions) => createDecorator(CACHE_DECORATOR, options)

6. 사용하기!

export class SomeService {
  @Cache({
    // ...options(metadata value)
  })
  some() {
    // ...
  }
}

참고자료

기여하기

이 프로젝트에는 모든 분들의 기여를 환영합니다. 자세한 기여 가이드는 CONTRIBUTING.md를 참고하세요.

라이센스

MIT © Viva Republica, Inc. LICENSE 파일을 참고하세요.

Toss