기본 콘텐츠로 건너뛰기

Hello Nestjs

Hello Nestjs

Nestjs Offical Site

Google에서 만든 V8엔진이 JavaScript의 성능을 비약적으로 개선되면서, JS를 이용해 서버도 돌릴 수 있지 않을까 하는 의문이 시작됐고 Nodejs가 탄생하게 되었다. 최근에는 Nodejs를 이용해서 프로덕트를 구축하는 기업도 많이 늘어나는 추세이며, 앞으로 더욱 발전할 것이라 기대된다.

보통 노드를 이용해서 서버를 구축한다고하면, 기본(default)으로 제공되는 모듈을 이용해서 만드는 사람은 거의 없다고 봐도 무방하다. 노드 진영에서 대표적으로 많이 사용하는 프레임워크로는 Expressjs가 있다. 미들웨어(Middleware) 패턴을 이용해서 빠르게 서버를 구축할 수 있으며, 미니멀(Minimal)하고 러닝 커브(Learning Curve) 또한 적어서 쉽게 적용할 수 있다. 현재 V4까지 출시되었으며, 현재 V5 Alpha 버전도 개발 중이다. 물론 Expressjs뿐만 아니라 Koa, LoopBack이란 프레임워크도 종종 사용되며 끊임없이 발전하고 있다. 하지만 오늘은 이보다 더 진보적인 하지만 익숙한, Nestjs라는 프레임워크에 대해 간단하게 알아보도록 하자.

위 사진은 Nestjs의 오피셜 메인 페이지 화면을 캡쳐한 것이다. 처음 보는 사람도 있을 것이고, 이름을 들어본 사람도 있을 것이다. 이렇게 보여도 버전 6까지 나온(?) 프레임워크이다. 주목할만한 부분은 ES7(혹은 타입 스크립트)에 새로 추가된 데코레이터(Decorator)를 주로 이용한다는 것이다. 그럼 nestjs는 어떻게 데코레이터(@)를 이용한다는 것일까. 아래 코드를 가볍게 보도록 하자.

Nestjs는 기본적으로 컨트롤러(Controller)를 통해 라우팅(Routing)을 구현한다. /cats 경로로 들어오는 리퀘스트를 처리하기 위해선 @Controller 데코레이터를 이용해서 다음과 같이 컨트롤러를 정의한다.

