0018.1 Nest.js 🐱

• 0018 Javascript ☕️
• 노마드 코더 nest.js
  • 노마드 코더 typescript
• NestJS로 배우는 백엔드 프로그래밍
• 공식문서
• nestjs and postgresql - CRUD tutorial

Related Topics

• oauth2 {nest.js} {passport}
• 0018.3 jest testing framework for Node.js
• Decorator - {nestjs}
• 0018.1.1 NestJS Troubleshooting
• (TODO) RxJS
• 0018.4 TypeORM 💾
• (TODO) Model-View-Controller 를 사용한 풀스택 서버 만들기 {nest.js}
• (TODO) Pagination in {Nest.js}
• (TODO) Domain Driven Hexagon with {nest.js}

Help Centre

• NestJS가 RDS에 연결할 수 없어요.help
• NestJS 단위테스트 작성 도중 레포지토리 모킹 관련한 문제

Packages

• multer 이미지 업로드 모듈.nest.node feat.mutipart-form-data

Overview

• NestJS 설치법:
  • npm i -g @nestjs/cli
  • nest new project-name
  • nest start
• 핵심 파일 구조
  • app.controller.ts: 컨트롤러는 라우터임
  • app.controller.spec.ts: spec이라는 이름은 유닛테스트를 의미함.
  • app.serivce.ts: 서비스는 컨트롤러에 의해 호출되는 다양한 콜백들을 담아놓는 파일
  • app.module.ts: 프로젝트 메타데이터를 저장하는 곳
  • main.ts: 엔트리파일, app 생성함
• 빠르게 컴파일하고 실행시키려면... npm run start -- -b swc
• hot reloading을 자체적으로 지원한다 : npm run start:dev
• CRUD 가능한 모듈 (controller, module, service, dto, entity)을 만드는 명령어는 nest g res <resource-name>, 다음 세 명령어를 일괄적으로 수행하는듯.
  • nest g controller
  • nest g service
  • nest g module

Controllers

• request & response를 처리하는 레이어.
• 새 컨트롤러를 만드는 명령어는 nest g controller <name>이다.
• 클래스 어노테이션으로 @Controller(<path>)가 달려있다.
• 메서드들이 각각의 엔드포인트로 작용하기 위해선 @GET([subpath])와 같은 HTTP 메서드 이름의 어노테이션을 달아야 한다.
• 성공적으로 응답을 반환해야할 때 기본값은 200이고, POST일 경우 201이다. 이를 오버라이드하기 위해선 @HttpCode(<number>) 어노테이션을 사용해야 한다.
  • 에러 status를 반환할 경우 예외를 throw하라던데?
  • 아무 status나 반환하고 싶을땐 express의 코드를 사용하라고..

• Request Object

  • Path 인자는 @Get(:id) 어노테이션으로 정의하고 파싱된 인자는 메서드 인자로 들어온다.

  @Get(':id')
  fineOne(@Param() params: any): string {
  	return param.id + 'cat';
  }
  

  • request 세부사항을 알기 위해선 메서드 파라메터 앞에 @Req() 데코레이터를 붙이라고!

  import { Request } from 'express';
  @Get()
  fineOne(@Req() request: Request): string {
  	return request.body;
  }
  

• 이렇게 메서드 파라메터로 넣을 수 있는 데코레이터들로는 @Res, @Next, @Session, @Param, @Body, @Query, @Headers 등이 있고 다음 링크를 참고하시오.

@Param

동적으로 처리할 수 있는 Path인자. /cat/1에서의 1과 같은 요청을 처리하는데 사용할 수 있다. 매개 변수가 있는 경로는 정적 경로 뒤에 선언되어야 합니다. 이것은 매개 변수화된 경로가 정적 경로로 향하는 트래픽을 가로채는 것을 방지합니다.

@Query

? 이후에 나오고 &로 분리된 인자들을 의미. key=value 쌍으로 이루어져 있다.

• 예시: /cat?key1=value1&key2=value2
• deferred response를 리턴해도 된다고. Promise 타입 객체를 리턴하게 되면 #RxJS의 observable stream으로 리턴이 되고, 스트림이 끝날경우 해당 소스에 알림이 간다고는 하는데 뭔 소린지 잘 모르겠음.

• Request Payloads
  • DTO, Data Transfer Object라고 불리우는, 네트워크 전송을 위해 존재하는 객체타입은 클래스로 정의가 되어있다고. DTO 클래스 멤버들은 직렬화 가능한 타입만 들어올 수 있나?
  • express.js에서 POST요청에 대한 요청의 body를 뜯어 원하는 키값들을 직접 획득했다면, Nest.js는 DTO 객체를 인자로 받아와 곧바로 사용할 수 있다.
  • @Post() create(@Body() createCatDto: CreateCatDto) {...}
• app.module.ts 파일에 내가 정의한 컨트롤러들을 @Module() 데코레이터 안에 넣을 수 있다.

Providers

의존성 주입될 수 있는 다양한 클래스들이다. 대표적으로 Service, Repository, Factory, Helper, Middleware가 있다. 컨트롤러가 처리할 수 없는 복잡한 작업을 Provider들에게 넘겨주는 예시를 보여주고 있다.

