NestJS Pipes

Pipe

• 파이프는 @Injectable () 데코레이터로 주석이 달린 클래스
• data transformation과 data validation을 위해서 사용
• 파이프는 컨트롤러 경로 처리기에 의해 처리되는 인수에 대해 작동

Nest는 메소드가 호출되기 직전에 파이프를 삽입하고 파이프는 메소드로 향하는 인수를 수신하고 이에 대해 작동합니다.

Data Transformation

입력 데이터를 원하는 형식으로 변환 (예 : 문자열에서 정수로)
숫자를 받길 원하는데 문자열 형식으로 온다면 파이프에서 자동으로 숫자로 바꿔준다.
String to Integer EX) string '7' => Integer 7

Data validation

입력 데이터를 평가하고 유효한 경우 변경되지 않은 상태로 전달하면 된다. 그렇지 않으면 데이터가 올바르지 않아 예외를 발생시킵니다.
만약 이름의 길이가 10자 이하여야 하는데 10자 이상 되면 에러를 발생

PIPE 사용하는 법(Binding Pipes)

파이프를 사용하는 방법(Binding pipes)은 세가지로 나눠질수 있다.

1. Handler-level Pipes

핸들러 레벨에서 @UsePipes() 데코레이터를 이용한다.
이 파이프는 모든 파라미터에 적용된다. (title, description)

2. Parameter-level Pipes

파라미터 레벨의 파이프 이기에 특정한 파라미터에게만 적용이 되는 파이프

3. Global-level Pipes

글로벌 파이프로서 애플리케이션 레벨의 파이브
클라이언트에서 들어오는 모든 요청에 적용
가장 상단 영역인 main.ts에 작성

Built-in Pipes

Nest JS 에 기본적으로 사용할 수 있게 만들어 놓은 6가지의 파이프가 있다.

• ValidationPipe
• ParseIntPipe
• ParseBoolPipe
• ParseArrayPipe
• ParseUUIDPipe
• DefaultValuePipe

파이프를 이용한 유효성 체크

모듈 설치

class-validator , class-transformer
npm install class-validator class-transformer --save

-참조 ⬇⬇
Documentation 페이지

파이프 생성하기

현재는 게시물을 생성할 때 이름과 설명에 아무런 값을 주지 않아도 아무 문제 없이 생성이 된다.=> 파이프로 수정
<create-board.dto.ts>

import { IsNotEmpty } from "class-validator";

export class createBoardDto{
    @IsNotEmpty() // null 불허
    title: string;

    @IsNotEmpty()
    description: string;
}

<controller.ts>

@Post()
    @UsePipes(ValidationPipe) //유효성 체크
    createBoard(
        @Body() createBoardDto: createBoardDto
    ): Board { //return 값의 타입은 Board, Board[]로 주면 안됨 : service의 createBoard의 return 값이 board 하나이기 때문에
        return this.boardsService.createBoard(createBoardDto);
    }

<결과>

에러가 나온다!

특정 게시물을 찾을 때 없는 경우 결과 값 처리

현재 특정 게시물을 ID로 가져올 때 만약 없는 아이디의 게시물을 가져오려고 한다면 결과값으로 아무 내용이 없이 돌아온다.
=> 가져오려는 내용이 없다는 결과를 클라이언트로 보내준다.
<service.ts> 기존의 getBoardId를 수정

 getBoardId(id: string): Board{ //게시물 하나를 return 하기 때문에 Board[] X
        const found = this.boards.find((board)=>board.id === id);

        if(!found){
            throw new NotFoundException(`Can't find Board with id ${id}`);
        }
        return found;
    }

<결과>

없는 게시물을 지우려 할 때 결과 값 처리

<service.ts>의 deleteBoard를 수정

deleteBoard(id: string): void{ // return 을 따로 주지 않아도 되기 때문에 void
       const found = this.getBoardId(id);
       this.boards = this.boards.filter((board) => board.id !==found.id);
   }

커스텀 파이프를 이용한 유효성 체크

지금까지는 NestJS에서 이미 구성해놓은 built-in 파이프를 사용해보았다.
따로 생성해서 사용할 수 있는 CUSTOM PIPE를 만들어보자!

커스텀 파이프 구현 방법

**PipeTransform이란 인터페이스**를 새롭게 만들 커스텀 파이프에 구현해줘야 한다. 
이 PipeTransform 인터페이스는 모든 파이프에서 구현해줘야 하는 인터페이스이다. 
그리고 이것과 함께 모든 파이프는 **transform()** 메소드가 필요하다. 이 메소드는 NestJS가  인자(arguments)를 처리하기 위해서 사용된다.

