기본 콘텐츠로 건너뛰기

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

댓글

이 블로그의 인기 게시물

카카오 오픈빌더와 외부 API 연동(feat.Nodejs)

카카오 오픈빌더와 외부 API 연동(feat.Nodejs) 이전에 플러스 친구와 외부 API 연동에 관한 글을 작성한 적 있습니다. 하지만 지난 2년동안 플러스 친구에 많은 변화가 생겼는데요. 카카오 플러스 친구의 명칭이 카카오 채널로 바뀌고, 챗봇 세팅 방식이 기존 [카카오 플러스 친구 - 외부 API 연동] 구조에서 오픈빌더가 추가되어 [카카오 채널(구 플러스 친구) - 카카오 i 오픈빌더 - 외부 API 연동] 구조로 바뀌었습니다. 이번 글에서는 오픈빌더의 챗봇 시나리오 관리 기능을 간단히 소개하고 외부 API를 연동하는 예제를 다뤄보겠습니다. (연동파트는 5번 항목부터 보시면 됩니다.) 1. 블록 블록은 오픈빌더에서 질의/응답을 관리하는 최소 단위로, 사용자의 발화와 챗봇의 대답을 입력할 수 있습니다. 예를들어 인사라는 블록을 만들고 인사에 해당하는 사용자 발화 패턴들을 입력해두면, 실제 채널 톡방에서 그에 해당하는 발화가 들어왔을때 입력해둔 응답이 나오는 형식입니다. 예전에는 패턴과 발화 키워드가 1:1 매칭, 즉 입력해둔 패턴과 사용자 발화의 string이 정확히 일치할때만 블록이 실행됐었는데, 발화 패턴을 20개 이상 등록하면 머신러닝 기능을 이용할 수 있도록 기능이 생겼습니다. 아마 유사도 분석 개념이 기본으로 들어가있을 것이기 때문에 블록의 주제와 벗어나는 너무 뜬금없는 발화패턴들을 많이 넣지 않도록 하는걸 권장하겠습니다. 2. 시나리오 시나리오는 '블록'들을 묶어서 관리할 수 있는 단위로, 일종의 폴더 구조라고 생각하면 쉽습니다. 오픈빌더에서 좌측 상단에 파란 버튼을 클릭하여 시나리오를 생성할 수 있습니다. 하나의 시나리오에서 모든 블록을 관리하면 챗봇 도메인이 커질수록 관리가 어려워지니 아래 같은식으로 시나리오를 사용하여 블록을 구조화하면 운영 측면에서 수월해집니다. 3. 컨텍스트 컨텍스트는 맥락이라는 뜻 입니다. 오픈빌더에 존재하는 컨텍스트는 자연어 분석을 통해서 맥...

AWS instance로 Nodejs 구현하기

AWS instance로 Nodejs 구현하기 서버와 데이터베이스 관리 차원에서 효율적으로 관리하기 위해선 로컬보다는 서버를 호스팅해서 하는 것이 좋다. 우리는 Nodejs를 구동하기 위해 AWS에서 인스턴스를 할당받을 계획이다. 인스턴스의 pem키를 발급받아 nodejs와 npm까지는 설치를 완료한 상태이다. $ sudo npm install -g express 다음의 명령어를 입력하면 글로벌 옵션으로 어느 path에서든 express를 사용할 수 있게 설치한다. 다음과 같이 실행이 된다면 성공이다. 이후 Express generator를 설치한다. $ sudo npm install -g express-generator@4 버전은 4.x이며 이 역시 글로벌 옵션으로 설치해 준다. 이제 Node monitoring을 위해 nodemon을 설치해 준다. $ sudo npm install -g nodemon 모든 설치가 끝났다. 이제 nodejs를 실행시킬 프로젝트용 directory를 만든다. 이렇게 만들어 주고 express를 실행시키면 된다. $ express -e 다음과 같은 결과가 나오면 된다. 이제 node package를 설치하는 명령어를 입력하자. $ sudo npm install 이제 vi를 통해 포트번호를 정의해보자. app.set의 마지막에 한줄을 추가하면 된다. app.set('port', process.env.PORT || 9000); 이로써 우리는 9000번 포트를 사용하게 되었다. 또한 마지막줄에 서버를 생성하기 위한 코드를 작성하자. module.exports = app; var server = app.listen(app.get('port'), function() { console.log('Express server listening on port ' + server.address().port); }); 이...

20.03.24 ShareBook TIL

20.03.24 ShareBook TIL Project/TIL 20.03.24 ShareBook TIL 중간 배포를 위해 EC2, RDS를 다시 설정하였다. EC2에 git에서 clone을 하고 서버를 작동시켜보니 ts로 돌려서 그런지 작동하지 않고 대기 상태로 있다가 timeout같은 시간 초과 에러가 났다. 그리고 갑자기 EC2 자체가 느려져서 nodejs를 삭제하고 다시 nvm으로 높은 버전의 node를 설치하였다. 그리고 나서 혹시 js로 돌리면 될까 해서 tsc로 js로 변환한뒤 돌려보니 RDS와 연결이 되지 않는 에러가 생겼다. workbench로 RDS를 연결했을 때는 정상적으로 작동해서 EC2에서 잘 못 설정한게 있다고 생각했다. 그래서 local에서 한번 config.json을 수정하고 연결하여도 똑같은 에러가 발생했다. 그럼 보안 설정에서 문제인가 싶어서 EC2, RDS 보안 그룹에서 설정을 막 만져보다 RDS에서 Custom TCP에 처음 RDS에서 설정한 포트를 넣어주었더니 연결되었다. config.json내용을 EC2에도 똑같이 적용시켜보려고 json파일을 vim으로 작성해서 넣어 주었지만 여전히 같은 에러를 반복하였다. 그럼 json 파일을 못 읽어내는게 아닌가 싶어서 그냥 module에 index.js에서 sequelize를 생성하는 부분에 직접 넣어 주었더니 마침내 연결이 되었다. 해결하고 난 뒤 생각의 흐름을 적어보니 매우 짧지만 정작 오늘 아침 10시 반부터 시작해서 저녁 10시 반까지 12시간을 고민하고나서야 해결되었다. from http://three-five.tistory.com/46 by ccl(A) rewrite - 2020-03-25 00:54:05