시작 전 PC 가 바뀌어 새로운 PC에 프로젝트를 설정해야 했다.
git에 nestjs-board-app을 업로드 해놓아서 gitclone 으로 프로젝트를 열고
cmd 에 'nest i -g @nest/cli' 실행 후 프로젝트를 열어보니 main.ts 에 오류가 떠 있었다..

Cannot find module '@nestjs/core' or its corresponding type declarations.

라는 오류였고, 쉽게 해결 할 수 있었다.
terminal 에 'npm install @nestjs/core'와 'npm install @nestjs/common' 을 입력하여 해결하였다.

모든 게시물을 가져오는 서비스 만들기 (CRUD => R)

모든 게시물 데이터를 데이터베이스에서 가져오는 로직 구현

로직은 Service에서 구현. 바로 데이터베이스와 연동해서 하면 되지만 처음부터 데이터베이스 연결해서 하면 헷갈릴수있기 때문에 우선 데이터를 로컬 메모리에 담아서 처리
<board.service.ts>

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

@Injectable()
export class BoardsService {
    private boards =[];

    getAllBoards(){
        return this.boards;
    }
}

private boards의 private 사용 이유 : 사용하지 않으면 다른 컴포넌트에서 이 BoardsService에 접근해서 이 boards 배열 값을 수정할 수 있기 때문

<board.controller.ts>

import { Controller, Get } from '@nestjs/common';
import { BoardsService } from './boards.service';

@Controller('boards')
export class BoardsController {
    constructor(private boardService: BoardsService) {}

    @Get()
    getAllBoard() {
        return this.boardService.getAllBoards;
    }
}

'npm run start:dev' 로 실행, localhost:3000/boards 확인

=> 클라이언트에서 요청을 보내면 먼저 컨트롤러로 가며 컨트롤러에서 알맞은 요청 경로에
라우팅해서 해당 핸들러로 가게 한다. 그런 후에 요청을 처리해주기 위해서 서비스로 들어가며 그 요청에 맞는 로직을 서비스에서 처리해준 후 컨트롤러에 리턴값을 보내준후 컨트롤러에서 클라이언트로 결과값을 보내준다.
컨트롤러에서는 요청을 처리하고 결과값을 리턴해주는 역할을 한다.

Board Model 정의하기

게시물 데이터에는 ID가 필요하고 이름이나 설명등이 필요 하다는 정의를 토대로 시작!

모델을 정의하기 위해서

Class를 이용하거나 Interface 이용

• Interface : 변수의 타입만 체크
• Classes : 변수의 타입, 인스턴스 또한 생성 가능

우선 Interface 사용

• status : 게시글이 공개인지 비공개인지 나눠주는 것
  두가지 상태 이외의 것은 나오면 안되기 때문에 타입스크립스의 기능인 enumeration을 사용
  

<board.model.ts>

export interface Board{
    id : string,
    title : string,
    dedcription: string,
    status: BoardStatus; //PUBLIC or PRIVATE
}

export enum BoardStatus {
    PUBLIC = 'PUBLIC',
    PRIVATE ='PRIVATE' 
}

생성한 Board 모델을 이용해서 타입을 정의 ⬇
<boards.service.ts>

import { Injectable } from '@nestjs/common';
import { Board } from './board.model';

@Injectable()
export class BoardsService {
    private boards: Board[] = []; // 배열주의

    getAllBoards(): Board[] { //배열주의
        return this.boards;
    }
}

<boards.controller.ts>

import { Controller, Get } from '@nestjs/common';
import { BoardsService } from './boards.service';
import { Board } from './board.model';

@Controller('boards')
export class BoardsController {
    constructor(private boardsService: BoardsService) {}

    @Get('/')
    getAllBoard(): Board[] { //배열주의
        return this.boardsService.getAllBoards();
    }
}

타입을 정의하면 좋은 이유

1. 타입을 정의해주므로서 원하는 타입과 다른 코드를 사용할 시 에러가 발생
2. 코드를 읽는 입장에서 더 코드를 쉽게 이해하며 읽을 수 있다. (readable)

게시물 생성하기 (CRUD => C) : Service

게시물 생성 기능 만들기

게시물에 관한 로직을 처리하는 부분은 Service , Service 에서 처리 후 Controller에서 서비스를 호출

id 는 모든 게시물에 유니크 해야한다. 만약 데이터베이스에 데이터를 넣어주는 경우라면 데이터베이스에서 알아서 유니크한 값을 주지만 지금은 임의로 값을 주어야함
=> uuid 모듈을 이용

uuid 모듈

npm install uuid --save

service 에 'import { v1 as uuid } from 'uuid';' 추가

<boards.service.ts>

import { Injectable } from '@nestjs/common';
import { Board, BoardStatus } from './board.model';
import { v1 as uuid } from 'uuid';

@Injectable()
export class BoardsService {
    private boards: Board[] = [];

    getAllBoards(): Board[] {
        return this.boards;
    }

    createBoard(title: string, description: string){
        const board: Board={
            id: uuid(),
            //title: title -> 그냥 title로 생략가능 : 앞뒤 변수명이 동일
            title,
            // description: description
            description,
            status: BoardStatus.PUBLIC
        }

        //게시판에 게시글 생성한 것을 넣어주기
        this.boards.push(board);
        return board;
    }
}

게시물 생성하기 (CRUD => C) : Controller

Request, Response

controller 에 정의

클라이언트에서 보내온 값을 핸들러에 가져오기

클라이언트에서의 정보 받아오기
=> @Body body ..
<boards.controller.ts>

