8.7 sequelize 사용 환경 설정 변경(useable multiple database in sequelize)

사용하다보니 몇 가지 문제점이 있어서 해결방법은 추후에 업데이트하도록 하겠습니다.

 

원래는 혼자 공부목적으로 쓰다가 실무에서 적용하려다보니 기존에 쓰던 구조에서 변경의 필요성의 느껴졌습니다. 이유는 다음과 같습니다.

 

1. 상용과 개발환경에 따라 사용하는 데이터베이스가 다릅니다.
2. 하나의 프로그램에서 필요에 여러개의 데이터베이스 접근이 가능해야합니다.
3. 개발서버DB와 상용서버DB가 완벽하게 일치하지 않기 때문에 entity 생성도 별개로 되어야합니다.

이전 챕터까지 진행했다면 sequelize 문법 사용이 가능한 js 파일들 (보통 entity라고 하는 것 같습니다.) 이 생성되었을 겁니다. 하지만 위와같은 제약사항을 해결해야한다면 index.js 파일부터 sequelize-auto 모듈을 사용하여 entity를 생성하는 js 파일도 수정이 필요합니다.

 

지금부터 쓰는 코드는 기존과 다른 환경에서 작성되는 코드이므로 파일경로나 DB명은 전혀 다릅니다. 일단 디렉토리 구조는 이렇습니다.

_DEV이 붙는 디렉토리는 개발서버용 데이터베이스라고 생각하면 됩니다. 그와 반대로 _DEV가 없으면 상용서버 데이터베이스인거죠. sequelize 커넥션을 반환하는 index.js 코드는 multiple database connection를 가능하게 하기위해 바뀐 부분이 있습니다.

 

'use strict';

var fs        = require('fs');
var path      = require('path');
var Sequelize = require('sequelize');
var basename  = path.basename(__filename);
var env       = process.env.NODE_ENV;
var config = {};
var db = {};

if (process.env.BY_LOCAL) {
  config = require(__dirname + '/../../../../config/sequelize.local.json')[env];
} else {
  config = require(__dirname + '/../../../../config/sequelize.json')[env];
}

/* Add Databases */
const databases = Object.keys(config.databases);
for(let i=0; i < databases.length; i++) {
  let database = databases[i];
  let dbPath = config.databases[database];
  db[database] = new Sequelize(dbPath.database, dbPath.username, dbPath.password, dbPath);
}

fs
  .readdirSync(__dirname + `/${databases[0]}`)
  .filter(file => 
      (file.indexOf('.') !== 0) &&
      (file !== basename) && 
      (file.slice(-3) === '.js'))
  .forEach(file => {
    const model = db[`${databases[0]}`].import(path.join(__dirname + `/${databases[0]}`, file));
    db[model.name] = model;
 });

//  Add models from database  

 fs
  .readdirSync(__dirname + `/${databases[1]}`)
  .filter(file => {
      (file.indexOf('.') !== 0) &&
      (file !== basename) && 
      (file.slice(-3) === '.js');
  })
  .forEach(file => {
    const model = db[`${databases[1]}`].import(path.join(__dirname + `/${databases[1]}`, file));
    db[model.name] = model;
 });

Object.keys(db).forEach(modelName => {
  if (db[modelName].associate) {
    db[modelName].associate(db);
  }
});

module.exports = db;

일단 지금부터는 process.env를 이용하여 현재 환경이 개발환경인지 상용환경인지 구분하는 로직이 추가됩니다. 저는 추가적으로 localhost 환경까지 구분해야하는 부분이 필요했어서 BY_LOCAL이라는 환경변수를 개인적으로 추가해서 분기처리했습니다만, 보통은 development와 product만을 구분하여 사용하곤 합니다.

 

기존에 코드에서 여러 개의 데이터 베이스를 사용하려는 구문만 추가되었습니다.

sequelize.json 파일은 아래와 같은 형식으로 작성하였습니다.