<board-status-validation.pipe.ts>

import { ArgumentMetadata, PipeTransform } from "@nestjs/common";

export class BoardStatusValidationPipe implements PipeTransform{
    transform(value: any, metadata: ArgumentMetadata) {
        console.log('value',value)
        console.log('metadata',metadata)
        
        return value;
    }
}

transform() 메소드

두개의 파라미터를 가지는 메소드
첫번째 파라미터는 처리가 된 인자의 값(value)이며,
두번째 파라미터는 인자에 대한 메타 데이터를 포함한 객체이다.

transform()메소드에서 Return 된 값은 Route 핸들러로 전해진다.
만약 예외(Exception)가 발생하면 클라이언트에 바로 전해진다.

실제로 value 와 metadata값 콘솔로 찍어보기

1. 커스텀 파이프 생성
2. 게시물에 업데이트하는 핸들러에 커스텀 파이프 넣어주기
3. 포스트 맨으로 요청 보내기

<controller.ts>의 :id/status 부분 수정
status 를 바꿀 때 유효성 체크(status 값만!)

@Patch('/:id/status')
    updateBoardStatus(
        @Param('id') id: string,
        @Body('status', BoardStatusValidationPipe) status: BoardStatus,
    ): Board {
        return this.boardsService.updateBoardStatus(id, status);
    }

<postman 호출 시>

<terminal 콘솔>

커스텀 파이프로 실제 기능 구현하기

구현 할 기능 : 상태(Status)는 PUBLIC과 PRIVATE만 올 수 있기 때문에 이외의 값이 오면 에러 전송
<board-status-validation.pipe.ts>

import { ArgumentMetadata, BadRequestException, PipeTransform } from "@nestjs/common";
import { BoardStatus } from "../board.model";

export class BoardStatusValidationPipe implements PipeTransform{
    //readonly : 클래스 외부에서 접근은 가능하지만 변경은 불가!
    readonly StatusOptions =[
        BoardStatus.PRIVATE,
        BoardStatus.PUBLIC
    ]

    transform(value: any) { // value : 사용자가 입력한 status
        value = value.toUpperCase(); //대문자 변환

        if(!this.isStatusValid(value)){
            throw new BadRequestException(`${value} isn'i in the status`)
        }
        
        return value;
    }

    private isStatusValid(status: any){
        const index = this.StatusOptions.indexOf(status); //배열안에 있는지, 있으면 그 배열내 인덱스값
        return index !== -1;
    }
}

<결과1>

<결과2>

PostgresSQL 설치하기

애플리케이션에 데이터베이스를 연결해서 데이터베이스에 보관, 데이터베이스는 Postgres를 사용

<설치 목록>
1. PostgresSQL
2. pgAdmin (데이터베이스를 보는 툴(Tool)입니다.)

pgAdmin 실행
1. Servers > register Server


2. BoardProject 우클릭 > Create > database

TypeORM (Object Relational Mapping)소개

TypeORM

TypeORM은 node.js에서 실행되고 TypeScript로 작성된 객체 관계형 매퍼 라이브러리

TypeORM은 MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, SAP Hana 및 WebSQL과 같은 여러 데이터베이스를 지원한다.

ORM (Object Relational Mapping) 이란?

객체와 관계형 데이터베이스의 데이터를 자동으로 변형 및 연결하는 작업

ORM을 이용한 개발은 객체와 데이터베이스의 변형에 유연하게 사용할 수 있다.

TypeORM vs Pure Javascript

const boards = Board.find({ title: 'Hello' , status: 'PUBLIC' });

db.query('SELECT * FROM boards WHERE title = "Hello" AND status = "PUBLIC" , (err, result) => {
       if(err) { 
          throw new Error('Error')
      }
      boards = result.rows;
})

TypeORM 특징과 이점

• 모델을 기반으로 데이터베이스 테이블 체계를 자동으로 생성
• 데이터베이스에서 개체를 쉽게 삽입, 업데이트 및 삭제할 수 있다.
• 테이블 간의 매핑 (일대일, 일대 다 및 다 대다)을 만든다.
• 간단한 CLI 명령을 제공
• TypeORM은 간단한 코딩으로 ORM 프레임 워크를 사용하기 쉽다.
• TypeORM은 다른 모듈과 쉽게 통합된다.

TypeORM 애플리케이션에서 이용하기

