一、简介

Sequelize 是一个 Node.js 平台基于 Promise 的 ORM。用于操作管理 MySQL、Postgres、SQLite 等关系型数据库。我们这里学习 Sequelize 操作 MySQL 数据库。Sequelize 文档:http://docs.sequelizejs.com/en/latest/

二、安装

首先,创建一个 Node.js 项目:

$ mkdir myblog 
$ cd myblog 
$ npm init

npm init 命令会提示输入一系列项目信息,直接一路回车即可。

然后安装 Sequelize 和 MySQL 包:

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

OK,安装完毕!

三、基础用法

首先,需要启动 MySQL 数据库:

$ sudo service mysql start

因为 Sequelize 不能创建数据库,所以需要手动创建一个数据库:

$ mysql -uroot 
> create database blog; 
>

按 Ctrl+c 键退出 MySQL 命令行界面。

连接数据库

首先,需要启动 MySQL 数据库:

$ sudo service mysql start

因为 Sequelize 不能创建数据库,所以需要手动创建一个数据库:

$ mysql -uroot
> create database blog;
>

按 Ctrl+c 键退出 MySQL 命令行界面。

创建了数据库之后,就可以通过 Sequelize 连接到数据库了,在 myblog 文件夹中新建 db.js 文件:

// db.js

var Sequelize = require('sequelize');

/*
// new Sequelize(database, [username=null], [password=null], [options={}])
// class Sequelize 接收 4 个参数,后三个参数是可选的

// 没有密码和 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('my_database', 'john', 'doe', {})

// new Sequelize(uri, [options={}])
// 通过 uri 连接数据库
var sequelize = new Sequelize('mysql://localhost:3306/database', {})
*/

module.exports = new Sequelize('blog', 'root', null, {
    host: 'localhost', // 数据库地址
    dialect: 'mysql', // 指定连接的数据库类型
    pool: {
        max: 5, // 连接池中最大连接数量
        min: 0, // 连接池中最小连接数量
        idle: 10000 // 如果一个线程 10 秒钟内没有被使用过的话,那么就释放线程
    }
});

连接数据库初始化时,Sequelize 会设置一个连接池,所以每个数据库创建一个实例即可。

连接池是创建和管理一个连接的缓冲池的技术,这些连接准备好被任何需要它们的线程使用。

创建用户表

下面来创建一张表模型(model),在 myblog 文件夹中新建 user.js 文件:

// user.js

var Sequelize = require('sequelize');
var sequelize = require('./db');

// 创建 model
var User = sequelize.define('user', {
    userName: {
        type: Sequelize.STRING, // 指定值的类型
        field: 'user_name' // 指定存储在表中的键名称
    },
    // 没有指定 field,表中键名称则与对象键名相同,为 email
    email: {
        type: Sequelize.STRING
    }
}, {
    // 如果为 true 则表的名称和 model 相同,即 user
    // 为 false MySQL 创建的表名称会是复数 users
    // 如果指定的表名称本就是复数形式则不变
    freezeTableName: false
});

// 创建表
// User.sync() 会创建表并且返回一个 Promise 对象
// 如果 force = true 则会把存在的表(如果 users 表已存在)先销毁再创建表
// 默认情况下 forse = false
var user = User.sync({ force: false });

// 添加新用户
exports.addUser = function(userName, email) {
    // 向 user 表中插入数据
    return User.create({
        user_name: userName,
        email: email
    });
};

// 通过用户名查找用户
exports.findByName = function(userName) {
    return User.findOne({ where: { user_name: userName } });
};

测试用户表

在 myblog 文件夹中创建 testUser.js 文件,测试 user.js:

// testUser.js

var user = require('./user');

// 添加用户
user.addUser('jack', 'jack@163.com').then(function() {
    // 查询新添加的用户
    return user.findByName('jack');
}).then(function(user) {
    console.log('****************************');
    console.log('user name:', user.user_name);
    console.log('user email:', user.email);
});

运行 testUser.js 文件:

$ node testUser.js

可以看到终端的最后打印出了用户名和用户邮箱,说明创建表和插入数据成功了。也可以登录到 MySQL,手动查询是否成功创建了用户表和插入了数据。

创建文章表

在 myblog 文件夹中创建 post.js 文件:

// post.js

var Sequelize = require('sequelize');
var sequelize = require('./db');

var Post = sequelize.define('post', {
    // 文章标题
    title: {
        type: Sequelize.STRING
    },
    // 文章内容
    content: {
        type: Sequelize.STRING
    },
    // 文章发表时间
    create_at: {
        type: Sequelize.DATE
    }
}, {
    freezeTableName: false
});

var post = Post.sync();

// 发表新文章
exports.newPost = function(title, content) {
    return post.then(function() {
        Post.create({
            title: title,
            content: content,
            create_at: Date.now()
        });
    });
};

// 查找所以文章
exports.findAllPosts = function() {
    return Post.findAll();
};

// 通过 ID 查找文章
exports.findById = function(id) {
    return Post.findById(id);
};

测试文章表

新建 testPost.js 文件:

var post = require('./post');

// 插入一篇文章
post.newPost('post title', 'post content').then(function() {
    // 通过 ID 查找文章
    return post.findById(1);
}).then(function(p) {
    console.log('********************************');
    console.log('post title:', p.title);
    console.log('post content:', p.content);
});

运行 testPost.js 文件:

$ node testPost.js

可以看到终端的最后打印出了文章标题文章内容,说明创建表和插入数据成功了。也可以登录到 MySQL,手动查询是否成功创建了文章表和插入了数据。

通过 Sequelize 操作 MySQL 数据库很简单吧!