Nestjs 한눈에 기본 정리

📌 Nestjs 기본구조

---

• ESLint, Prettier는 코드 컨벤션 규칙을 작성해 타 인원 간 협업할 때 코드 컨벤션을 만드는 곳.
• Decorator = 기능 추가 역할. (붙여써야함)
• Controller = 들어오는 요청 처리 및 응답값을 반환하는 역할. 애플리케이션에 대한 특정 요청 수신 목적.
• Request 객체(@Req()). Body 객체 (@Body()). Param 객체 (@Param()).
• Provider = 서비스, 리포지토리, 팩토리 등 Nest의 Class들은 대부분 공급자로 취급된다. 이에 공급자에게는 종속성 주입이 가능하다.(Dependency Injection)
• Controller (소비자)는 Service(공급자)를 Injection받아서 사용하는 것이다. (의존성주입패턴)
• constructor(private readonly appService: AppService) {}
• 각각의 Provider → Controller로 DI이 진행되고 → 이것이 다시 App.module.ts로 합쳐져서 main.ts에서 실행된다.

📌 캡슐화

---

• 객체의 속성과 Methods를 하나로 묶고 → 구현된 일부를 감추어 은닉함
• 모듈은 기본적으로 공급자를 캡슐화 한다. 때문에 Export한 모듈에 대해서만 사용이 가능하다.
• 캡슐화 된 모듈을 다른 모듈에서 사용할 때는 provider에 줄줄이 추가하지 말고, exports 해주고 → import 해와서 써라. (단일책임원칙)

📌 미들웨어 (nest g middleware <NAME>)

---

• Route Handler (Controller) 이전에 호출되는 함수.
• req, res, next로 구성됨. (Express와 동일)
• 미들웨어 만들기
• // nest g middleware <NAME> import { Injectable, NestMiddleware } from '@nestjs/common'; import { NextFunction, Request, Response } from 'express'; @Injectable() export class TestMiddleware implements NestMiddleware { use(req: Request, res: Response, next: NextFunction) { console.log("This is for test Middleware"); console.log(req.ip) next(); } }

📌 미들웨어 적용

---

• App.module.ts파일에서 아래처럼 적용함.
• apply(<적용할 미들웨어함수>)
• forRoutes(<적용경로>)

export class AppModule **implements NestModule{
  configure(consumer : MiddlewareConsumer) {
    consumer.apply(TestMiddleware).forRoutes("*")
  }
}**

📌 예외 처리 방법 (Exception Filter)

• Nest는 기본적으로 애플리케이션에서 처리되지 않은 예외 내용에 대하여 예외 레이어를 적용되어 예외처리가 자동적으로 진행된다. 즉, 별도의 처리없어도 알아서 처리하긴 한다. 다만 원하는 예외처리가 아님.
• 만약 에러가 날 때마다 원하는 폼의 Err를 리턴하고 싶다면 또는 에러에 대한 로거를 적용하고 싶다면Exception Filter를 통해 발생하는 에러에 대하여 처리를 해줄 수 있다.
• 기본적인 예외 발생 방법은 다음과 같다.

@Get()
  getHello(): string {
    throw new HttpException('Forbidden2', HttpStatus.FORBIDDEN);
  }

예외 Exception Filter 만들기

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();
    const error = exception.getResponse();

    // You Can Add Logger Hear;

    if (typeof error === 'string') {
        response.status(status).json({
            statusCode: status,
            timestamp: new Date().toISOString(),
            path: request.url,
            error: error
        })
    } else {
        response.status(status).json({
            statusCode: status,
            timestamp: new Date().toISOString(),
            path: request.url,
            ...error, // 비구조할당
        })
    }

  }
}

- 전체적용

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { HttpExceptionFilter } from './http-exception.filter';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalFilters(new HttpExceptionFilter());
  await app.listen(3000);
}
bootstrap();

 

 

 

📌 파이프

• 데이터 바인딩에 사용하는 파이프라인 Validation Check, Type변환의 역할을 해준다.

// Param에 파이프 적용방법
@Get(":id")
  getHello(@Param("id", **ParseIntPipe**) param): string {
    console.log(param);
    return this.appService.getHello();
  }

• DTO에 파이프적용방식은 주로 class-validator 를 이용해 진행한다.

// DTO Class 정의
import { IsNotEmpty, IsString, Matches, MaxLength, MinLength } from "class-validator";

export class SignInDto {
    @IsString()
    @IsNotEmpty()
    @MinLength(5)
    @MaxLength(50)
    @ApiProperty({ description : "Email" })
    email : string;

    @IsString()
    @IsNotEmpty()
    @Matches(/^[a-zA-Z0-9]*$/, {
        message : "Not Proper EOA"
    })
    @ApiProperty({ description : "EOA Public Key" })
    eoa : string;
}

// Controller 적용
@Post("/register")
registerUser(**@Body(ValidationPipe) registerUserDto : RegisterUserDto**) : Promise<User> {
    return this.userService.registerUser(registerUserDto);
}

 

📌 인터셉터

• @Injectable 데코레이터가 달린 클래스로 DI가 가능한 것인데, 각각의 모듈 (Users, Markets)을 횡단하면서 공통적으로 사용하는 함수. (Middleware와 상당히 유사하다)
• 기본적으로 요청수명주기(Request LifeCycle) 는 다음과 같다.
  • Request → Middleware → Guard → Intercepter (Pre) → Pipeline → Controller → Service → Intercepter (After) → Exception Filter → Response
