NestJS와 prisma로 편리하게 CRUD 구현하기

📒 NestJS로 편리하게 CRUD 구현하기

---

요즘 NestJS를 조금씩 공부하며 진도를 나가고 있습니다.

그런데 사용하면 사용할 수록 "정말 편리하다"고 느끼는 중입니다.

 

그럼 NestJS와 prisma로 CRUD api를 구성하는 과정을 소개드리면서 어떠한 점이 편리했는지 설명하겠습니다.

 

📌 prisma 설치 과정

prisma를 설치하고 데이터베이스를 연동하는 과정은 다음 글에 자세히 소개되어있습니다.

Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기

 

📌 prisma 설정

src/prisma에 있는 prisma.service.ts와 prisma.module.ts에 대한 세팅을 해주겠습니다.

🔎 prisma.service.ts

import { Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
import { PrismaClient } from '@prisma/client';

@Injectable()
export class PrismaService
  extends PrismaClient
  implements OnModuleInit, OnModuleDestroy
{
  async onModuleInit() {
    await this.$connect();
  }
  async onModuleDestroy() {
    await this.$disconnect();
  }
}

• NestJS 모듈이 초기화될 때 onModuleInit()이 호출되어 데이터베이스 연결을 설정합니다.
• 애플리케이션이 종료될 때 onModuleDestroy()가 호출되어 데이터베이스 연결을 해제합니다.

🔎 prisma.module.ts

import { Global, Module } from '@nestjs/common';
import { PrismaService } from './prisma.service';

@Global()
@Module({
  providers: [PrismaService],
  exports: [PrismaService],
})
export class PrismaModule {}

NestJS에서 @Global 데코레이터는 특정 모듈을 애플리케이션 전체에서 사용할 수 있는 전역 모듈로 만들어주는 역할을 합니다.

이를 통해 다른 모듈에서 해당 모듈을 반복적으로 imports문에 prisma 모듈을 추가하지 않아도 사용할 수 있습니다.

 

📌 스키마 테이블 정의

// /prisma/schema.prisma
generator client {
  provider = "prisma-client-js"
}

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

model User {
  id Int @default(autoincrement()) @id
  name String
}

model Post {
  id Int @default(autoincrement()) @id
  title String
  desc String
}

prisma/schema.prisma에서 테이블을 정의해줍니다.

저는 테스트용으로 정말 간단하게 작성해주었습니다.

 

📌 prisma Client 생성하기  

$ npx prisma generate

prisma generate 명령어는 Prisma Client를 생성하기 위해 사용하는 명령어입니다.

이 명령어는 schema.prisma 파일에 정의된 데이터 모델을 기반으로 TypeScript 코드로 Prisma Client를 만들어줍니다.

생성된 Prisma Client는 데이터베이스에서 CRUD 연산을 수행할 수 있는 메소드들을 포함하고 있습니다.

 

만약 $ npx prisma migrate dev와 같은 명령어로 DB에 반영을 했다면 자동으로 generate가 수행되니 따로 안해주셔도 됩니다.

성공적으로 클라이언트가 생성되었으면 위와 같이 정의한 테이블을 기반으로 여러 메소드들을 사용할 수 있게 됩니다.

🔎 클라이언트에 반영이 안될 때

스키마 정의하고 prisma generate 혹은 migrate 했는데도 인식을 못해 오류 발생 및 자동 완성이 안된다면, vscode에서 f1을 누르고 Restart TS Server 한번 먹여주면 정상적으로 작동합니다.

이것 때문에 꽤나 시간 잡아먹었으니 참고해주세요.

 

📌 Nest CRUD generator

$ nest generate resource post

// 축약형
$ nest g res post

 

한땀한땀 직접 파일을 만들어주거나 서비스, 컨트롤러, 모듈 등 generate 해주어도 되지만 NestJS에는 CRUD generator가 있습니다.

https://docs.nestjs.com/recipes/crud-generator

 

위 명령어를 실행하고 API 방식을 선택하면 다음과 같이 CRUD에 필요한 모든 보일러 플레이트를 자동으로 생성해줍니다.

 

 

생성된 대략적인 코드를 보여드리면 위와 같습니다.

저는 정말 이 기능을 처음 맛본 후 신문물을 접한 원주민 마냥 놀라 자빠졌습니다.

 

기본적인 폴더 구조부터 각 파일간의 연결, 코드 템플릿 작성.

그저 저는 prisma 연결만 딸깍 해주면 끝나게 됩니다.

 

이를 통해 엄청난 빠른 개발속도와 개발자 간 코드 스타일 통일 등등 다양한 이점을 챙길 수 있겠죠?

 

📌 Service 파일 작성하기

import { Injectable } from '@nestjs/common';
import { CreateUserDto } from './dto/create-user.dto';
import { UpdateUserDto } from './dto/update-user.dto';
import { PrismaService } from 'src/prisma/prisma.service';

@Injectable()
export class UserService {
  constructor(private prisma: PrismaService) {}

  async create(data: CreateUserDto) {
    const user = await this.prisma.user.create({ data });
    return user;
  }

  async findAll() {
    const userList = await this.prisma.user.findMany();
    return userList;
  }

  async findOne(id: number) {
    const user = await this.prisma.user.findUnique({
      where: { id },
    });
    return user;
  }

  async update(id: number, data: UpdateUserDto) {
    const user = await this.prisma.user.update({
      where: { id },
      data,
    });
    return user;
  }

  async remove(id: number) {
    const user = await this.prisma.user.delete({
      where: { id },
    });
    return user;
  }
}

CRUD에 필요한 5가지 service를 작성해보았습니다.

prisma는 따로 설명이 필요없을 정도로 직관적인 메소드를 갖고 있습니다.

 

🔎 prisma 서비스 주입 받기

constructor(private prisma: PrismaService) {}

생성자 방식으로 prisma 서비스를 주입 받도록 했습니다.

아까 위에서 prisma module을 @Global로 설정했기 때문에 사용하는 모듈에서 별도로 import 하지 않아도 됩니다.

 

🔎 대표적인 prisma CRUD 메소드

• findUnique
  특정 레코드를 검색할 때 사용
  ex) prisma.user.findUnique({ where: { id: 1 } })
