[Node.js] Sequelize로 C.R.U.D 구현해 보기 (feat. MySQL)

안녕하세요 Foma 입니다!

 

오늘은 저번 Sequelize 이론 글에 이어서 C.R.U.D를 직접 구현해 보도록 하겠습니다.

 

(혹시 저번 글을 안보신 분들을 여기 에서 확인해 주세요)

 

바로 시작할게요~

---

Install

 

express

 

npm install --save express

 

cors

 

npm install --save cors

 

sequelize

 

npm install --save sequelize

 

mysql2

 

npm install --save mysql2

---

Sequelize init

 

sequelize init

 

Sequelize를 init 해주면 자동으로 config, migrations, models, seeders 이렇게 4개의 폴더가 생길거에요.

 

이번 글에서는 seeders는 이용되지 않으니 삭제해 줍니다.

 

 

config.json

 

config.json으로 가면 아래와 같이 되어 있을거에요.

 

여기는 데이터 베이스의 정보를 입력하는 곳입니다.

 

이번 글에선 test와 production은 사용되지 않으니 삭제해주고, 알맞는 데이터베이스 정보를 입력해 줍니다.

 

{
  "development": {
    "username": "유저이름",
    "password": "패스워드",
    "database": "데이터베이스이름",
    "host": "127.0.0.1",
    "dialect": "mysql"
  }
}

 

models/index.js

 

아래와 같이 데이터베이스를 연결해 주세요.

 

const { Sequelize, DataTypes } = require("sequelize");
const env = process.env.NODE_ENV || "development";

const config = require("../config/config.json")[env];

const db = {};

const sequelize = new Sequelize(
  config.database,
  config.username,
  config.password,
  config
);

db.Sequelize = Sequelize;
db.sequelize = sequelize;

sequelize
  .sync({ force: false })
  .then(() => {
    console.log("데이터베이스 연결됨.");
  })
  .catch((err) => {
    console.error(err);
  });

module.exports = db;

 

app.js

 

app.js 파일을 생성하고 제대로 데이터 베이스가 연결되었는지 테스트 해봅니다.

 

const express = require("express");
const cors = require("cors");
const app = express();

var corOptions = {
  origin: "https://localhost:3000",
};

app.set("port", process.env.PORT || 3000);

app.use(cors(corOptions));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));

require("./models/index");

app.get("/", (req, res) => {
  res.json({ message: "hello world" });
});

app.listen(app.get("port"), () => {
  console.log(app.get("port"), "번 포트에서 대기 중");
});

 

app.js를 실행 시켜보면

 

node app.js

 

아래와 같이 정상적으로 데이터 베이스가 연결되는 것을 볼 수 있습니다.

 

---

Create a table

 

//npx sequelize migration:create --name 테이블이름
npx sequelize migration:create --name Users

 

아래와 같이 migrations 폴더에 현재 날짜와 지정해준 테이블 이름을 가진 파일이 생성된 것을 볼 수 있습니다.

 

 

해당 파일엔 아래와 같이 작성되어 있는데요.

 

up

logic for transforming into the new state

새로운 어떤 상태로 변화시킬 로직을 작성

 

down

logic for reverting the changes

변화를 다시 되돌릴 때의 로직을 작성

 

이라고 공식 문서에 나타나 있습니다.

 

module.exports = {
  async up (queryInterface, Sequelize) {
  },

  async down (queryInterface, Sequelize) {
  }
};

 

아래와 같이 up에 Users 테이블을 생성해 주는 코드를 작성하겠습니다.

 

컬럼으론 id,username,password를 만들어 주겠습니다.

 

down엔 생성한 Users 테이블을 삭제하는 코드를 작성하겠습니다.

 

module.exports = {
  async up(queryInterface, Sequelize) {
    queryInterface.createTable("Users", {
      id: {
        type: Sequelize.INTEGER(11),
        allowNull: false,
        autoIncrement: true,
        primaryKey: true,
      },
      username: Sequelize.STRING(35),
      password: {
        type: Sequelize.STRING(20),
        allowNull: false,
      },
    });
  },

  async down(queryInterface, Sequelize) {
    queryInterface.dropTable("Users");
  },
};

---

Migrate

 

아래 명령어를 쳐서 위에서 테이블을 생성하는 코드를 데이터 베이스에 직접 마이그레이트 해줍니다.

 

up 로직을 실행하는 것과 같습니다.

 

(마이그레이트는 변경 사항을 데이터 베이스에 적용하는 것이라고 이해하시면 됩니다.)

 

sequelize db:migrate

 

아래와 같이 config.json 파일을 loaded 해 migrate를 진행합니다.

 

 

데이터 베이스로 이동하시면 config.json에 설정한 데이터베이스의 users 테이블과 id,username,password 컬럼들이 생성된 것을 볼 수 있습니다.

 

 

만약 migrate를 다시 되돌리고 싶다면 undo 명령어를 입력해 줍니다.

 

