Nest.js Middleware logger

🤳 Nest.js 미들웨어란?

---

미들웨어는 Route 핸들러 보다 먼저 호출되는 함수입니다. 미들 웨어 기능은 애플리케이션의 요청-응답 주기에서 요청 및 응답 객체 와 미들웨어 기능에 액세스할 수 있습니다. Next() 다음 작업으로 넘긴다는 의미입니다. 

Nest.js 미들웨어는 기본적으로 Express 미들웨어와 동일하다.  

• 미들웨어 기능은 다음 작업을 수행할 수 있습니다.
  • 모든 코드를 실행합니다. 
  • 요청 및 응답 객체를 변경합니다. 
  • 요청-응답 주기를 종료합니다. 
  • 스택에서 다음 미들웨어 함수를 호출합니다. 
  • 현재 미들웨어 기능이 요청-응답 주기를 종료하지 않으면 Next() 다음 미들웨어 기능으로 제어를 전달하도록 호출해야 한다. Next() 호출하지 않을경우 요청이 중단 됩니다. 

 

정리하면: 미들웨어는 클라이언트 사이드에서 요청한 Http Request에서 Router Handler로 가기 전에 기능을 공통화 하여 사용하거나 처리하게 할 수 있는데 그 이후 Next()라는 함수를 호출해서 다음 작업이 진행 될 수 있게 한다.

---

🤳 Nest.js 실습?

---

300x250

1. Root 디렉토리에서 middleware폴더를 생성하고 logger.middleware.ts 파일을 생성한다.

2. logger.middleware.ts에 logger 구현 

• 미들웨어는 router보다 먼저 실행이 된다. 
• 라우터 시작할때 요청을 기록하고, next()로 라우터로 연결을하고 끝나고 실행하기 위해서 res.on을 사용했다.
• Next() 다음으로 넘어가기전에 console.log 요청 데이터에 값을을 설정했다.

import { Injectable, Logger, NestMiddleware } from "@nestjs/common";
import { NextFunction, Request, Response } from "express";

@Injectable()
export class LoggerMiddleware implements NestMiddleware{
    private logger = new Logger('HTTP');

    use(req: Request, res: Response, next: NextFunction): void{
        const { ip, method, originalUrl } = req;
        const userAgent = req.get('user-agent') || '';

        console.log({
            ip: ip,
            url : req.url,
            method : req.method,
            body: req.body,
        })
        res.on('finish', () => { 
            const { statusCode } = res;
            const contentLength = res.get('content-length');
            this.logger.log(
                `${method} ${originalUrl} ${statusCode} ${contentLength} - ${userAgent} ${ip}`,
            );
        });
        next();
    }
}

3. logger 연결하기 /src/app.module.ts 

• app.module.ts 하단에 logger 연결한다.
• path: 와일드 카드로 모든 path 경로에 middleware 설정했다.
• method: 모든 요청 method를 middleware 설정했다.

export class AppModule implements NestModule{
  configure(consumer: MiddlewareConsumer) {
    consumer
    .apply(LoggerMiddleware)
    .forRoutes({ 
      path : '*', 
      method: RequestMethod.ALL
    })
  }
}

---

🤳 Implements, Injectable를 알아보자

---

logger 셋팅하면서 implements를 사용한 이유는?

굳이 사용하지 않아도 에러는 없다!

하지만 사용하면 내부 로직을 반드시 구현해야 하도록 강제하며 함수 이름, 매개변수, 리턴 값 등의 타입 검사를 해준다.

ex) configrue라는 오타 발생시 implements를 붙이지 않았다면 에러를 발생시키지 않지만 붙였다면 에러를 발생시키기 때문에 쉽게 고칠 수 있다.

implements : 부모의 클래스에서 상속을 내려주는 역활이지만 이것은 더 공부를 해봐야겠다.

---

Nest.JS에서 injectable이란?

@Injectable() //nest.js 데코레이터.

injectable 데코레이터를 사용하고 있으면 provider라는 형태를 띄는데 그러게 되면 해당 module에서 providers에 넣어줘야한다.

그러므로, nest.JS dependency injection는 providers를 보고 controller에 service들을 넣어줍니다.