[BackEnd][Node.js][nest.js-PJ] 사내 개발자 커뮤니티 서비스 - 게시판 만들기 : 초기 구성(Entity, Controller,Module,Repository,Service)

 

 

 

Project Git Hub

 

 

🗂 목차

● [BackEnd][Node.js][nest.js-PJ] 사내 개발자 커뮤니티 서비스 - 초기 구성(Pipe, TypeORM, Configuration, Swagger, Logger)

● [BackEnd][Node.js][Nest.js] 사내 개발자 커뮤니티 서비스 - 회원 가입

● [BackEnd][Node.js][Nest.js] 사내 개발자 커뮤니티 서비스 - JWT를 이용한 Login

● [BackEnd][Node.js][Nest.js] 사내 개발자 커뮤니티 서비스 - Passport, JWT를 이용한 인가 처리

● [BackEnd][Node.js][Nest.js] 사내 개발자 커뮤니티 서비스 - Custom Decorator

● [BackEnd][Node.js][nest.js-PJ] 사내 개발자 커뮤니티 서비스 - 게시판 만들기 : 초기 구성(Entity, Controller,Module,Repository,Service)

 

 

 

 

📚 부록

● [Node.js] Node.js 기초
● [JavaScript] 기본 문법 
● [BackEnd][Node.js] 사내 개발자 커뮤니티 서비스 - 초기 구성
● [BackEnd][Node.js] 사내 개발자 커뮤니티 서비스 - 초기 구성 : DB 연결
● [BackEnd][Node.js] 사내 개발자 커뮤니티 서비스 - 초기 구성 : DB 연결(Sequelize)
● [Web] URL의 이해
● [Spring] Spring이란?
●[Node.js][Nest.js] 유효성 검사와 Data 형식 변환하기 - Pipe
●[Node.js][Nest.js] Configuration (설정)
●[Node.js][Nest.js]TypeORM
● [Node.js][Nest.js] Logger 기능
●[JavaScript] Promise와 async 그리고 await 
● [Nest.js] API 설계 - 요청, 응답 객체 (Request, Response Object) 
● [정보보안] JWT(JSON Web Token) 이란? 
● [Nest.js] Middle Ware(미들웨어)

 

 

 

 

🤔 내가 만난 Error

● [Node.js][Error] Cannot find module '.dotenv'

 

 

 

 

 

 

 

 

 

🚀 게시판 만들기

    🔽  정리하기

src 밑에 자동으로 생성된 `app.controller.spec.ts`, `app.controller.ts`, `app.service.ts`는 제거해 주도록 할 것이에요.

 

 

 

app.module.ts

지운 File들로 인해 `Exception`이 발생한 것이에요. 이 곳도 정리 해 주도록 할 것이에요.

 

app.module.ts

 

 

 

 

 

    🔽  Module 만들기

        📦 devInquery.module.ts

`Node.js`는 대부분 직접 File을 만들기 보다 명령어를 통해 자동으로 생성하는 것을 좋아하는 것 같은 것이에요.

 

명령어

nest g module {Module-name}

 

💡 참고 사항
명령어 정리

● nest : nestcli를 사용하기 위해 선언.
● g : generate(생성하다) 즉, Module을 만들기 위해 사용하는 Option.
● module : Module을 만들겠다고 선언.
● {Module-name} : 만들고 싶은 Module 이름 선언.

 

$ nest g module {Module-name}

위에 명령어를 입력하니 아래 File이 생성된 것이에요.

 

devInquery Directory 구조

위에 만든 Module을 사용하기 위해서는 `Root` Module인 `app.module.ts`에 등록해주어야 하는 것이에요. 이 부분은 명령어를 통해 Module을 만들 때 자동으로 선언됩니다.

 

app.module.ts

잘 만들어졌나 확인하기 위해 Server를 올려 볼것이에요.

 

$npm run start:dev

Server가 정상적으로 실행 중인 것이에요.

 

 

 

    🔽  Controller 만들기

`Contoller`는 `Client` 측에서 보낸 `Request(요청)`을 처리하고, 응답을 반환하는 일을 하는데, Route에 역할을 하는 것이에요.

 

Routing 방식

 

 

명령어

nest g controller {controller-name} {--no-spec}

