NestJS에서 데코레이터와 미들웨어를 만들고 사용하는 방법

데코레이터와 미들웨어는 NestJS의 핵심입니다. 접근 방식에 따라 삶을 놀라울 정도로 쉽게 만들 수도 있고 약간 부담스럽게 만들 수도 있는 도구입니다.

오늘은 사용자 인증을 위한 사용자 지정 데코레이터와 미들웨어를 만드는 과정을 간단하고 간단하게 살펴보겠습니다. 커피를 마시고 뛰어들어 보세요!

1. 인터페이스

먼저 사용자 개체에 대한 인터페이스를 정의해 보겠습니다.

이렇게 하면 형식 안전성이 보장되고 IDE가 행복하게 유지됩니다(행복한 IDE를 좋아하지 않는 사람이 있을까요?).

export interface IUser {
  id: string;
  name: string;
  primaryEmail: string;
  phoneNumber: string | null;
  countryCode: string | null;
  dob: Date | null;
  createdAt: Date;
  updatedAt?: Date;
  deletedAt?: Date | null;
}

---

2. 맞춤 데코레이터 만들기

맞춤 데코레이터는 NestJS 애플리케이션의 멋진 아이들과 같습니다.

여기에서는 요청 개체에서 사용자 메타데이터를 가져오는 항목을 만들고 있습니다.

import { createParamDecorator, ExecutionContext } from '@nestjs/common';
import { IUser } from '../interface/user.interface';

export const UserMetadata = createParamDecorator(
  (_data: unknown, ctx: ExecutionContext) => {
    const request = ctx.switchToHttp().getRequest();
    return request.user as IUser;
  },
);

그렇습니다! 이제 이 데코레이터를 사용하여 컨트롤러 메소드에서 직접 사용자 정보를 가져올 수 있습니다.

3. 인증 미들웨어 생성

이제 가상 경비원처럼 엔드포인트를 보호하기 위해 AuthGuard를 만들어 보겠습니다.

import {
  CanActivate,
  ExecutionContext,
  ForbiddenException,
  Injectable
} from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { verify } from 'jsonwebtoken';
import { Observable } from 'rxjs';
import { IS_PUBLIC_KEY } from '../constant/core';
import { IUser } from '../interface/user.interface';

@Injectable()
export class AuthGuard implements CanActivate {
  constructor(
    private reflector: Reflector,
  ) { }

  canActivate(
    context: ExecutionContext,
  ): boolean | Promise<boolean> | Observable<boolean> {
    const isPublic = this.reflector.getAllAndOverride<boolean>(IS_PUBLIC_KEY, [
      context.getHandler(),
      context.getClass(),
    ]);
    if (isPublic) {
      return true;
    }

    const request = context.switchToHttp().getRequest();
    const headers = request.headers;

    const token = (headers['authorization'] || '').split(' ')[1];
    if (!token) {
      throw new ForbiddenException('Not Authenticated');
    }

    const jwtOpts = {
      expiresIn: '1h', // Replace with env vars in real use
      audience: 'your-audience',
      algorithm: 'HS256',
      issuer: 'your-issuer',
    };

    try {
      const decoded = verify(token, "my-jwt-secret-token", {
        audience: jwtOpts.audience,
        issuer: jwtOpts.issuer,
      }) as { user: IUser };

      request.user = decoded.user;
      return true;
    } catch (err) {
      throw new ForbiddenException('Session Expired or Invalid');
    }
  }
}
</boolean></boolean></boolean>

4. 공개 및 내부 경로에 대한 메타데이터 추가

일부 경로는 공개(예: 로그인)여야 하고 일부 경로는 내부일 수 있습니다.

이를 위해 두 개의 간단한 데코레이터를 추가해 보겠습니다.

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

export const IS_PUBLIC_KEY = 'isPublic';
export const IS_INTERNAL = 'isInternal';

export const Public = () => SetMetadata(IS_PUBLIC_KEY, true);
export const Internal = () => SetMetadata(IS_INTERNAL, true);

---

5. 컨트롤러에서 사용하기

마지막으로 컨트롤러에서 이 모든 기능을 사용하는 방법은 다음과 같습니다.

import { Controller, Get, UseGuards } from '@nestjs/common';
import { UserMetadata } from '../decorators/user.decorator';
import { AuthGuard } from '../guards/auth.guard';
import { Public } from '../decorators/public.decorator';

@Controller('users')
export class UserController {

  @Public()
  @Get('login')
  login() {
    return { message: 'Login endpoint (public)' };
  }

  @UseGuards(AuthGuard)
  @Get('profile')
  getProfile(@UserMetadata() user: IUser) {
    return {
      message: 'User Profile',
      user,
    };
  }
}

마무리

그리고 거기에 있습니다! 공개 경로를 관리하기 위해 사용자 정의 데코레이터, 미들웨어 및 메타데이터 데코레이터를 만들었습니다.

이러한 도구를 사용하면 NestJS에서 안전하고 체계적인 API를 구축할 수 있습니다.

이것이 너무 부담스럽다면 기억하세요. 로마도 하루아침에 만들어지지는 않았지만 API는 확실히 더 빠르게 확장될 수 있습니다!

이 스니펫을 자유롭게 조정하고 실험해 보세요.

NestJS에는 한계가 없습니다! ?

---

저는 LiveAPI라는 매우 편리한 도구를 개발해왔습니다.

개발자가 쉽게 API 문서를 작성할 수 있도록 설계되었습니다.

LiveAPI를 사용하면 사용자가 브라우저에서 직접 API를 실행할 수 있는 대화형 API 문서를 빠르게 생성할 수 있습니다.

API용 문서를 수동으로 작성하는 데 지쳤다면 이 도구를 사용하면 작업이 더 쉬워질 수 있습니다.

Lama2에서 LiveAPI까지: 매우 편리한 API 문서 작성(2부)

Hexmos의 Athreya(일명 Maneshwar) ・ 2024년 12월 14일

#웹개발 #자바스크립트 #프로그램 작성 #초보자

위 내용은 NestJS에서 데코레이터와 미들웨어를 만들고 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!