🔥TIL #4. prisma 설치 및 node.js와 연동

🌟 Today I learned

1. prisma 란?
2. prisma 설치 및 설정방법
   1. project 초기 세팅
   2. prisma folder 생성
   3. 연결할 database 정보 설정
   4. 연결하기
   5. prisma client 설치 및 생성
3. prisma로 data read, create 해보기

1. prisma

prisma란 node.js 와 Typescript를 위한 현시점 최신 트렌드의 ORM(Object Relational Mapping) open source 기술이다. (기존 ORM기술로는 Sequelize, typeORM 이 있다.)
prisma는 Heroku 창업자와 Graphql 개발자가 합작하여 만든 기술이기에 특히 Graphql과 잘 맞는다. Graphql 도입을 고려한다면 prisma를 선택하는 것이 좋다.

2. prisma 설치 및 설정방법

1. project 초기 세팅

   먼저 해야 하는것은 Node.js project 초기설정이다.

   npm init -y # package.json 생성
   npm i @prisma/cli --save-dev # prisma command line interface 설치

2. prisma folder 생성

   prisma 를 node.js와 연결하려면 우선 prisma schema 파일과 env 파일을 만들어야 한다.
   아래 명령을 실행해보자.

   npx prisma init

   (npx는 npm v5.2.2 이상부터 지원하는 기능으로 조금더 패키지 관리를 쉽게 해주는 것이 주 목적이다. npx는 차후 상세히 알아보자.)

   위 명령을 실행하면 실행한 경로상에 'prisma' 폴더가 생성되고 그 안에는 'schema.prisma'이 생성된다. 그리고 'prisma' 폴더와 동일 경로에 .env 파일이 생성된다.

   schema.prisma : migration된 Database table schema가 정의되는 파일(prisma 핵심)
   .env : Database 접속을 위한 환경변수를 설정하는 숨김 파일.

3. 연결할 database 정보 설정

   prisma/schema.prisma 파일을 열면 아래와 같은 코드가 나온다.

   //This is your Prisma schema file,
   //learn more about it in the docs: https://pris.ly/d/prisma-schema
   
   datasource db {
     provider = "postgresql"  // 여기를 mysql로 변경
     url      = env("DATABASE_URL")
   }
   
   generator client {
     provider = "prisma-client-js"
   }```

   db의 provider가 default로 'postgresql'로 되어있다. 이를 'mysql'로 변경해야 한다.
   그 다음 .env 파일을 열어보자

   // prisma/schema.prisma
   
   // Environment variables declared...
   // See the documentation for more detail: ...
   
   // Prisma supports the native connection...
   // See the documentation for all the connection string options:...
   
   DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb?schema=public"```

   .env의 'DATABASE_URL'에 [연결할 sql 모델과 계정, 패스워드, 사용할 database] 정보를 넣어줘야 한다. node project를 위해 생성한 database 기준으로 수정한다.

   // .env
   
   DATABASE_URL="mysql://node_blogs_user:{패스워드}@localhost:3306/node_blogs?schema=public"```

4. 연결하기

   prisma는 최신 기술이다보니 아직 schema를 기준으로 실제 Table을 만드는 것은 취약한 듯 하다. 해서 prisma 연동을 위해선 dbdiagram.io 같은 tool을 이용해 모델링한 데이터를 sql파일로 export하여 database에 import 하는 과정이 먼저 필요하다.
   준비가 되었다면 아래 명령을 실행하자.

   npx prisma introspect
   
   // 이 명령어는 .env 파일에서 환경변수로 작성한 DATABASE_URL 에 접속해서 
   // 데이터베이스의 테이블 스키마를 검사한 후, schema.prisma 파일에 모델을 작성한다.```

   실행이 완료되면 prisma/schema.prisma 에는 아래코드처럼 타켓 database의 정보가 추가된다.

   // prisma/schema.prisma
   
   generator client {
     provider = "prisma-client-js"
   }
   
   datasource db {
     provider = "mysql"
     url      = env("DATABASE_URL")
   }
   
   model articles {
     id         Int             @id @default(autoincrement())
     user_id    Int
     title      String
     body       String
     status     articles_status @default(DRAFT)
     created_at DateTime?       @default(now())
     updated_at DateTime?
     deleted_at DateTime?
     users      users           @relation(fields: [user_id], references: [id])
     comments   comments[]
   
     @@index([user_id], name: "user_id")
   }
   
   model comments {
     id         Int       @id @default(autoincrement())
     article_id Int
     user_id    Int
     body       String
     created_at DateTime? @default(now())
     updated_at DateTime?
     deleted_at DateTime?
     articles   articles  @relation(fields: [article_id], references: [id])
     users      users     @relation(fields: [user_id], references: [id])
   
     @@index([article_id], name: "article_id")
     @@index([user_id], name: "user_id")
   }
   
   model users {
     id         Int          @id @default(autoincrement())
     email      String       @unique
     password   String
     status     users_status @default(ACTIVE)
     created_at DateTime?    @default(now())
     updated_at DateTime?
     deleted_at DateTime?
     articles   articles[]
     comments   comments[]
   }
   
   enum articles_status {
     DRAFT
     PUBLISHED
     DELETED
   }
   
   enum users_status {
     ACTIVE
     INACTIVE
   }```

5. prisma client 설치 및 생성

   // 먼저 client 노드 모듈 패키지 설치
   npm install @prisma/client
   
   npx prisma generate
   
   // 이 명령어는 npx prisma introspect 명령어를 통해서 생성된 schema.prisma 파일을 읽어서
   // node_modules/@prisma/client 폴더 안에 우리가 사용할 prisma client 코드를 생성 해 준다.```

3. prisma로 data read, create 해보기

prisma로 mysql의 node_blogs database와 mapping이 되었다. 이제 node 상에서 이를 이용해 table을 제어해보자.

const bcrypt = require('bcryptjs')
const jwt = require('jsonwebtoken')
const {PrismaClient} = require('@prisma/client')
const prisma = new PrismaClient()

// SignUp (회원가입)
// 1. 요청자가 email, password 등의 회원 정보를 보내면 이를 받아 User table에 추가
app.post('/users/signup', (req, res) => {
	const {email, password} = req.body
    	const hashedPassword = bcrypt.hash(password, 10)
    	const createdUser = await prisma.users.create({
      	data : {
	        email,
	        password: hashedPassword,
	      }
	    })

        res.status(201).json({createdUser})
})

// LogIn 
// 1. 요청자의 email, password 체크
app.post('/users/login', async (req, res) => {
  try {
    const { email, password: inputPassword } = req.body
    const foundUser = await prisma.users.findOne({ where: { email } })

    if (!foundUser) {
      const error = new Error('invalid input')
      error.statusCode = 400
      throw error
    }

    const { id, password: hashedPassword } = foundUser
    const isValidPassword = await bcrypt.compare(inputPassword, hashedPassword)

    if (!isValidPassword) {
      const error = new Error('invalid input')
      error.statusCode = 400
      throw error
    }

    const token = jwt.sign({ id }, 'node_blogs_secret_key', { expiresIn: '1h' })
    res.status(200).json({ message: 'login success', token })
  } catch (err) {
    res.status(err.statusCode).json({ message: err.message })
  }
})```

위 처럼 prisma 객체를 통해 model을 접근 및 제어 할 수 있다.