Sequelize.js 적용

• 들어가는 말
• ORM을 왜 사용하는가?
• Sequelize.js 설치
• 준비 작업
• 테이블 정의
• 모델 정의
• 웹 어플리케이션 시작 시 자동 실행
• 실행 확인
• 맺음말

들어가는 말

앞서 VM에 MariaDB를 설치했고 Express 프로젝트를 생성했다. 이번에는 사용자 정보나 상점, 친구, 결제 등 주요한 정보를 저장하게되는 MariaDB에 Node.js에서 어떻게 접근하여 다루는지 살펴보자.

ORM을 왜 사용하는가?

관계형 데이터베이스(Relational Database, RDB)¹를 사용하면 데이터베이스의 데이터를 조회 및 조작하기 위해서 SQL ² 를 작성한다. 간단한 SQL 문장을 작성하는 것이야 어렵지 않지만 사용하는 언어와 사용되는 데이터베이스에 따라서 특성이 있어서 불편한 점이 많다.

그래서 등장한 것이 ORM(Object-relational mapping)이다. ORM은 통역으로 생각하면된다. 프로그래밍 언어로 직접 데이터베이스에 말할 수 없으니 중간에 통역인 ORM이 데이터베이스가 알아들을 수 있는 언어(SQL 등)로 번역하여 전달하는 것이다.

Node.js의 ORM은 Sequelize.js, Bookshelf.js, node-orm2 등이 있다. 여기서는 Sequelize.js를 사용하도록 한다.

Sequelize.js 설치

커맨드라인 툴로 myapp 프로젝트가 위치한 폴더에서 아래와 같이 입력한다.

npm install --save sequelize
npm install --save mysql

Sequelize.js는 ORM으로 필요하고 mysql은 Sequelize.js로 MySQL, MariaDB를 다루기 위해서 필요한 모듈이다.

(앞에서도 말했지만 osx의 경우 인스톨이 진행되지 않으면 앞에 sudo를 붙여서 명령한다.)

준비 작업

• MariaDB에 사용할 데이터베이스를 생성한다.

1. 생성해둔 VM을 vagrant up 명령으로 실행한다.
2. http://localhost:8080/phpmyadmin 주소로 접속한다. (Username : root, Password : 1234)
3. phpMyAdmin으로 Databaes 탭을 클릭 한 후 myapp 데이터베이스 생성를 생성한다.

• myapp 프로젝트에 config 폴더를 생성 한 후 config.json파일을 작성한다.

	.
	├── config
	│   └── config.json

config.json의 내용은 아래와 같다.

{
  "development": {
    "username": "root",
    "password": "1234",
    "database": "myapp",
    "host": "localhost",
    "port": 6306,
    "dialect": "mariadb",
    "pool": { "max": 5, "min": 0, "idle": 10000 }
  }
}

위 내용은 express 웹 어플리케이션이 MariaDB에 접속할 때 사용할 설정이다.

• 프로젝트에 models 폴더를 추가한 후 index.js 파일을 생성한다.

	.
	├── models
	│   └── index.js

index.js의 내용은 아래와 같다.

index.js의 내용을 살펴보자. 8번째 줄에서 sequelize 변수로 데이터베이스에 접속한다. 그리고 11~19번쨰 줄에서 models 폴더의 파일을 모두 읽어서 db변수에 연결한다. 마지막으로 30번째 줄에서 db를 module.exports에 할당하여 모듈로써 models 폴더가 작동할 수 있도록 한 것이다.

말이 길었지만 정리하면 곧 models 폴더가 모듈이 된 것이다. ³

테이블 정의

앞에서 데이터베이스를 활용하기 위한 모든 준비가 마쳐졌다. 이제 사용할 테이블을 정의해보도록 하자.

저장하고같은게임에서 사용자 정보를 저장하는 테이블을 만든다고 해보자. 사용할 ID와 보석, 코인, 하트같은 게임 내 정보를 담게 된다. 최상위 점수라던가 로그인 시간도 추가한다.

테이블을 정의할 때 어떤 데이터타입(Data types)이 있는지는 링크를 확인하기 바란다.

모델 정의

위 표와 같이 정의된 테이블을 Sequelize를 사용해서 model과 맵핑해보자. 기본 구조는 간단하다.

module.exports = function(sequelize, DataTypes) {
  var _yourTableName = sequelize.define('모델명', { /* 특성 */ }, { /* 옵션 */ });
  return _yourTableName;
};

usercore 테이블에 사용될 모델명과 특성을 추가해보자.

12번째 줄의 timestamps는 true가 기본 값이다. 이를 허용하면 createdAt과 updatedAt 컬럼이 자동으로 추가된다.

13번째 줄의 tableName은 모델명을 기준으로 자동으로 작성되는 이름대신 직접 지정한 테이블명을 사용할 수 있게 해준다.

usercore에서 특성을 정의할 때 사용된 값은 아래와 같다.

더 자세한 사항은 공식문서를 참고하자.

위와 같은 내용을 models 폴더의 usercore.js을 생성하여 추가한다.

.
├── models
│   └── index.js
│   └── usercore.js

웹 어플리케이션 시작 시 자동 실행

마지막 단계로 웹 어플리케이션이 시작할 때 models를 작동하도록 해야한다. 처음에 한번 연결해두면 작동하는 동안에는 추가적인 연결이 없기때문에 편리하다.

해당 내용이 추가되어야하는 곳은 bin/www파일이다. 해당 내용 중 추가한 부분을 요약하면 아래와 같다. ⁴

8번째 줄에서 models 폴더를 모듈로써 읽어드린 후 21번째 줄에서 sequelize.sync()메서드를 실행힌다. 해당 과정을 끝내면 22번째 줄에서 설정된 포트를 통해서 통신이 가능하도록 설정한 것이다.

실행 확인

이제 잘 작동하는지 확인해보자. 커맨드라인 툴에서 아래와 같이 입력한 후 브라우저에서 http://localhost:3000/phpmyadmin으로 접속한다.

node bin/www

커맨드라인 툴에는 아래와 같은 내용이 표시될 것이다.

Executing (default): CREATE TABLE IF NOT EXISTS `usercore` (`no` INTEGER UNSIGNED , `id` VARCHAR(14), `gems` INTEGER(6) UNSIGNED DEFAULT 0, `coins` INTEGER UNSIGNED DEFAULT 0, `hearts` INTEGER(4) UNSIGNED DEFAULT 0, `highScore` INTEGER UNSIGNED DEFAULT 0, `loginTime` INTEGER(10) UNSIGNED DEFAULT 0, PRIMARY KEY (`no`)) ENGINE=InnoDB;
Executing (default): SHOW INDEX FROM `usercore` FROM `myapp`

해당 내용은 정의한 내용에 따라서 테이블을 생성하는 SQL 쿼리문이다.

브라우저를 통해 phpmyadmin에 접속하면 myapp 데이터베이스에 usercore테이블이 생성된 것을 확인할 수 있다.

맺음말

긴 설명을 통해 Sequelize.js를 myapp 웹 어플리케이션에 적용했다. 다음 시간부터는 기능을 구현하도록 하겠다.

참고로 이 내용은 Sequelize에서 공식적으로 제공하는 예제에 자세히 설명된 것을 필요한 부분만 발췌하여 적용한 것이다. 더 자세히 알고 싶다면 express-sample 레포지토리를 확인하기 바란다.