Node的关系型数据库ORM库:bookshelf-阿里云开发者社区

开发者社区> 桃子红了呐> 正文

Node的关系型数据库ORM库:bookshelf

简介:
+关注继续查看

NodeJs 关系数据库ORM库:Bookshelf.js

bookshelf.js是基于knex的一个关系型数据库的ORM库。简单易用,内置了Promise的支持。这里主要罗列一些使用的例子,例子就是最好的教程。下面就是用mysql作为实例数据库表明bookshelf如何使用。其他的几个关系型数据库使用上基本一致,只是配置等地方需要使用的名称各自不同。为了更加贴近实际全部的例子都会放在Express打造的RESTful服务里。

安装bookshelf和knex

首先需要安装库knex和bookshelf,其次还需要安装你的数据库对应的包:

npm install knex --save
npm install bookshelf --save

接下来,安装对应于你要使用的数据库的driver包。下面列出了三个比较典型的,只需要选择一个安装就可以。

npm install pg --save       // PostgreSQL
npm install mysql --save    // MySQL
npm install sqlite3 --save  // SQLite

连接数据库

连接数据库就是非常的简单的,只需要传入一个JSON格式的配置:

var knex        = require('knex'),
    db;    // 数据库连接

// 数据库连接配置
var config = {
    client: 'mysql',        // 其他可以是pg、sqlite3
    connection: {
        host: 'localhost',
        user: 'root',
        password: '123456',
        database: 'petshop', // 数据库名称
        charset: 'utf8'
    }
};

// 保证数据库连接只初始化一次。
if (!db) {
    db = knex(config);
}

接下来就该让bookshelf出马了:

var bookshelf = require('bookshelf')(db);

正式开始前,假设你现在有这么两个表Pet和User,分别存储宠物和宠物店的用户数据:

--pet
CREATE TABLE `pet` (
  `petId` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(45) DEFAULT NULL,
  `type` int(11) DEFAULT NULL,
  `quantity` int(11) DEFAULT NULL,
  `userId` int(11) NOT NULL,    -- 外键,和哪个用户关联
  PRIMARY KEY (`petId`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;


--user
CREATE TABLE `user` (
  `userId` int(11) NOT NULL AUTO_INCREMENT,
  `username` varchar(45) DEFAULT NULL,
  `password` varchar(45) DEFAULT NULL,
  `email` varchar(105) DEFAULT NULL,
  PRIMARY KEY (`userId`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

Express打造的RESTful服务代码:

var Promise     = require('bluebird'),
    express     = require('express'),
    bodyParser  = require('body-parser'),
    session     = require('express-session');

var app = express();

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: true}));

app.use(session({
    secret: 'abcdefghijklmnopqrstuvwxyz1234567890',
    resave: false,
    saveUninitialized: true
    // cookie: {secure: true}
}));

var models = require('./bookshelf');
var router = express.Router();

router.get('/', function(req, res) {
    res.send('Hello bookshelf');
});

/**
 * 添加
 */
router.route('/add').post(function(req, res) {
    // ...
});

/** 
 * 更新
 */
router.route('/update').post(function(req, res) {
    // ...
});

app.use('/bookshelf', router);

app.listen(4000, function(){
    console.log('express is running on http://localhost:4000');
});

为了正常使用还需要安装某些包body-parser,这个包用来解析post发送上来的数据。bluebirdexpress-session什么的可以选择不装,不影响。

Model

ORM,这model是必须不可以少的。如何让model来对应于数据库的table呢:

var Pet = bookshelf.Model.extend({
    tableName: 'pet',
});

现在就可以使用Pet来处理pet表的数据了。

上面是理论上的。回到本例中。首先在根目录下创建一个文件夹bookshelf,然后添加文件model.js

添加数据

给表添加一条记录:

new Pet({
    name: 'King',
    type: 1, // 1: dog, 2: cat...
    quantity: 10,
    userId: 123456
}).save().then(function(model){
    console.log(model);
}).catch(function(err) {
    console.log(err);
});

放在RESTful API里:

router.route('/add').post(function(req, res) {
    var pet = new models.Pet({
        name: req.body.name,
        type: req.body.type,
        quantity: req.body.quantity,
        userId: req.body.userId
    });

    pet.save().then(function(model){
        res.json({message:'done', data: pet});
    }).catch(function(err){
        res.json({message: 'error', data: err});
    });
});

在处理数据的时候可以使用bookshelf提供的很多“静态方法”。上面的extend就是这些静态方法中的一个。创建新的model的时候就可以是用静态方法里的一个forge,这样就不用new的方式了。

    models.Pet.forge({
        name: req.body.name,
        type: req.body.type,
        quantity: req.body.quantity,
        userId: req.body.userId
    }).save().then(function(pet){
        res.json({message:'done', data: pet});
    }).catch(function(err){
        res.json({message: 'error', data: err});
    });

查找数据

添加了数据就可以查找出来了。

查找全部

查找全部的数据:

router.route('/findall').get(function(req, res) {
    models.Pet.forge().fetchAll().then(function(pets) {
        res.json({message: 'done', data: pets});
    }).catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

在浏览器里输入地址:http://localhost:4000/bookshelf/findall可以查找出全部的pet数据

查找某一个Pet

router.route('/find/:petId').get(function(req, res) {
    models.Pet.forge({
        petId: req.params.petId
    }).fetch().then(function(pet) {
        res.json({message: 'done', data: pet});
    }).catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

在浏览器里输入地址:http://localhost:4000/bookshelf/find/1可以查找出petId为1的数据

我们在上一个例子中已经创建了一条记录,所以现在可以搜出来一条记录。

更多的更复杂的查找可以使用方法query,查看这里了解更多。

更新数据

更新和创建一条新纪录,在写法上没什么太大的区别。只不过你需要在save方法里设置需要更新的数据。但是有一个限制条件,就是需要在forge方法里给出id,必须是这个词id。如果你的Primary key不是这个名称,那么就稍微复杂一点了。必须给出where条件,比如:

router.route('/update/:petId').post(function(req, res) {
    models.Pet.forge()
    .where('petId', '=', req.params.petId)
    .save({
        name: req.body.name,
        type: req.body.type,
        quantity: req.body.quantity,
        userId: req.body.userId
    }, {patch: true}).then(function(pet) {
        res.json({message: 'done', data: pet});
    }).catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

更多关于where内容可以查看这里

删除记录

最后可以删除记录。

router.route('/delete/:petId').get(function(req, res) {
    models.Pet.forge()
    .where('petId', '=', req.params.petId)
    .destroy()
    .then(function(pet) {
        res.json({message: 'done', data: pet});
    })
    .catch(function(err) {
        res.json({message: 'error', data: err});
    });
});

最后

bookshelf这个库非常好用。不过这些还只是比较常用的一部分功能。还有很多的关系数据库的一对一、一对多以及多对多的关系的处理。
这些都可以在官方文档中查找到。














本文转自张昺华-sky博客园博客,原文链接:http://www.cnblogs.com/sunshine-anycall/p/5642901.html,如需转载请自行联系原作者


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
魏红斌冬季实战营第一期:玩转云服务器(有干货)
本文均为本人实操整理,请勿搬运,学习交流可以随时评论---魏红斌
25 0
软件工程专业如何就业!
引言:曾经有两个强盗向他们的大哥说如果世上没有绞刑架该多好,大哥却回答说如果做强盗的代价那么小,人人都去干了,那么行业的竞争压力该有多大啊,正是因为不容易,做的人少,才有去做的价值啊。 在班会的开篇我给大家讲了这样一个故事,我认为人生就是不断地克服困难向上攀登,阻力是不可避免的,定的目标高一些,辛苦一些,当战胜它之后我们会发现这边风景独好。
13 0
备战5月软考--软件设计师
1.上午场需要做的就是不停的刷题,每个科目的题都要会个大概(大概有11个大考点) 2.下午场需要做的也是不停的做题,下午场的题型比较固定,做来做出都是那几类,自己做完总结适合自己的做题技巧第一题:数据流图方面的设计(实体Ei的名称、数据存储Di的名称,数据流图等)第二题:数据库设计(E-R图、完整性约束等)第三题:用例描述(识别参与者、用例名称、类名等)第四题:算法题第五题:设计模式的Java代码第六题:设计模式的C++代码
10 0
祝贺!我的同事李飞飞当选ACM Fellow、IEEE Fellow
因在数据库查询处理和优化以及云数据库系统方面所做出的卓越贡献而入选
15 0
数据库中间件 MyCAT源码分析 —— PreparedStatement 重新入门
数据库中间件 MyCAT源码分析 —— PreparedStatement 重新入门
13 0
关于“冬季实战营第一期”的学习报告
冬奥云小宝带你玩转五期实战营,初识上云基础,非常适合新手上路,上云必备环境准备让您轻松上云。
65 0
什么是前端开发?什么是后端开发?
什么是前端开发?什么是后端开发?
16 0
冬季实战营第一期:从零到一上手玩转云服务器实验报告
搭建LAMP、部署MySQL数据库、使用PolarDB和ECS搭建门户网站操作手册
16 0
软件质量稳定性之殇
摘要:软件系统的稳定性,主要决定于整体的系统架构设计,然而也不可忽略编程的细节,正所谓“千里之堤,溃于蚁穴”,一旦考虑不周,看似无关紧要的代码片段可能会带来整体软件系统的崩溃。我将和大家聊一聊软件质量稳定性之殇,分多篇刊发。
6 0
冬季实战营第一期:从零到一上手玩转云服务器场景体验报告之使用 PolarDB 和 ECS 搭建门户网站
冬季实战营第一期:从零到一上手玩转云服务器场景体验报告之使用 PolarDB 和 ECS 搭建门户网站
20 0
4269
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载