import {Controller} from '@nestjs/common'; @Controller('cats') export class CatsController { // todo }

굉장히 직관적이다. 또한 코드의 변경에도 매우 유연하게 대응할 수 있다. 그렇다면 컨트롤러를 통해 받은 METHOD는 어떻게 정의하는가. 마찬가지로 @Get() 데코레이터를 이용한다. 또 코드를 보면 알겠지만 Nestjs는 타입스크립트를 기본으로 사용한다. 타입의 정의에 따른 이점을 극대화하고 있으며, 프레임워크에 잘 녹여내고 있다.

import {Controller, Get} from '@nestjs/common'; @Controller('cats') export class CatsController { @Get() findAll(): string { return 'This action returns all cats'; } }

그렇다면 post 메서드나 동적 매칭, 헤더나 스테이터스 코드에 대한 로직처리는 어떻게 하면 될까? 마찬가지로 데코레이터를 이용한다. 여기까지 오면 아래 코드를 보지 않아도 어떤 데코레이터를 사용해야 할지 느낌이 올 것이다.

import {Controller, HttpCode, Get, Post, Header, Param, Body} from '@nestjs/common'; import {CreateCatDto} from "./create-cat.dto"; @Controller('cats') export class CatsController { @Post() @Header('Cache-Control', 'none') create(): string { return 'This action adds a new cat'; } @Get() findAll(): string { return 'This action returns all cats'; } @Get('ab*cd') wildcards() { return 'This route uses a wildcard'; } @Get('status') @HttpCode(500) withStatusCode() { return 'This route status code 500'; } @Get(':id') findOne(@Param() params): string { console.log(params.id); return `This action returns a #${params.id} cat`; } }

@Post의 경우에는 DTO(Data Transfer Object)를 정의해서 받는 것도 가능하다.

import {Controller, HttpCode, Get, Post, Header, Param, Body} from '@nestjs/common'; import {CreateCatDto} from "./create-cat.dto"; @Controller('cats') export class CatsController { @Post('dto') async createWithDto(@Body() createCatDto: CreateCatDto) { return 'This action adds a new cat: ' + JSON.stringify(createCatDto); } @Post() @Header('Cache-Control', 'none') create(): string { return 'This action adds a new cat'; } @Get() findAll(): string { return 'This action returns all cats'; } @Get('ab*cd') wildcards() { return 'This route uses a wildcard'; } @Get('status') @HttpCode(500) withStatusCode() { return 'This route status code 500'; } @Get(':id') findOne(@Param() params): string { console.log(params.id); return `This action returns a #${params.id} cat`; } } // create-cat.dto.ts export class CreateCatDto { readonly name: string; readonly age: number; }

여기까지 본 사람이라면 어디서 많이 본 구조라 생각이 될 것이다. 그렇다. 바로 Spring Framework와 매우 그 구조가 유사하다. 스프링에 익숙한 개발자라면, Nestjs를 익히는데 큰 어려움이 없을 것이라 생각한다. 이제 개발한 컨트롤러를 모듈에 붙여주기만 하면 완성이다.

import { Module } from '@nestjs/common'; import { CatsController } from './cats.controller'; @Module({ controllers: [CatsController], }) export class AppModule {}

애플리케이션 서버를 만드는 과정도 Expressjs만큼이나 심플하다.

import { NestFactory } from '@nestjs/core'; import { AppModule } from './app.module'; async function bootstrap() { const app = await NestFactory.create(AppModule); await app.listen(3000); } bootstrap();

오늘의 설명은 여기까지. 처음 접하는 사람에게는 이 정도도 충분히 매력적으로 어필이 되었을 것이라 생각한다. 이밖에도 Provider, Module, Middleware, Pipe, Guard, Interceptor 등 서버 개발에 필요한 다양한 개념이 있지만 앞으로 천천히 다뤄보도록 하겠다. 해당 샘플 코드는 hello-nestjs에 올려두었으니 관심 있는 사람은 참고해 보길 바라며, 새로 프로젝트를 시작하는 사람이라면 Nestjs Framework를 고려해보면 어떨지 조심스럽게 추천해본다.

from http://dev-momo.tistory.com/45 by ccl(S) rewrite - 2020-03-06 16:20:07

댓글

이 블로그의 인기 게시물

[Mac OS X] 데스크탑 응용프로그램 개발시작

[Mac OS X] 데스크탑 응용프로그램 개발시작 현재 회사에서 다음 프로젝트로 Mac OS X를 개발해야 하는 일정이 생겨 난생 처음 데스크탑 응용프로그램을 개발하기 공부를 시작했고 여러가지 플랫폼이 있다는것을 발견했다. 어떤 플랫폼을 사용해야할 지 먼저 고민해보자. 무엇으로 개발할것인가? Xcode & Swfit or Objective-C Mac OS X 는 objective-c를 기반으로 만들어졌다. apple에서 제공하는 Xcode와 objective-c 혹은 Swift로 응용 프로그램을 만들 수 있다. Electron Electron 프레임워크를 사용하면 javascript, HTML, CSS를 사용하여 크로스 플랫폼 데스크탑 응용 프로그램을 만들 수 있다. react-native-desktop Qt 프레임 워크를 기반으로하는 크로스 플랫폼이다. react-native 와 javascript로 응용 프로그램을 만들 수 있다. Qt는 컴퓨터 프로그래밍에서 GUI 프로그램 개발에 널리 쓰이는 크로스 플랫폼 프레임워크. 각 플랫폼의 장단점은 무엇인가? Xcode & Swfit or Objective-C - 장점 모든 OSX API에 직접 접근할 수 있다. Xcode를 통해 App Store에 쉽게 배포할 수 있다. - 단점 Windows 전용 응용 프로그램을 다시 개발해야한다. Swift언어를 모른다면 새로 공부해야 한다. Electron - 장점 웹스택을 가지고 빠르게 만들 수 있다. 다양한 플랫폼을 지원한다. - 단점 Native언어로 개발할때 보다 성능이 떨어질 이슈가있다. OS X API를 사용하는데 복잡하다. *API에 대한 JavaScript 래퍼가 없으면 자체 래퍼를 작성하지 않는 한 프로젝트에서 사용할 수 없습니다. React-native-desktop - 장점 현재 개발스택과 완전히 동일하므로 더 빠르게 개발 할 수 있다. 다양한 플랫폼을 지원한다. - 단점 N...

AWS CI/CD 파이프라인에 Slack 알람 적용(Lambda, CloudWatch Events 연동)

AWS CI/CD 파이프라인에 Slack 알람 적용(Lambda, CloudWatch Events 연동) 이번 글에서는 구축된 CI/CD 파이프라인과 Slack 알람을 연동하는 방법에 대해서 알아볼 것이다. CI/CD 파이프라인 시작/종료(성공/실패) 시 Amazon CloudWatch Events에서 해당 이벤트를 감지한 후 AWS Lambda로 트리거 신호를 보내면 AWS Lambda에서 Slack채널로 알람을 보내는 프로세스다. 글의 순서는 다음과 같다. Amazon CloudWatch Events, AWS Lambda란? 실습 전 준비사항 Slack Webhook 생성 AWS Lambda 함수 생성 AWS CloudWatch Events 생성 테스트 위와 같은 방식으로 구축을 하면 최종 프로세스는 다음 그림과 같다 (우리가 이 글에서 진행하는 내용은 빨간색으로 표시된 부분) 1. Amazon CloudWatch Events, AWS Lambda란? 1-1. Amazon CloudWatch Events란? Amazon CloudWatch Event(혹은 AWS CloudWatch Events)는 AWS 상태 변경 등을 감시할 수 있는 기능이다. 만약 사용자가 만든 규칙에 맞는 이벤트가 발생하게 되면 해당 이벤트가 사정에 정의된 규칙과 일치할 경우 하나 이상의 대상 작업을 호출한다. 이벤트 유형에 따라 알람을 보내거나, 이벤트 정보를 캡쳐하거나, 교정작업을 수행하거나, 이벤트를 시작하거나, 기타 작업을 수행할 수 있다. 이벤트가 발생할 경우 대상 작업은 AWS Lambda함수, AWS Kinesis 스트림, AWS SQS, Amazon SNS 등이 있다. 사용되는 사례로는 1) 이벤트가 발생하면 Lambda함수를 사용하여 Slack채널로 알림을 전달하거나, 2) AWS 상태 이벤트가 발생하면 Lambda 및 CloudWatch Events를 사용하여 Amazon SNS로 사용자 지정 텍스트 또는 SMS 알림을 보내는 등...

[2020-angstromCTF] web - A peculiar query write-up

[2020-angstromCTF] web - A peculiar query write-up English write-up UI seems like below. If you click the 'the source' link, you can get back-end source code. const express = require("express"); const rateLimit = require("express-rate-limit"); const app = express(); const { Pool, Client } = require("pg"); const port = process.env.PORT || 9090; const path = require("path"); const client = new Client({ user: process.env.DBUSER, host: process.env.DBHOST, database: process.env.DBNAME, password: process.env.DBPASS, port: process.env.DBPORT }); async function query(q) { const ret = await client.query(`SELECT name FROM Criminals WHERE name ILIKE '${q}%';`); return ret; } app.set("view engine", "ejs"); app.use(express.static("public")); app.get("/src", (req, res) => { res.sendFile(path.join(__dirname, "index.js")); }); app.get("/", async (req, res) => { if (req.query...