위에 명령어에서 `--no-spec`은 선택사항인데, 위와 같이 입력하면 `Test Code`를 자동으로 만들지 않는 것이에요.

 

$ nest g controller {controller-name} {--no-spec}

위 명령어를 입력하면 `Controller`가 자동으로 만들어 지는 것이에요.

 

 

 

💡 참고 사항
CLI를 통해 Controller가 만들어지는 순서

● 최초 CLI는 명령어로 입력된 이름에 해당하는 Directory가 있는지 찾고, 있으면 그 안에 만들고, 없으면 Directory 생성 뒤 그 안에 만든다.
● 해당 Directory에 Module을 찾고, Module안에 Controller에 대한 내용을 넣어준다.

 

 

 

    🔽  Providers, Service 만들기

        📦 개요

► Providers란? `Nest.js`의 기본 개념으로 대부분의 기본 `Nest.js` Class는 `Service`, `Repository`, `Factory`, `Helper` 등 `Provider`로 취급 될 수 있는 것이에요. `Provider`의 주요 Idea는 `의존관계(종속성) 주입(Dependency Injection - DI)`을 할 수 있다는 것이에요. `Spring Boot`를 사용해 보신 분들은 아주 익숙한 용어 인 것이에요.

즉, 객체는 서로 다양한 관계를 만들 수 있는데, 인스턴스를 연결하는 기능은 대부분 `Nest.js` Runtime System에 위임될 수 있는 것이에요. 

 

`Controller`는 여러 `Service`를 DI하여 해당 Service의 Method를 호출해서 비즈니스 로직 처리를 부탁하는 것이에요.

 

► Service란? 비즈니스 로직을 담당하는 `Service`는 `Spring`에도 필수적으로 사용되는 개념인 것이에요. `Nest.js`에서는 `@Injectable` Decorator로 감싸져 Module에 제공되고, 이 `Service` 인스턴스는 Application 전체에서 이용될 수 있는 것이에요. 

`Service`는 `Controller`에서 Data의 유효성 검사를 하거나, Data Base에 Item 생성 등을 하기 위해 `Repository`에게 작업을 위임하는 등의 비즈니스 로직을 처리하는 것이에요.

 

 

        📦 생성하기

명령어

nest g service {service-name} {--no-spec}

명령어에 대한 설명은 위에 했으니 생략할 것이에요.

 

 

$ nest g service {service-name} {--no-spec}

 

 

반응형

 

`Service`가 정상적으로 만들어 진 것이에요.

 

dev-inquery.module.ts

또한, Module을 확인해 보면 자동으로 `Controller`와 `providers`라고 명명된 `Service`가 등록되어 있는 것이에요.

 

 

dev-inquery.service.ts

`Service` class 안을 살펴보면 `@Injectable()`이 있는 것이에요. `Nest.js`는 이것을 이용해서 다른 `Component`에서 해당 `Service`를 이용할 수 있게 (Injectable) 만들어 주는 것이에요.

 

 

 

 

        📦 의존관계 주입(DI)

`Controller`에서 `Service`가 이용될 수 있게 DI(Dependency Injection)을 해 줄 것이에요.

 

dev-inquery.controller.ts

`Spring Boot`에서는 `Contorller`에서 `Service`를 DI하기 위해 Member 변수로 `Service` 객체 자료형 타입 변수를 선언하고, 이를 생성자를 통해 `this.{service-name} = {service-name}`을 하여 DI를 하거나, `final`로 선언하여 `@RequireArgsConstructor`를 이용하는 등의 방식을 썼었는데, `Nest.js`는 이렇게 `constructor`라는 Keyword를 통해 생성자를 만들고, `private`이라는 접근 제한자를 선언해서 `Service` 객체를 선언해주면 되는 것이에요.

위와 같은 Code는 바로 `TypeScript`가 도와주기 때문에 가능한 문법인데, `JavaScript`에서는 `private`와 같은 접근 제한자(Access Modifier)를 이용할 수 없지만, `TypeScript`에서는 이용이 가능한 것이에요.

만약 6번째 줄에 `private`을 선언하지 않는다면 아래와 같이 선언을 해줘야 할 것이에요.

 

dev-inquery.controller.ts