undo를 입력하면 down 로직이 실행되어 테이블이 삭제됩니다.

 

sequelize db:migrate:undo

 

테이블이 삭제된 것을 볼 수 있습니다.

 

 

 

방금 undo 명령어는 바로 이전에 실행된 migrate를 되돌리는 것인데요.

 

지금까지 한 모든 명령을 되돌리고 싶다면 undo:all을 입력해 주시면 됩니다.

 

sequelize db:migrate:undo:all

---

Create a model

 

models 폴더에 User.js 파일을 만들어 줍니다.

 

 

테이블을 생성할 때와 같이 작성해 줍니다.

 

다만 자동으로 createdAt, updatedAt 생성을 하지 않도록 timestamp: false로 설정해 줍니다.

 

module.exports = (sequelize, DataTypes) => {
  const User = sequelize.define(
    "User",
    {
      id: {
        type: DataTypes.INTEGER(11),
        allowNull: false,
        autoIncrement: true,
        primaryKey: true,
      },
      username: DataTypes.STRING(35),
      password: {
        type: DataTypes.STRING(20),
        allowNull: false,
      },
    },
    {
      timestamps: false,
    }
  );
  return User;
};

---

Create a controller

 

이제 User 테이블에 생성, 삽입, 수정, 삭제를 진행할 Controller를 만들어 줍니다.

 

 

models 폴더의 index.js에 가서 db에 users를 추가해 줍니다.

 

db.users = require("./User.js")(sequelize, DataTypes);

 

다시 UserController로 돌아와서 User를 정의해 줍니다.

 

const db = require("../models");

const User = db.users;

 

Create

 

const addUser = async (req, res) => {
  let info = {
    username: req.body.username,
    password: req.body.password,
  };

  const user = await User.create(info).catch((err) => console.log(err));
  res.status(200).send(user);
};

 

Read

 

const getAllUsers = async (req, res) => {
  let users = await User.findAll({}).catch((err) => console.log(err));
  res.status(200).send(users);
};

const getUser = async (req, res) => {
  let id = req.params.id;
  let user = await User.findOne({ where: { id: id } }).catch((err) =>
    console.log(err)
  );
  res.status(200).send(user);
};

 

Update

 

const updateUser = async (req, res) => {
  let id = req.params.id;
  const user = await User.update(req.body, { where: { id: id } }).catch((err) =>
    console.log(err)
  );
  res.status(200).send(user);
};

 

Delete

 

const deleteUser = async (req, res) => {
  let id = req.params.id;
  await User.destroy({ where: { id: id } }).catch((err) => console.log(err));
  res.status(200).send("User is deleted");
};

 

위 함수들을 exports 해줍니다.

 

module.exports = {
  addUser,
  getAllUsers,
  getUser,
  updateUser,
  deleteUser,
};

---

Create a router

 

UserRouter.js 파일을 만들고

 

각 기능별로 라우터를 만들어 줍니다.

 

const userController = require("../controllers/userController.js");

const router = require("express").Router();

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

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

router.get("/:id", userController.getUser);

router.put("/:id", userController.updateUser);

router.delete("/:id", userController.deleteUser);

module.exports = router;

---

 

Set a UserRouter

 

다시 app.js로 돌아가서 아래 부분을

 

require("./models/index.js");

 

라우터로 대체해 줍니다.

 

const router = require("./routers/UserRouter.js");
app.use("/api", router);

 

그 다음 다시 서버를 실행시켜 줍니다.

 

node app.js

---

Test

 

Postman을 이용하여 api를 테스트 해보겠습니다.

 

Postman API Platform | Sign Up for Free

 

POST(Create)

 

addUser에 username과 password를 json 형식으로 작성해 post 요청을 보내 유저를 생성해 보겠습니다.

 

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

 

GET(Read)

 

위에서 생성한 유저가 제대로 들어갔는지 allUsers로 get 요청을 보내 유저 데이터를 모두 받아와 보겠습니다.

 

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

 

아래와 같이 정상적으로 추가한 유저가 있는 것을 확인할 수 있습니다.

 

 

PUT(Update)

 

id가 1인 유저의 username을 kalid로 변경해 PUT으로 업데이트 해보겠습니다.

 

//PUT
http://localhost:3000/api/1

 

 

GET

 

id가 1인 유저의 정보를 받아오면 username이 kalid로 바뀌어 있는 걸 볼 수 있습니다.

 

//GET
http://localhost:3000/api/1

 

DELETE

 

id가 1인 유저를 Delete 해줍니다.

 

//DELETE
http://localhost:3000/api/1

마지막으로 모든 유저를 보면 삭제가 정상적으로 된 것을 볼 수 있습니다.

 

---

Reference

 

• https://www.youtube.com/watch?v=pxo7L5nd1gA
• https://sequelize.org/   
• https://www.youtube.com/watch?v=tpso18ghda4