정성환의 IT개발 창고

시퀄라이즈는 ORM(Object-relational Mapping)으로 분류가 된다.

ORM은 자바스크립트 객체와 데이터베이스의 릴레이션을 매핑해주는 도구이다.

1. express를 이용해서 새 프로젝트 생성

$ express sequlize_ex --view=pug

위에 나온대로 디렉토리를 바꿔준뒤 npm i를 해준다.

$ cd sequelize_ex
$ npm i

방금 만든 프로젝트에 sequelize와 mysql2 패키지를 설치한다. 그 후 sequelize 커맨드를 사용하기 위해 sequelize-cli를 전역 설치

$ npm i sequelize mysql2
$ npm i -g sequelize-cli
$ sequelize init

그 뒤 파일들을 아래대로 세팅

models/index.js

const path = require('path');
const Sequelize = require('sequelize'); //sequelize 연결

const env = process.env.NODE_ENV || 'development';
const config = require(path.join(__dirname, '..', 'config', 'config.json'))[env];
const db = {};

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


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

//user와 comment 테이블을 연결시킨다.
db.User = require('./user')(sequelize, Sequelize);
db.Comment = require('./comment')(sequelize, Sequelize); 

//테이블 간의 관계를 정의해줌
db.User.hasMany(db.Comment, {foreignKey: 'commenter', sourceKey: 'id'});
db.Comment.belongsTo(db.User, {foreignKey: 'commenter', targetKey: 'id'});

module.exports = db; //db라는 객체에 user와 comment 모델을 담는다.

시퀄라이즈를 통해 익스프레스 앱과 MYSQL을 연결한다. app.js에서 추가해준다.

app.js

var createError = require('http-errors');
var express = require('express');
var path = require('path');
var cookieParser = require('cookie-parser');
var logger = require('morgan');

var indexRouter = require('./routes/index');
var usersRouter = require('./routes/users');
var commentsRouter = require('./routes/comments');

//추가
var sequelize = require('./models').sequelize;

var app = express();

//추가
sequelize.sync();
// view engine setup
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'pug');

app.use(logger('dev'));
app.use(express.static(path.join(__dirname, 'public')));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());

app.use('/', indexRouter);
app.use('/users', usersRouter);
app.use('/comments', commentsRouter);

// catch 404 and forward to error handler
app.use(function(req, res, next) {
  next(createError(404));
});

// error handler
app.use(function(err, req, res, next) {
  // set locals, only providing error in development
  res.locals.message = err.message;
  res.locals.error = req.app.get('env') === 'development' ? err : {};

  // render the error page
  res.status(err.status || 500);
  res.render('error');
});

module.exports = app;

번거롭지만 MYSQL에서 정의한 테이블을 시퀄라이즈에서도 정의해야 한다.

기본적으로 모델 이름은 단수형으로 테이블 이름은 복수형으로 사용한다.

models/user.js

module.exports = (sequelize, DataTypes) => {
    return sequelize.define('user', {
        name: {
            type: DataTypes.STRING(20),
            allowNull: false,
            unique: true,
        },
        age: {
            type: DataTypes.INTEGER.UNSIGNED,
            allowNull: false,
        },
        married: {
            type: DataTypes.BOOLEAN,
            allowNull: false,
        },
        comment: {
            type: DataTypes.TEXT,
            allowNull: true,
        },
        created_at: {
            type: DataTypes.DATE,
            allowNull: false,
            defaultValue: DataTypes.NOW,
        },
    }, {
        timestamps: false,
    });
};

 알아서 id를 기본 키로 연결하므로 id 컬럼은 적어줄 필요가 없다.

그리고 알아둘 것이 timestamps가 true면 시퀄라이즈는 createdAt과 updatedAt 컬럼을 추가하며 행이 생성 될때와 수정될 때의 시간을 자동으로 입력한다.

하지만 여기서는 created_at 컬럼을 직접만들었으므로 timestamps는 false로 하였다.

참고로 paranoid: true 도 많이 사용하는데 이러면 deletedAt이라는 컬럼이 추가되어 행이 삭제 되었을 때 제거하는 대신 deletedAt에 제거된 날짜를 입력한다.

실무에서는 데이터베이스 복원을 위하여 데이터 삭제는 왠만해선 하지 않는다. 사이트에서 회원탈퇴해도 같은 아이디로는 재가입할 수 없는 것도 이러한 이치.

이 외에도 underscored 옵션을 사용하여 캐멀형식이 아닌 _를 중간에 써주어 created_at 처럼 표기시킬 수도 있다.

comment 모델도 만들어 보자.

models/comment.js

module.exports = (sequelize, DataTypes) => {
    return sequelize.define('comment', {
        comment: {
            type: DataTypes.STRING(100),
            allowNull: false,
        },
        created_at: {
            type: DataTypes.DATE,
            allowNull: true,
            defaultValue: DataTypes.NOW,
        },
    }, {
        timestamps: false,
    });
};

아까 위에서 index.js에서 보듯이 db라는 객체에 user와 comment 모델을 담아두었다.

models/index.js

const path = require('path');
const Sequelize = require('sequelize'); //sequelize 연결

const env = process.env.NODE_ENV || 'development';
const config = require(path.join(__dirname, '..', 'config', 'config.json'))[env];
const db = {};

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


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

//user와 comment 테이블을 연결시킨다.
db.User = require('./user')(sequelize, Sequelize);
db.Comment = require('./comment')(sequelize, Sequelize); 

//테이블 간의 관계를 정의해줌
db.User.hasMany(db.Comment, {foreignKey: 'commenter', sourceKey: 'id'});
db.Comment.belongsTo(db.User, {foreignKey: 'commenter', targetKey: 'id'});

module.exports = db; //db라는 객체에 user와 comment 모델을 담는다.

db객체를 require하여 User와 Comment 모델에 접근할 수 있다.

마지막으로 config.json을 수정하여 mysql 비밀번호를 입력하여 연결시켜준다.

본인은 비밀번호는 12351235로 하였다. 

config/config.json

{
  "development": {
    "username": "root",
    "password": "12351235",
    "database": "nodejs",
    "host": "127.0.0.1",
    "dialect": "mysql",
    "operatorsAliases": false
  },
  "test": {
    "username": "root",
    "password": null,
    "database": "database_test",
    "host": "127.0.0.1",
    "dialect": "mysql",
    "operatorsAliases": false
  },
  "production": {
    "username": "root",
    "password": null,
    "database": "database_production",
    "host": "127.0.0.1",
    "dialect": "mysql",
    "operatorsAliases": false
  }
}

그리고 나머지 html 코딩파일은 아래의 파일을 다운로드 받아서 덮어쓰기 한다.

그 뒤 npm start를 실행시킨다.

localhost:3000으로 들어가면 아래와 같은 페이지가 나타난다.

위에 이름나이를 등록하고 중간에 리스트를 클릭하면 아래에 클릭한 리스트가 나타난다.