[NodeJS] Sequelize + Typescript

💖 Sequelize

• Node.js의 ORM 라이브러리
• 자바스크립트 객체와 데이터베이스의 릴레이션을 매핑해준다
• MySQL, PostgreSQL, MariaDB 등 많은 RDBMS를 지원한다

ORM (Object Relational Mapping)
: 객체와 관계를 매핑해주는 것

💖 TS에서 사용하기

sequelize를 사용하는 방법도 있지만 여기서는 sequelize-typescript를 사용할 것이다

We recommend using sequelize-typescript to bridge the gap until our improvements are ready to be released.

-- sequelize 공식문서 발췌

1. 설치

npm install --save-dev @types/node @types/validator
npm install sequelize reflect-metadata sequelize-typescript

2. 설정

📝 tsconfig

"target": "es6",
"experimentalDecorators": true,
"emitDecoratorMetadata": true

📝 connection

// db_config.ts
import dotenv from "dotenv";

dotenv.config(); // .env 파일의 환경 변수를 로드

const { DB_HOST, DB_USER, DB_PASSWORD, DB_DATABASE } = process.env;

const db_config = {
  dialect: "mysql" as const, // TypeScript에게 해당 값이 변경되지 않음을 알려줌
  host: DB_HOST,
  username: DB_USER,
  password: DB_PASSWORD,
  database: DB_DATABASE,
  timezone: "+09:00",	// 한국시간
};

export default db_config;


// connection.ts
import { Sequelize } from "sequelize-typescript";
import db_config from "../config/db_config";

const sequelize = new Sequelize({
  ...db_config,
  models: [__dirname + "/*Model.ts"],
  modelMatch: (filename, member) => {
    return filename.substring(0, filename.indexOf("Model")) === member;
  },
});

export default sequelize;


// index.ts
app.listen(app.get("port"), async () => {
  console.log("Express server listening on port " + app.get("port"));

  // 연결 테스트
  try {
    await sequelize.authenticate();
    console.log("Connection has been established successfully.");
  } catch (error) {
    console.error("Unable to connect to the database:", error);
  }
});

3. Model

• sequelize의 핵심
• 데이터베이스에서 테이블을 추상화한 것
• 데이터베이스 테이블과의 상호작용을 담당한다
• entity가 나타내는 것들(데이터베이스의 테이블 이름, 데이블 컬럼 등)을 알려준다
• model의 이름은 데이터베이스의 테이블 이름과 일치하지 않아도 된다
• sequelize-typescript에서는 데코레이터를 이용하여 모델을 정의할 수 있다

// userModel.ts
import { Table, Column, Model, DataType, HasMany } from "sequelize-typescript";

@Table({ tableName: "user" })
export class User extends Model {
  @Column({
    type: DataType.INTEGER,
    autoIncrement: true,
    primaryKey: true,
  })
  id!: number;

  @Column({
    type: DataType.STRING,
    allowNull: false,
  })
  email!: string;

  @Column({
    type: DataType.STRING,
    allowNull: false,
  })
  name!: string;

  @Column({
    type: DataType.STRING,
    allowNull: false,
  })
  password!: string;

  @Column({
    type: DataType.DATE,
    allowNull: false,
  })
  createdAt!: Date;

  @Column({
    type: DataType.DATE,
    allowNull: false,
  })
  updatedAt!: Date;

  @Column({
    type: DataType.BOOLEAN,
    allowNull: false,
  })
  del!: boolean;

 @HasMany(() => Friend)
  friends!: Friend[]; // User, Friend -> 1:N 관계 설정
}

// friendModel.ts
import {
  Table,
  Column,
  Model,
  DataType,
  ForeignKey,
} from "sequelize-typescript";
import { User } from "../models/userModel";

@Table({ tableName: "friends" })
export class Friend extends Model {
  @ForeignKey(() => User)
  @Column({
    type: DataType.INTEGER,
    allowNull: false,
  })
  user_id!: number;

  @Column({ type: DataType.INTEGER })
  friend_id!: number;

  @Column({
    type: DataType.BOOLEAN,
    allowNull: false,
    defaultValue: 0,
  })
  status!: boolean;
}

4. Migration, Seeder

sequelize init으로 디렉토리를 생성하지 않은 경우 sequelize-cli명령어를 사용할 때 경로를 파악할 수 없다 -> .sequelizerc 와 같은 설정 파일을 통해 경로를 매칭시켜주어야 한다

📝 Migration

• 소스 코드를 관리하는 Git과 같은 버전 제어 시스템
• 데이터베이스의 변경 사항을 추적할 수 있다
• 기존 데이터베이스를 다른 상태로 또는 그 반대로 전송할 수 있다

📝 Seeder

• 서버가 시작될 때 애플리케이션이 가지고 있어야 할 정적인 데이터들을 DB에 추가해준다

Sequelize-cli를 사용하기 위한 준비

설치

npm i @babel/core @babel/register @babel/preset-env @babel/preset-typescript @babel/runtime @babel/plugin-transform-runtime typescript

babel 설정

.babelrc 혹은 babel.config.json 파일에 설정 추가

{
  "presets": ["@babel/preset-env", "@babel/preset-typescript"],
  "plugins": ["@babel/plugin-transform-runtime"]
}

sequelizerc

// .sequelizerc
// Sequelize CLI가 실행되는 동안 TypeScript 파일을 인식하고 컴파일할 수 있도록 설정하기 위함
require("@babel/register")({
  configFile: "./.babelrc",
  extensions: [".js", ".ts"],
});

const path = require('path');

module.exports = {
  'config': path.resolve('config', 'config.js'),	// 확장자는 json 혹은 js
  'models-path': path.resolve('db', 'models'),
  'seeders-path': path.resolve('db', 'seeders'),
  'migrations-path': path.resolve('db', 'migrations')
};

참고할 것
https://www.npmjs.com/package/sequelize-cli
https://hoontae24.github.io/17

++ 추가사항

model파일에서 다음과 같은 오류 발생

  @Column({
                                       ^
TypeError: Cannot convert undefined or null to object

tsconfig.json에 설정을 추가해주면 된다

 {
  "compilerOptions": {
    "experimentalDecorators": true, // 데코레이터 문법 사용 허용
    "emitDecoratorMetadata": true // 데코레이터 메타데이터 생성
  }
}

Reference

npm sequelize-typescript
sequelize 공식 문서
https://stackoverflow.com/questions/76105765/typeerror-in-sequelize-typescript-model