• findMany
  여러 레코드를 검색할 때 사용
  다양한 필터와 정렬 옵션이 가능
• create
  새로운 레코드를 추가
  ex) prisma.user.create({ data: { name: 'Alice' } })
• update
  특정 레코드를 업데이트
  ex) prisma.user.update({ where: { id: 1 }, data: { name: 'Bob' } })
• delete
  특정 레코드를 삭제
• upsert
  특정 조건에 맞는 레코드가 없으면 새로 생성하고, 있으면 업데이트
• count
  레코드의 개수를 셀 때 사용
• aggregate
  여러 레코드의 필드를 합산, 평균 등을 구할 때 사용
• groupBy
  특정 필드별로 그룹화해서 데이터를 처리할 때 유용

 

🔎 prisma transaction

트랜잭션은 여러 데이터베이스 작업을 하나의 그룹으로 묶어, 해당 그룹의 작업이 모두 성공하거나 모두 실패하도록 보장하는 기능입니다.

const create = await prisma.$transaction([
  prisma.user.create({ data: { name: 'Kim' } }),
  prisma.post.create({ data: { title: 'Hello', desc: 'Hi' } }),
]);

$transaction API는 여러 데이터베이스 연산을 배열로 받아 트랜잭션으로 처리합니다.

예를 들어, 위와 같이 여러 쿼리를 하나의 트랜잭션으로 실행할 수 있습니다.

이 경우, 두 쿼리 중 하나라도 실패하면 전체 연산이 롤백됩니다.

 

📌 NestJS 다른 글

NestJS 프로젝트 시작과 구조의 이해

NestJS 프로젝트 시작과 구조의 이해

 

Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기

Docker로 PostgreSQL 설치하고 NestJS + prisma 연동하기