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', 'works@163.com').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


  1. ORM 和 Promise 的概念自行查找

  2. 连接池的概念不理解的话自行度娘 or Google

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,380评论 25 707
  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    aimaile阅读 26,436评论 6 428
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,724评论 6 342
  • 人总是等到失去才懂得珍惜,奶奶已经去世了,才懂得她的存在之于我有多么珍贵的意义,这辈子再也见不到你了,每次回家你都...
    陌暮阅读 164评论 0 2
  • 我们时常会听到一些尴尬的事情,在健身圈里也坚持会有比较尴尬的问题,今天带大家感受感受。 我一周五次健身房,周六周日...
    91运动联盟官方阅读 361评论 0 2