import { Body, Controller, Get, Post } from '@nestjs/common';
import { BoardsService } from './boards.service';
import { Board } from './board.model';

@Controller('boards')
export class BoardsController {
    constructor(private boardsService: BoardsService) {}

    @Get('/')
    getAllBoard(): Board[] {
        return this.boardsService.getAllBoards();
    }

    //body 전체 한번에 가져오기
    // @Post()
    // createBoard(@Body() body) {
    //     console.log('body', body);
    // }

    //body 의 특정 값만 가져오기
    // @Post()
    // createBoard(@Body('title') title: string, @Body('description') description: string) {
    //     console.log('title', title);
    //     console.log('description', description);
    // }

    @Post()
    createBoard(@Body('title') title: string, @Body('description') description: string): Board { //return 값의 타입은 Board, Board[]로 주면 안됨 : service의 createBoard의 return 값이 board 하나이기 때문에
        return this.boardsService.createBoard(title, description);
    }

}

위의 주석 중요!!

POSTMAN 으로 테스트

Data transfer Object(DTO)

DTO (Data Transfer Object)

• 계층간 데이터 교환을 위한 객체
• DB에서 데이터를 얻어 Service나 Controller 등으로 보낼 때 사용하는 객체
• DTO는 데이터가 네트워크를 통해 전송되는 방법을 정의하는 객체
• interface나 class를 이용해서 정의 될 수 있다. (하지만 클래스를 이용하는것을 Nest JS에서는 추천)

DTO를 쓰는 이유

• 데이터 유효성을 체크하는데 효율적
• 더 안정적인 코드로 만들어 준다.
• 타입스크립트의 타입으로도 사용된다.

프로퍼티(title, description...)가 많을 때 프로퍼티의 이름을 바꿔야한다면 controller, service 등 여러 곳에서 바꿔줘야한다.
=> 유지보수가 힘듦 => DTO 사용

게시물 생성을 위한 DTO

DTO 파일 작성

클래스는 인터페이스와 다르게 런타임에서 작동하기 때문에 파이프 같은 기능을 이용할 때 더 유용하다.
=> 클래스를 사용해서 DTO를 작성
<create-board.dto.ts>

export class createBoardDto{
    title: string;
    description: string;
}

DTO 적용하기

<boards.controller.ts>

import { Body, Controller, Get, Post } from '@nestjs/common';
import { BoardsService } from './boards.service';
import { Board } from './board.model';
import { createBoardDto } from './dto/create-board.dto';

@Controller('boards')
export class BoardsController {
    constructor(private boardsService: BoardsService) {}

    @Get('/')
    getAllBoard(): Board[] {
        return this.boardsService.getAllBoards();
    }

    //body 전체 한번에 가져오기
    // @Post()
    // createBoard(@Body() body) {
    //     console.log('body', body);
    // }

    //body 의 특정 값만 가져오기
    // @Post()
    // createBoard(@Body('title') title: string, @Body('description') description: string) {
    //     console.log('title', title);
    //     console.log('description', description);
    // }

    @Post()
    createBoard(
        @Body() createBoardDto: createBoardDto
    ): Board { //return 값의 타입은 Board, Board[]로 주면 안됨 : service의 createBoard의 return 값이 board 하나이기 때문에
        return this.boardsService.createBoard(createBoardDto);
    }

}

<boards.service.ts>

import { Injectable } from '@nestjs/common';
import { Board, BoardStatus } from './board.model';
import { v1 as uuid } from 'uuid';
import { createBoardDto } from './dto/create-board.dto';

@Injectable()
export class BoardsService {
    private boards: Board[] = [];

    getAllBoards(): Board[] {
        return this.boards;
    }

    createBoard(createBoardDto: createBoardDto){
        // const title = createBoardDto.title;
        // const description = createBoardDto.description;
        const { title, description }= createBoardDto;
        const board: Board={
            id: uuid(),
            //title: title -> 그냥 title로 생략가능 : 앞뒤 변수명이 동일
            title,
            // description: description
            description,
            status: BoardStatus.PUBLIC
        }

        //게시판에 게시글 생성한 것을 넣어주기
        this.boards.push(board);
        return board;
    }
}

ID로 특정 게시물 가져오기

service -> controller

<service.ts>

getBoardIs(id: string): Board{ //게시물 하나를 return 하기 때문에 Board[] X
        return this.boards.find((board)=>board.id === id);
    }

<controller.ts>

@Get('/:id')
    getBoardById(@Param('id') id: string): Board{
        return this.boardsService.getBoardId(id);
    }

Param

//ex) localhost:3000?id=11111 일 때는 
findOne(@Param('id') id: string)
//ex) localhost:3000?id=11111&title=abcd 일 때는 
findOne(@Param() params: string[])

ID로 특정 게시물 지우기

service -> controller

<service.ts>

deleteBoard(id: string): void{ // return 을 따로 주지 않아도 되기 때문에 void
        this.boards = this.boards.filter((board) => board.id !==id);
    }

<controller.ts>

@Delete('/:id')
    deleteBoard(@Param('id') id: string): void {
        this.boardsService.deleteBoard(id);
    }

특정 게시물의 상태 업데이트

특정 게시물의 상태(PUBLIC 또는 PRIVATE)을 업데이트 해주는 기능
<service.ts>

updateBoardStatus(id:string, status: BoardStatus):Board {
        const board = this.getBoardId(id);
        board.status = status;
        return board;
    }

<controller.ts>

@Patch('/:id/status')
    updateBoardStatus(
        @Param('id') id: string,
        @Body('status') status: BoardStatus
    ) {
        return this.boardsService.updateBoardStatus(id, status);
    }