TypeORM을 사용하기 위해서 설치해야하는 모듈들

@nestjs/typeorm

• NestJS에서 TypeOrm을 사용하기 위해 연동시켜주는 모듈

typeorm

• TypeORM 모듈

pg

• Postgres 모듈

npm install pg typeorm @nestjs/typeorm --save 

database DOC

TypeORM 애플리케이션에 연결하기

<typeorm.config.ts>

import { TypeOrmModuleOptions } from "@nestjs/typeorm";

export const typeORMConfig : TypeOrmModuleOptions = {
    //Database Type
    type: 'postgres',
    host: 'localhost',
    port: 5432,
    username:'postgres',
    password: '0121',
    database: 'board-app',
    //엔티티는 하나씩 넣을 수도 있지만 이렇게 다 포함하게 할 수 있다. 
    entities: [__dirname+'/../**/*.entity.{js,ts}'],
    synchronize: true 

}

• synchronize: true 일때 : 애플리케이션을 다시 실행할 때 엔티티안에서 수정된 컬럼의 길이 타입 변경 값등을 해당 테이블을 Drop 후 다시 생성해줌

<app.module.ts> -typeOrm 사용 설정

import { Module } from '@nestjs/common';

import { BoardsModule } from './boards/boards.module';
import { TypeOrmModule } from '@nestjs/typeorm';
import { typeORMConfig } from './configs/typeorm.config';

@Module({
  imports: [
    TypeOrmModule.forRoot(typeORMConfig),
    BoardsModule],

})
export class AppModule {}

• forRoot안에 넣어준 설정(configuration)은 모든 Sub-Module 부수적인 모듈들에 다 적용이 된다.

게시물을 위한 엔티티(Entity) 생성하기

왜 Entity를 생성해야하나?

원래 ORM 없이 데이터베이스 테이블을 생성할 때는 아래와 같다.

CREATE TABLE board ( 
   id     INTEGER AUTO_INCREMENT PRIMARY KEY. 
   title  VARCHAR(255)  NOT NULL,
   decsription VARCHAR(255) NOT NULL  
)

하지만 TypeORM을 사용할 때는 Class를 사용해서 데이터베이스 테이블로 변환시켜주기 때문에 클래스를 생성한 후 그 안에 컬럼들을 정의해주면 된다.

엔티티 생성 코드

<board.entity.ts>

@Entity()

Entity () 데코레이터 클래스는 Board 클래스가 엔티티임을 나타내는 데 사용 (sql 문의 CREATE TABLE board 부분)

@PrimaryGeneratedColumn()

PrimaryGeneratedColumn () 데코레이터 클래스는 id 열이 Board 엔터티의 기본 키 열임을 나타내는 데 사용

@Column()

Column () 데코레이터 클래스는 Board 엔터티의 title 및 description과 같은 다른 열을 나타내는 데 사용

Repository 생성하기

Repository

리포지토리는 엔터티 개체와 함께 작동하며 엔티티 찾기, 삽입, 업데이트, 삭제 등을 처리
Repository란?

데이터베이스에 관련 된 일(INSERT, FIND, DELETE..등등)은 서비스에서 하는게 아닌 Repository에서 해주면 된다.
이것을 Repository Pattern 이라고도 한다.

Repository 생성하기

1. 리포지토리 파일 생성하기
   

2. 생성한 파일에 리포지토리를 위한 클래스 생성하기 (BoardRepository)
   <board.repository.ts>

import { EntityRepository, Repository } from "typeorm";
import { Board } from "./board.entity";

@EntityRepository(Board)
export class BoardRepository extends Repository<Board>{
    
}

• 생성 시 Repository 클래스를 Extends 해줍니다. (Find, Insert, Delete 등 엔티티를 컨트롤 해줄 수 있습니다.)

@EntityRepository()

• 클래스를 사용자 정의(CUSTOM) 저장소로 선언하는 데 사용
  사용자 지정 저장소는 일부 특정 엔터티를 관리하거나 일반 저장소 일 수 있다.

3. 생성한 Repository를 다른곳에서도 사용할 수 있기 위해서(Injectable) board.module에서 import 해준다.
   < board.module.ts>

import { Module } from '@nestjs/common';
import { BoardsController } from './boards.controller';
import { BoardsService } from './boards.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { BoardRepository } from './board.repository';

@Module({
  imports:[TypeOrmModule.forFeature([BoardRepository])],
  controllers: [BoardsController],
  providers: [BoardsService]
})
export class BoardsModule {}