NodeJS ORM 框架 Sequelize 操作数据库小结

2017年8月10日20:12:20 Edit By K

简介

Sequelize 是一个 Node.js 平台基于Promise 的 ORM^[1]。可以操作管理 Mysql、Postgres、SQLite 等关系型数据库。

Sequelize 文档 http://docs.sequelizejs.com/en/latest/

安装

创建 NodeJs 项目

$ mkdir YourDirName
$ cd YourDirName
$ npm init

安装 Sequelize 和 Mysql 包

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

至此，安装结束。

当然我给你们发的包已经创建好了 Node Express 项目及相关依赖，不必再安装一遍。

如果你想自己再试试的话，建议参考 Sequelize 官方文档，如果没记错的话，我当时安装的 Mysql 包是 mysql2。

$ npm install mysql2

两者有没有区别暂时还没查，有兴趣可以自行查一查。

在我发给你们的项目中还有一些其他依赖包，类似于 BodyParser 等等，这些包可以在项目的 package.json文件中找到。

来吧，操作数据库，造作吧

你需要一个数据库

操作数据库，没有数据库怎么行呢？首先我们要创建一个 database。

我发给大家的项目里数据库名称是 getitmore，请在 Mysql 中创建好。

在创建数据库的时候，推荐选择编码 UTF-8，毕竟国际通用

我平时管理数据库的软件是 Navicat Premium，不再安利它了

连接真的如此简单

Sequelize 提供了多种多样的连接方式，官网给出了如下几种：

/*** 分别介绍一下连接方式 ***/
var sequelize = new Sequelize(database, [username=null], [password=null], [options={}]);
// 没有密码和 options 的情况
var sequelize = new Sequelize('database', 'username');
// 没有options 的情况
var sequelize = new Sequelize('database', 'username', 'password');
// 没有密码，有 options 的情况
var sequelize = new Sequelize('database', 'username', null, {});
// 啥都有的情况
var sequelize = new Sequelize('databse', 'username', 'password', {});
// 举个没有用户名密码和 options 的小栗子
var sequelize = new Sequelize('mysql://localhost:3306/databse', {});

/*** 下面这种方式适用于生产环境，推荐 ***/
var sequelize = new Sequelize('database', 'root', 'root', {
  host: 'localhost',    // 数据库地址
  dialect: 'mysql',     // 数据库类型
  pool: {
    max: 5,             // 连接池最大连接数量
    min: 0,             // 连接池最小连接数量
    idle: 10000         // 如果一个线程超过10秒钟没有被使用过就释放该线程
  }
})

我们项目采用的即时最后一种连接池的方式，连接时 Sequelize 会设置一个连接池，我们在使用的时候只需要实例化一个就行^[2]

在项目中我创建了如下文件/controller/db.js以供配置数据库使用：

/**
 * Created by K on 2017-07-31.
 */

var Sequelize = require("sequelize");

/**
 * 连接指定类型的数据库
 * host：数据库地址
 * max：连接池最大连接数量
 * min：连接池最小连接数量
 * idle：每个线程最长等待时间
 * @type {Sequelize}
 */
module.exports = new Sequelize('getitmore', 'root', 'root', {
    host: 'localhost',
    dialect: 'mysql',
    pool: {
        max: 20,
        min: 0,
        idle: 10000
    }
});

映射数据表

ORM 的思想是什么，映射成对象啊，映射 Sql 语句啊。好的，我们来看看 Sequelize 怎么映射的吧。

/*** 举个小栗子 user.js ***/
// 引入 sequelize 包，创建 sequelize 实例
let Sequelize = require('sequelize');
let sequelize = require('./db.js');

// 创建 Model
let User = sequelize.define('user', {
  // 指定映射的字段类型，字段名，例如数据库中 user 表中的 username 字段映射成 username
  username: {
    type: Sequelize.STRING,
    field: 'username'
  },
  // 如果不指定 field，会自动映射相同名称的字段
  email: {
    type: Sequelize.STRING
  }
}, {
  // freezeTabelName 为 true 时不会在库中映射表时增加复数表名
  // 该选项为 true 时，user 在映射时映射成 user，而为 false 时会映射成users
  freezeTableName: false
});