Inversion of Control

https://en.wikipedia.org/wiki/Inversion_of_control

원래는 유저가 라이브러리 코드를 호출하지만 라이브러리 코드가 인터페이스를 기준으로 유저 코드를 호출할 수 있게 만드는 패턴을 IoC라고 부른다.

Dependency Injection이라고, 생성자 타임에 의존성 Provider를 주입하는 과정을 의미. 아래의 코드의 Provider인 CatsService는 @Injectable 데코레이터를 달고있기 때문에 컨트롤러의 생성타임에 주입될 수 있다.

// interfaces/cats.interface.ts
export interface Cat {
	name: string;
	age: number;
	breed: string;
}

// cats/cats.service.ts
@Injectable()
export class CatsService {
	private readonly cats: Cat[] = [];
	create(cat: Cat) {
		this.cats.push(cat);
	}
	findall(): Cat[] {
		return this.cats
	}
}

// cats/cats.controller.ts
@Controller('cats')
export class CatsController {
	/**
	 * 자동으로 주입되는 CatsService
	 */
	constructor(private catsService: CatsService) {}

	@Post()
	async create(@Body() createCatDto: CreateCatDto) {
		this.catsService.create(createCatDto)
	}

	@Get()
	async findAll(): Promise<Cat[]> {
		return this.catsService.findAll();
	}
}

생성자에 의존성을 넣고싶지 않다면 Property-based injection을 참고.

Modules

각각의 도메인들 (users, cats, posts, comments, ...)은 각각의 app으로 관리된다. 이때 app의 메타데이터를 저장하는 코드들의 집합을 모듈이라고 부른다. nest g module <module-name> CLI 명령어로 새 모듈 생성이 가능하다. 그리고 루트모듈에 import를 해야한다.

exports 속성으로 모듈 내 provider를 다른 모듈에서도 사용할 수 있게 만든다.

@Module({
	controllers: [CatsController],
	providers: [CatsService],
	exports: [CatsService]
})
export class CatsModule {}

@Global 어노테이션 달면 providers를 다른 모든 모듈에서 사용할 수 있다.

• 0018.1.1 NestJS Troubleshooting#DI 컨테이너의 스코프 분리 문제

Middleware

express.js의 미들웨어의 스킴을 고스란히 따라가고 있다. 단순 함수를 사용하여 next() 를 사용, 다음 미들웨어로 요청을 전달할 수도 있으며, NestMiddleware 인터페이스를 구현한 클래스를 사용하여 컨트롤러에 의존성 주입을 할 수도 있다.

// logger.middleware.ts
@Injectable()
export class LoggerMiddleware implements NestMiddleware {
	use(req: Request, res: Response, next: NextFunction) {
		console.log('reqest...');
		next();
	}
}

// app.module.ts
@Module({
	imports: [CatsModule],
})
export class AppModule implements NestModule {
	configure(consumer: MiddlewareConsumer) {
		consumer
			.apply(LoogerMiddleware)
			.forRoutes('cats');
	}
}

consumer.forRoutes 의 인자로 좀 더 구체적인 path, method, 심지어는 controller를 설정할 수도 있다.

Exception Filters (이해부족)

Nest에는 애플리케이션 전체에서 처리되지 않은 모든 예외를 처리하는 예외 계층이 내장되어 있습니다. 예외가 애플리케이션 코드에서 처리되지 않으면 이 계층에서 예외를 포착하여 적절한 사용자 친화적인 응답을 자동으로 전송합니다.

import { ExceptionFilter, Catch, ArgumentsHost, HttpException } from '@nestjs/common';
import { Request, Response } from 'express';

@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const ctx = host.switchToHttp();
    const response = ctx.getResponse<Response>();
    const request = ctx.getRequest<Request>();
    const status = exception.getStatus();

    response
      .status(status)
      .json({
        statusCode: status,
        timestamp: new Date().toISOString(),
        path: request.url,
      });
  }
}

• getRequest<Request>와 getResponse<Response>를 사용, 예외 안에서도 요청과 응답 객체의 참조를 얻어올 수 있다.

• exception은 현재 처리중인 예외객체

• host는 ArgumentHost객체로, 아직 잘 모르것다

  • HTTP 예외 뿐만 아니라 다양한 예외 (MSA, WebSocket)에 대응하기 위해 ArgumentHost를 사용한다는 점만큼은 알고 넘어가자

• 필터 연결법: 컨트롤러 (혹은 메서드)(혹은 bootstrap 안에)의 어노테이션으로 @UseFilters()를 추가한다.

@Post()
@UseFilters(HttpExceptionFilter)
async create(@Body() createCatDto: CreateCatDto) {
	throw new ForbiddenException();
}

Pipes

파이프는 컨트롤러가 라우팅을 하기 전 두 가지 역할을 수행한다.

1. 데이터 변환 (예시. string ⟶ number)
2. 데이터 검증