이건 마치 Annotation을 쓰지않고, 생성자 DI를 하는 `Spring Boot`와 모습이 흡사하네요. 물론 `Spring Boot`에서 위와 같이 하려고 한다해도 `@Autowired` 같은 Annotaion을 생성자한테 붙혀줘야 하지만 말이에요.

위 Code를 분석해 보면 9번째 줄에 `devInqueryService` Parameter에 `DevInqueryService` 객체를 자료형 Type으로 지정해 주는 것이에요. JAVA와 비교하면 앞 뒤가 바뀐 모습인 것이에요.

11번째 줄에 `devInqueryService` Parameter를 `DevInqueryController`에서 이용할 수 있게 `this.devInqueryService Property`에 `devInqueryService` Parameter를 할당해 주는 것이에요.

그런 뒤 7번째 줄에 `TypeScript`에서는 선언한 값만 객체의 `Property`로 사용할 수 있기 때문에 위와 같이 선언해 준 것이에요.

이렇게 얻어온 `devInqueryService Property`를 이용하여 `DevInqueryController` Class 안에서 이용할 수 있는 것이랍니다.

 

예시 코드

 

참고로 `private`을 선언하면 `devInqueryService Property`는 `DevInqueryController` Class에서만 이용 가능한 것이에요.

 

 

 

 

    🔽  Model 만들기

`Spring Boot JPA`에서는 `Entity` Class를 `Interface`로 만들지 않지만, `Nest.js`에서는 `Interface`로 구현해도 되는 것이에요.

 

 

Q&A게시판(DevInquery) Entity

해당 게시글 기능에는 비밀글 기능이 있는 것이에요. 비밀글은 `enum` Class를 이용해서 위와 같이 만들어 준 것이에요.

즉, `secretAt(비밀글 여부)`에는 `String` Type 'N'과 'Y'만 입력될 수 있는 것이에요.

 

💡 참고 사항
Decorator 설명

● @Entity() : 해당 Class가 Entity임을 표현. Data Base DDL 'CREATE TABLE {Table-name}'에 해당.
● PrimaryGeneratedColumn() : 해당 Property (JAVA: Memeber 변수)가 해당 Entity의 Primary Key 값임을 표현.
● @Column() : Data Base 기준 Table의 각 열을 표현.

 

 

 

    🔽  Repository 만들기

►Repository란?

`Repository`는 `Entity` 객체와 함께 작동하며, 실제 Data Base와 연결되어 SQL문을 던지는 역할을 하는 것이에요.

 

공식 문서

 

dev-inquery 계층도

먼저 주니하랑은 위와 같이 `dev-inquery.repository`를 만들어 준 것이에요.

 

dev-inquery.repository.ts

정말 `JPA`와 거의 똑같은 것이에요. 차이가 있다면 `JPA`는 `Interface`로 구현하는데, `TypeORM`은 Class로 만드는 것이에요.

생성 시 `Repository` Class를 `Extense` 해주는데, 이를 통해 `Find`, `Insert`, `Delete` 등과 같은 Method를 통해 `Entity`를 Control 해줄 수 있는 것이에요.

`@EntityRepository()`는 Class를 이용자 정의(Custom) 저장소로 선언하는데 이용되는 것이에요. 이용자 지정 저장소는 일부 특정 `Entity`를 관리하거나, 일반 저장소 일 수 있는 것이에요.

위 `Repository`를 다른 곳에서도 이용 가능하게 하기 위해 (Injectable) `dev-inquery.module.ts`에서 `import`해줘야 하는 것이에요.

 

dev-inquery.module.ts

21번째 줄에 `Repository`를 `import` 해준 것이에요.

 

마지막으로 `app.module.ts`에 `TypeORM`에 대한 설정 File을 `imports` 시켜줘야 하는 것이에요.

 

app.module.ts

 

 

 

문제 발생!!

위에 대한 `Exception` 내용은 `이 곳`에 정리 해서 준비해 둘게요!

 

 

 

 

이제 기본 준비는 끝난 것이에요.

다음 포스팅에서 본격적으로 게시판 기능 구현을 해 보도록 하겠습니다!

 

 

 

이전 글 : [BackEnd][Node.js][Nest.js] 사내 개발자 커뮤니티 서비스 - Custom Decorator