// 创建或同步表
// User.sync() 会返回一个 Promise 对象
// force = true 时会把存在的表先 drop 掉再创建，好怕怕
let user = User.sync({ force: false});

// 现在可以操作 User 执行增删改查啦
// 举两个栗子
// 添加用户
exports.addUser = function(username, email) {
  return User.create({
    username: username,
    email: email
  })
};
// 查找用户
exports.findUserByName = function(username) {
  return User.findOne({
    where: {
      username: username
    }
  })
};

以上是一个不那么完整的 Demo，在我们项目中还有很多 options 需要设置，还有很多 Sequelize 的方法，远不止 create()和findOne()这么简单，字段类也远不止STRING这一种。来看一个咱们项目中的 Model，以原创表为栗子：

/**
 * Created by kk on 2017/8/1.
 */

let Sequelize = require('sequelize');
let sequelize = require('../controller/db');

/**
 * 定义原创 Model
 * 包括五个属性 title、content、content_detail、img_url、count、create_time
 * freezeTableName 表示是否在数据库中创建复数表名，例如 users
 * timestamp 表示是否在数据库中创建 createAt 和 updateAt 字段
 */
let Original = sequelize.define('original', {
    title: { type: Sequelize.STRING },
    content: { type: Sequelize.STRING },
    content_detail: { type: Sequelize.TEXT('long') },
    img_url: { type: Sequelize.STRING },
    count: { type: Sequelize.INTEGER },
    create_time: { type: Sequelize.DATE }
}, {
    freezeTableName: true,
    timestamps: false
});

// 创建表，force 为 true 时会先执行 drop 再创建
let original = Original.sync({ force: false});

// 分页获取原创
exports.findOriginalPageList = function(pageNo, limit) {
    console.log(pageNo);
    return Original.findAll({
        limit: limit,
        offset: pageNo
    });
};

// 根据id获取原创详细内容
exports.findOriginalById = function(originalId) {
    return Original.findById(originalId);
};

// 根据Id列表获取原创
exports.findOriginalByIdList = function(originalIdList) {
    return Original.findAll({
        where: {
            id: originalIdList
        }
    })
};

我为了让项目显得结构清楚，创建了 Model 的文件夹，所有映射的数据表都在该文件夹下。当然，我们项目中的栗子也不能囊括所有的 Sequelize 用法，最好的方式还是去看官网文档。

啊？返回的是什么，我怎么取值啊？

来创建一个测试脚本看看它到底返回了一个什么！

// test.js
var user = require('./user');
user.addUser('test', '[email protected]').then(function() {
  return user.findByName('test');
}).then(function(user) {
  console.log('这里的 user 就是在执行完 findByName 之后返回的对象');
  console.log('username:' + user.username);
  console.log('email:' + user.email);
})

至此，一个基本的数据库操作就完成了。执行以下试试看：

$ node test.js

惊不惊喜？意不意外？

注意

以上我介绍的 Sequelize 操作目录结构如下：

YourDirName
- db.js
- user.js
- test.js

咱们项目的结构我进行了调整，将 controller、model、和 view 进行了人为划分：

NodeExpressServer
- controller
  - db.js
- model
  - extra.js
  - collect.js
  - user.js
  - ...
- app.js

至此，还有什么问题的话，问我吧，向我开炮吧。

说句题外话，看看我写的代码是不是非常优雅，哈哈哈，学着点

变量名，换行，空格的设置，整齐划一的风格，坚持是一种信仰，习惯也不是一天养成的，推荐一本书《代码整洁之道》

记住：你本来就很美。

安利这款新 Markdown 编辑器：Typora

ORM 和 Promise 的概念自行查找 ↩
连接池的概念不理解的话自行度娘 or Google ↩