[Node.js] TypeORM로 CRUD 구현해 보기 (feat. MySQL)

안녕하세요 Foma 입니다.

 

저번 글에서 TypeORM이 무엇인지에 대해 다뤄 보았는데요.

 

이번 글에선 TypeORM으로 생성, 조회, 삭제, 수정을 다뤄보는 법에 대해서 작성해 보려고 합니다.

 

바로 시작할게요~

---

Init TypeORM

 

우선 typeORM을 사용하기 위해선 생성할 프로젝트 폴더에 typeorm 모듈을 설치해 주셔야 합니다.

 

 

npm install typeorm -g

 

아래와 같이 typeorm 프로젝트를 생성해 줍니다.

 

typeorm init --name 프로젝트 이름 --database 사용할 데이터베이스

 

그러면 아래와 같이 해당 경로에 프로젝트가 생성된 것을 볼 수 있을거에요.

 

 

해당 프로젝트를 VSCode로 켜보면 아래와 같이 몇 가지 폴더와 파일이 미리 생성되어 있는 것을 볼 수 있습니다.

 

---

Set a data-source

 

data-source.ts

 

해당 파일은 데이터 베이스를 연결 정보를 설정해 주는 공간입니다.

 

import "reflect-metadata";
import { DataSource } from "typeorm";
import { Chat } from "./entity/Chat";
import { User } from "./entity/User";

export const AppDataSource = new DataSource({
  type: "mysql",
  host: "localhost",
  port: 3306,
  username: "유저네임",
  password: "패스워드",
  database: "디비이름",
  synchronize: true,
  logging: false,
  entities: [User, Chat],
  migrations: [],
  subscribers: [],
});

---

Create entities

 

먼저 저는 User와 Chat 모델을 만들어 주도록 하겠습니다.

 

User.ts

 

@Entity() => 해당 Entity에 대한 정보를 정함.

 

@PrimaryGeneratedColumn() => Primary 키와 자동으로 생성되는 컬럼을 의미함.

 

@Column() => 일반적인 컬럼을 의미하며 괄호 사이에 제약 조건 등을 추가할 수 있음.

 

@OneToMany() => 일대다 관계를 맺는 것을 의미함. ex) 한 유저의 모든 채팅을 관계 맺음.

 

import { Entity, PrimaryGeneratedColumn, Column, OneToMany } from "typeorm";
import { Chat } from "./Chat";

@Entity({ name: "users" })
export class User {
  @PrimaryGeneratedColumn("uuid")
  id: string;

  @Column({ type: "varchar", length: 10 })
  firstName: string;

  @Column({ nullable: false })
  lastName: string;

  @Column()
  age: number;

  @OneToMany(() => Chat, (chat) => chat.user)
  chats: Promise<Chat[]>;
}

 

Chat.ts

 

@ManyToOne() => 다대일 관계를 맺는 것을 의미함. ex) 모든 채팅을 한 유저와 관계를 맺음.

 

import { Entity, PrimaryGeneratedColumn, Column, ManyToOne } from "typeorm";
import { User } from "./User";

@Entity({ name: "chats" })
export class Chat {
  @PrimaryGeneratedColumn("uuid")
  id: string;

  @Column({ type: "varchar", length: 100 })
  content: string;

  @ManyToOne(() => User, (user) => user.chats)
  user: Promise<User>;
}

---

Create a controller

 

유저 컨트롤러를 만들어 생성, 조회, 삭제, 수정 메서드를 만들어 주겠습니다.

 

import { AppDataSource } from "../data-source";
import { Chat } from "../entity/Chat";
import { User } from "../entity/User";
import { Request, Response } from "express";

export default class UserController { ...

 

Create(Insert)

 

firstName,lastName,age를 요청으로부터 받아 User 레포지토리에 넣어줍니다.

 

  addUser = async (req: Request, res: Response) => {
    let info = {
      firstName: req.body.firstName,
      lastName: req.body.lastName,
      age: req.body.age,
    };

    const userRepo = AppDataSource.getRepository(User);
    const user = userRepo.create(info);

    await userRepo
      .save(user)
      .then((data) => {
        res.json(data);
      })
      .catch((err) => console.log(err));
  };

 

Read(Get)

 

요청의 파라미터의 firstName을 가진 유저를 조회해 데이터를 가져옵니다.

 

  getUser = async (req: Request, res: Response) => {
    let name = req.params.firstName;
    const userRepo = AppDataSource.getRepository(User);

    await userRepo
      .findOne({ where: { firstName: name } })
      .then((data) => {
        res.json(data);
        console.log("Get User: ", data);
      })
      .catch((err) => console.log(err));
  };

 

Read(Get)

 

모든 유저를 가져옵니다.

 

  getAllUsers = async (req: Request, res: Response) => {
    const userRepo = AppDataSource.getRepository(User);

    await userRepo
      .findAndCount()
      .then((data) => {
        res.json(data);
        console.log("Get all User: ", data);
      })
      .catch((err) => console.log(err));
  };

 

Update

 

요청의 파라미터의 firstName을 가진 유저의 정보를 요청의 body로 수정해 줍니다.

 

  updateUser = async (req: Request, res: Response) => {
    const userRepo = AppDataSource.getRepository(User);

    await userRepo
      .createQueryBuilder()
      .update(User)
      .set(req.body)
      .where({ firstName: req.params.firstName })
      .execute()
      .then((data) => {
        res.json(data);
        console.log("Update User: ", data);
      })
      .catch((err) => console.log(err));
  };

 

Delete

 

요청의 파라미터의 firstName을 가진 유저를 삭제해 줍니다.

 

  deleteUser = async (req: Request, res: Response) => {
    const userRepo = AppDataSource.getRepository(User);

    await userRepo
      .createQueryBuilder()
      .delete()
      .from(User)
      .where({ firstName: req.params.firstName })
      .execute()
      .then((data) => {
        res.json(data);
        console.log("Delete User: ", data);
      })
      .catch((err) => console.log(err));
  };

---

Set a router

 

UserController 기반으로 라우터를 만들어 줍니다.

 

import * as express from "express";
import UserController from "../controllers/UserController";

const userRouter = express.Router();

let userController = new UserController();

userRouter.post("/addUser", userController.addUser);

userRouter.get("/user/:firstName", userController.getUser);

userRouter.get("/allUsers", userController.getAllUsers);

userRouter.put("/user/:firstName", userController.updateUser);

userRouter.delete("/user/:firstName", userController.deleteUser);

export default userRouter;

---

Run the server

 

index.ts

 

userRouter를 express app에 세팅해주고 포트를 3000번으로 실행 시켜줍니다.

 

import { AppDataSource } from "./data-source";
import * as express from "express";
import userRouter from "./routers/UserRouter";

const app = express();
app.use(express.json());

AppDataSource.initialize()
  .then(async () => {})
  .catch((error) => console.log(error));

app.use("/api", userRouter);
app.listen(3000, () => {
  console.log("Server running");
});

---

Test

 

addUser

 

//POST
http://localhost/api/addUser

//JSON
{
    "firstName":"foma",
    "lastName":"gran",
    "age":27
}

 

 

getUser

 

//GET
http://localhost/api/user/foma

 

 

getAllUsers

 

//GET
http://localhost/api/allUsers

 

 

updateUser

 

//PUT
http://localhost/api/user/foma

//JSON
{
    "firstName":"fomaaa",
    "lastName":"grannnn",
    "age":27
}

 

deleteUser

 

//DELETE
http://localhost/api/user/fomaaa