{
	"development": {
		"logging": true,
		"databases": {
			"SEASON3_DEV": 
			{
				"acquireTimeout": 5000,
				"connectionLimit" : 30,
				"timezone": "+09:00",
				"charset": "utf8mb4",
				"database": "SEASON3_DEV",
				"username": "유저네임",
				"password": "비밀번호",
				"host": "localhost",
				"port": "포트번호",
				"dialect": "mysql",
				"define":{
					"timestamps" : false,
					"underscored" : false
				}
			},
			"STORE_DEV": 
			{
				"acquireTimeout": 5000,
				"connectionLimit" : 30,
				"timezone": "+09:00",
				"charset": "utf8mb4",
				"database": "STORE_DEV",
				"username": "유저네임",
				"password": "비밀번호",
				"host": "localhost",
				"port": "포트번호",
				"dialect": "mysql",
				"define":{
					"timestamps" : false,
					"underscored" : false
				}
			}
		}
	},

	"production": {
		// 위와 같은 구조입니다.
	}
}

Object.keys() 를 사용하여 사용하려는 DB config 정보를 뽑아오는 것밖에 없습니다. 그리고 exports되는 db 모듈은 각각 데이터베이스마다 해당되는 디렉토리의 entity 파일을 참조하게끔 만들었습니다.

 

그럼 sequelize-auto 모듈을 사용하여 entity를 만드는 js 파일도 수정이 필요하게 됩니다. 이 부분은 제가 상황이 좀 급했어서 당장은 좀 불편하게 만들었습니다만, 추후에 수정하려고합니다.

 

const async = require('async');
const sequelizeAuto = require('sequelize-auto');
const model = require('../src/backend/model/entity');
const env = process.env.NODE_ENV;
let config = {};
if (process.env.BY_LOCAL) {
    config = require('../config/sequelize.local.json')[env];
} else {
    config = require('../config/sequelize.json')[env];
}

let db = [];
/* Add Databases */
Object.keys(config.databases).map(v=>{
    db.push({
        DATABASE: config.databases[v].database,
        USERNAME: config.databases[v].username,
        PASSWORD: config.databases[v].password,
        HOST: config.databases[v].host
    })
})

const tasks = [
    //테이블 목록 가져오기 (DB 분기 접속처리 되어있음.)
    function(callback) {
        model[db[process.argv[2]].DATABASE].query('show tables')
        .then((rows)=>{
            callback(null, rows[0])
        })
        .catch((err)=>{
            callback(err);
        })
    },
    //테이블 목록 배열에 저장
    function(rows,callback) {
        let tables = [];
        rows.map(v=>tables.push(v[`Tables_in_${db[process.argv[2]].DATABASE}`]) );
        callback(null, tables);
    },
    //sequelize-auto 모듈로 해당 DB의 모든 테이블 entity 파일 생성
    function(tables,callback) {
        const auto = new sequelizeAuto(db[process.argv[2]].DATABASE,db[process.argv[2]].USERNAME,db[process.argv[2]].PASSWORD,{
            host: db[process.argv[2]].HOST,
            tables: tables,
            directory: `./src/backend/model/entity/${db[process.argv[2]].DATABASE}`
        })
        auto.run((err)=>{
            if(err) throw err;
        })
        callback(null);
    },
];

async.waterfall(tasks, (err)=>{
    if(err)
        console.log(err);
    else
        console.log('done');
})

해당 파일을 실행했을 때 하나의 데이터베이스에 대한 entity만 생성이 가능하게 되어있습니다. 그것도 실행 argument를 지금 구조에서는 숫자로 줘서 말이죠. 나중에는 DB명으로 실행 argument를 줘서 entity를 생성하게끔 변경할 생각입니다. 코드는 굉장히 간단합니다.

 

 

1. entity를 만드려는 DATABASE 의 config 정보를 db 배열 변수에 저장합니다.
2. 해당 데이터베이스에 존재하는 모든 테이블명을 가져옵니다.
3. 해당 테이블을 sequelize-auto 모듈을 사용하여 해당되는 디렉토리에 js 파일 형태의 entity로 모두 변환하여 저장합니다.

 

설정의 대한 정보는 여기까지고 기존처럼

const model = require('./src/backend/model/entity');

위와같이 entity 디렉토리를 require하면 해당 디렉토리의 index.js 파일을 참조하게 되어있습니다. 그럼 index.js 에서 우리가 반환하게 만든 db 객체를 사용할 수 있습니다. 방식은 기존과 동일합니다. 단, 사용 시에 어느 데이터베이스를 사용할건지 프로퍼티를 그때그때 작성해줘야합니다.