모든 PipeTransform 인터페이스를 구현하고 @Injectable() 어노테이션을 갖고있는 클래스는 Pipe이다.

path variable을 원하는 타입으로 파싱해야할 경우, 예를 들어 인자에 들어올 @Param에 ParseXXXPipe를 넣어주면 된다.

@Get(':id')
async findOne(@Param('id', ParseIntPipe) id: number) {
	return this.catsService.findOne(id);
}

path variable만 되냐? query parameter도 된다!

@Get()
async findOne(@Query('id'), ParseIntPipe) id: number) {
	...
}

파싱에 실패한 경우 (예를 들어 GET cats/hello가 들어온 경우) 예외를 던진다. 그 예외는 위에서 설명한 Exception Filter에서 처리되어 에러 메시지를 응답하게 된다.

• [?] 그래도 메서드 선언 순서가 문제가 될 것 같은데? @Get('cat/:id')와 @Get('cat/breed') 이 순서로 라우팅을 처리해버리면 전부 첫번째 컨트롤러로 들어갈 것이고 예외가 발생할 것이다.

  // not ok
  @Get(':id')
  findOne(@Param('id', ParseIntPipe) id: number): string {
    return `meowingtone #${id}`;
  }
  
  @Get('breed')
  findBreed(): string {
    return 'you requested breed!';
  }
  

  // ok
  @Get('breed')
  findBreed(): string {
    return 'you requested breed!';
  }
  
  @Get(':id')
  findOne(@Param('id', ParseIntPipe) id: number): string {
    return `meowingtone #${id}`;
  }
  

만약에 파이프를 통해서 변환해야 하는 타입이 기본타입이 아니라면? => DTO Validation을 사용하면 된다. DTO Validation using class-validator {NestJS}

Guards

guard는 @Injectable 어노테이션을 가지고 CanActivate 인터페이스를 구현한 클래스를 의미한다.

guards는 express.js 미들웨어의 단점인 next가 누구인지 모른다는 특징을 ExecutionContext 인스턴스를 통해 극복할 수 있다고.

가장 대표적인 사용사례는 역시 사용자 인가이다. nestjs.com/security/authentication 사용자 인가에 대한 로직을 만들어 전역적으로 or 컨트롤러 or 메서드 스코프에서 동작하도록 만들 수 있게 되었다.

ExecutionContext 객체는 ArgumentHost를 상속했기 때문에 request객체와 response 객체를 받아올 수 있다.

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Observable } from 'rxjs';

@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {
    const request = context.switchToHttp().getRequest();
	/**
	 * ExecutionContext에서 request 정보를 가져올 수 있다. 
	 * 헤더에 담긴 토큰을 validate할 수도 있다. 결과는 동기적으로
	 * (Promise), 혹은 비동기적으로 (Observable), 혹은 그 즉시
	 * (boolean) 리턴할 수 있다.
	 */
    return validateRequest(request);
  }
}

User Role에 따라서 다른 결과를 보여줄 수도 있다. admin 유저만이 접속할 수 있는 관리페이지에 대해서 커스텀 메타데이터를 생성하여 유저의 역할을 거를 수도 있다. Role-based authentication

Interceptors

NestInterceptor 인터페이스를 구현하고 @Injectable 한 클래스를 인터셉터라고 부름. ExecutionContext(줄기차게 봤던거) + CallHandler(handle을 사용하여 다음 컨트롤러 핸들러를 간접 호출(RxJS를 사용한댄다))를 통하여 intercept() 메서드를 구현하면 된다.

CallHandler를 아예 감싼 걸 보면 request ~ response 로직보다 스코프가 넓다는 것을 알 수 있다.

import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
import { Observable } from 'rxjs';
import { tap } from 'rxjs/operators';

@Injectable()
export class LoggingInterceptor implements NestInterceptor {
  intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
    console.log('Before...');

    const now = Date.now();
    return next
      .handle() /** 
			     * handle을 호출하는 것으로 request-response 
				 * handler가 실행된다. 핸들러가 뭘 스트림에 넣는지는
				 * 잘 모르겠다.
				 */
      .pipe(
		/**
		 * `tap`은 observable stream이 정상적으로 (예외도 포함) 
		 * 종료됐을때 반응한다. 
		 */
        tap(() => console.log(`After... ${Date.now() - now}ms`)),
      );
  }
}

• Binding Interceptors with @UseInterceptors(LoggingInterceptor) for controller class & method
  • 전역적으로 인터셉터를 등록하려면 useGlobalInterceptors()를 부트스트랩 단계에 넣어주자.
• Response Mapping
  • handle()이 #RxJS의 Observable 객체라는 사실을 알았으니 이 스트림으로부터 무언가를 map할 수도 있다. 완전 함수형인데?
  • RxJS를 좀 배워야 이해가 될 듯 한데, 이번 프로젝트에서는 쓸지 모르겠다.

Transformer

Dto에서 주로 쓰이는 Transformer는 Validator와 협업하여 리퀘스트를 정의된 VO로 deserialize하기 위해 필요하다. 0018.5 Validators

Outdated

• 2023-11-13 {nest.js} {postgresql}