• 위에서 살펴보면 Middleware와 Intercepter는 수명주기 상 적용되는 시기가 다르다. Intercepter는 Pre와 After 로 Controller 실행 이전 이후로 적용이 되는 반면 Middleware는 Controller 동작 전에만 적용.
• 인터셉터 만들기 (src/success.interceptor.ts)
• import { Injectable, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common'; import { Observable } from 'rxjs'; import { tap } from 'rxjs/operators'; @Injectable() export class SuccessInterceptor implements NestInterceptor { intercept(context: ExecutionContext, next: CallHandler): Observable<any> { console.log('Before...'); const now = Date.now(); return next .handle() .pipe( tap(() => console.log(`After... ${Date.now() - now}ms`)), ); } }
• 적용방법
  • 사용하면 Before… → param → After 순으로 콘솔에 뜨게 된다.
• @Get(":id") **@UseInterceptors(SuccessInterceptor)** getHello(@Param("id", ParseIntPipe) param): string { console.log(param); return this.appService.getHello(); }
• 어따쓰냐? → 에러의 일관성있는 출력을 위해 Exception Filter 에서 사용했다면, Response에 대한 일관성있는 리턴을 위해 Intercepter를 적용한다.

 

📌 Database Setting

• 환경변수설정

// Nestjs 자체 환경변수 핸들링 패키지 지원 아래 내용으로 설치하고, .env파일에 환경변수 처리
npm i @nestjs/config 

• DB 연결 설정

// MySQL을 사용할 것이므로 typeorm & mysql2 설치
npm i @nestjs/typeorm mysql2

// app.module.ts - imports부분에 아래 추가.
TypeOrmModule.forRoot({
  type : 'mysql',
  host : process.env.DATABASE_HOST,
  port : parseInt(process.env.DATABASE_PORT),
  username : process.env.DATABASE_USER,
  password : process.env.DATABASE_PASSWORD,
  database : process.env.DATABASE_DB,
  entities : [__dirname + "/entities/**/*.entity.{js,ts}"], // Entity 경로
  synchronize : true // DB 동기화
}),

- Entity 정의

import { BaseEntity, Column, Entity, CreateDateColumn, UpdateDateColumn, OneToMany, PrimaryGeneratedColumn } from "typeorm";

@Entity({ 
    name : "users" // DB에 생성될 Table 명 설정 가능
})
export class User extends BaseEntity {
    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    email : string;

    @Column()
		@Exclude() // Return 때, 반환하지 않는 필드로 옵션 추가함.
    password : string;

    @Column({ nullable : false, unique : true, default : () => 0 })
    role : number;

    @CreateDateColumn()
    createdAt: Date;

    @UpdateDateColumn()
    updatedAt: Date;
}

 

📌 DTO (Data Transfer Object)

• 계층 간 데이터 교환 객체로 Controller에 전달되는 데이터에 대하여 유효성 검사를 할 수 있음.
  • DTO 전역 설정 후 사용법

  // @ main.ts 파일에 Global Validation Pipe 사용을 설정할 수 있다. 
  // 매 컨트롤러에 적용도 가능하나 글로벌로 사용하면 보다 편하므로.
  async function bootstrap() {
    const app = await NestFactory.create(AppModule);
    // Global Exception Filter 에러 리턴 핸들링
    app.useGlobalFilters(new HttpExceptionFilter());
    **app.useGlobalPipes(new ValidationPipe());**
    // CORS 설정
    app.enableCors();
  
    // Swagger
    await app.listen(process.env.SERVER_PORT);
  }
  bootstrap();
  
  // controller
    @Get("/")
    **signUpUser(@Body() body : SignupUserDto) {**
        console.log(body);
        return ["hello", "apple"];
    }
  

  • DTO 개별 적용방법
    • 아래처럼 Body Decorator에 Validation Pipe를 넣어서 사용할 수도 있음.

  // 회원가입
  @Post("/register")
  registerUser(**@Body(ValidationPipe) registerUserDto : RegisterUserDto**) : Promise<User> {
      return this.userService.registerUser(registerUserDto);
  }
  

 

📌 PickType & OmitType

• PickType은 Class 정의 속성 중 원하는 것을 선택해 새로운 클래스를 생성한다. 즉 필요한걸 골라서 새로운 타입유형을 만든다.
• OmitType은 Class 속성 중 필요없는 타입을 제외하고 새로운 클래스를 생성한다. 즉 필요없는것만 빼고 새로운 타입유형을 만든다.
• 처음엔 그냥 Promise에 직접 리턴 타입 넣어서 해봤다. 근데 생각해보니 스웨거 때문에 또 정의해야되더라. 그러니 Promise에다가 타입정의하지말고.. DTO에다가 리턴 정의해 두고 쓰는것이 나을 것.

PickType Example

// Signup.dto.ts
...
import { User } from "src/entities/user.entity";

~~export class SignUpUserDto {}~~

// user entity 내용 중 **'id', 'email', 'role'**만 리턴하는 타입을 만들겠다면 ?
**export class SignUpUserReturn extends PickType(
    User, ['id', 'email', 'role']
) {}**

OmitType Example

// Signup.dto.ts
import { ApiProperty, **PickType**, **OmitType** } from "@nestjs/swagger";
import { User } from "src/entities/user.entity";

~~export class SignUpUserDto {}~~

// user entity 내용 중 Password만 뺴고 리턴하는 타입을 만들겠다면 ?
**export class SignUpUserReturn extends OmitType(
    User, ['password']
) {}**