Mongoose学习参考文档

一、快速通道

1.1 名词解释

Schema

： 一种以文件形式存储的数据库模型骨架，不具备数据库的操作能力

Model

： 由

Schema

发布生成的模型，具有抽象属性和行为的数据库操作对

Entity

： 由

Model

创建的实体，他的操作也会影响数据库

注意：

1.本学习文档采用严格命名方式来区别不同对象，例如：

var PersonSchema;   //Person的文本属性
var PersonModel;    //Person的数据库模型
var PersonEntity;   //Person实体

2.

Schema

、

Model

、

Entity

的关系请牢记，

Schema

生成

Model

，

Model

创造

Entity

，

Model

和

Entity

都可对数据库操作造成影响，但

Model

比

Entity

更具操作性。

1.2 准备工作

1.首先你必须安装MongoDB和NodeJS

2.在项目只能够创建一个数据库连接，如下:

var mongoose = require('mongoose');    //引用mongoose模块
var db = mongoose.createConnection('localhost','test'); //创建一个数据库连接

3.打开本机

localhost

的

test

数据库时，我们可以监测是否有异常

db.on('error',console.error.bind(console,'连接错误:'));
db.once('open',function(){
//一次打开记录
});

注意：

　　成功开启数据库后，就可以执行数据库相应操作，假设以下代码都在回调中处理

4.定义一个

Schema

var PersonSchema = new mongoose.Schema({
name:String   //定义一个属性name，类型为String
});

5.将该

Schema

发布为

Model

var PersonModel = db.model('Person',PersonSchema);
//如果该Model已经发布，则可以直接通过名字索引到，如下：
//var PersonModel = db.model('Person');
//如果没有发布，上一段代码将会异常

6.用

Model

创建

Entity

var personEntity = new PersonModel({name:'Krouky'});
//打印这个实体的名字看看
console.log(personEntity.name); //Krouky

7.我们甚至可以为此

Schema

创建方法

//为Schema模型追加speak方法
PersonSchema.methos.speak = function(){
console.log('我的名字叫'+this.name);
}
var PersonModel = db.model('Person',PersonSchema);
var personEntity = new PersonModel({name:'Krouky'});
personEntity.speak();//我的名字叫Krouky

8.

Entity

是具有具体的数据库操作

CRUD

的

personEntity.save();  //执行完成后，数据库就有该数据了

9.如果要执行查询，需要依赖

Model

，当然

Entity

也是可以做到的

PersonModel.find(function(err,persons){
//查询到的所有person
});

注意：

　　1. 具体的如何配置

Schema

、

Model

以及

Model

和

Entity

的相关操作，我们会在后面进行

　　2.

Model

和

Entity

都有能影响数据库的操作，但仍有区别，后面我们也会做解释

二、新手指引

　　如果您还不清楚

Mongoose

是如何工作的，请参看第一章快速通道快速浏览他的用法吧

1. Schema——纯洁的数据库原型

1.1 什么是Schema

我理解

Schema

仅仅只是一断代码，他书写完成后程序依然无法使用，更无法通往数据库端

他仅仅只是数据库模型在程序片段中的一种表现，或者是数据属性模型

1.2 如何定义Schema

var BlogSchema = new Schema({
title:String,
author:String
//new Schema()中传入一个JSON对象，该对象形如 xxx:yyyy ,
/xxx是一个字符串，定义了属性，yyy是一个Schema.Type，定义了属性类型
});

1.3 什么是Schema.Type

　　

Schema.Type

是由

Mongoose

内定的一些数据类型，基本数据类型都在其中，他也内置了一些

Mongoose

特有的

Schema.Type

。当然，你也可以自定义

Schema.Type

，只有满足

Schema.Type

的类型才能定义在

Schema

内。

1.4 Schema.Types

　　

NodeJS

中的基本数据类型都属于

Schema.Type

，另外

Mongoose

还定义了自己的类型

//举例：
var ExampleSchema = new Schema({
name:String,
binary:Buffer,
living:Boolean,
updated:Date,
age:Number,
mixed:Schema.Types.Mixed, //该混合类型等同于nested
_id:Schema.Types.ObjectId,  //主键
_fk:Schema.Types.ObjectId,  //外键
array:[],
arrOfString:[String],
arrOfNumber:[Number],
arrOfDate:[Date],
arrOfBuffer:[Buffer],
arrOfBoolean:[Boolean],
arrOfMixed:[Schema.Types.Mixed],
arrOfObjectId:[Schema.Types.ObjectId]
nested:{
stuff:String,
}
});

1.5 关于Buffer

　　

Buffer

和

ArrayBuffer

是

Nodejs

两种隐藏的对象，相关内容请查看

NodeJS-API

1.6 关于Mixed

　　

Schema.Types.Mixed

是

Mongoose

定义个混合类型，该混合类型如果未定义具体形式。因此,如果定义具体内容，就直接使用

{}

来定义，以下两句等价

var AnySchema = new Schema({any:{}});
var AnySchema = new Schema({any:Schema.Types.Mixed});

　　混合类型因为没有特定约束，因此可以任意修改，一旦修改了原型，则必须调用

markModified()

person.anything = {x:[3,4,{y:'change'}]}
person.markModified('anything');//传入anything，表示该属性类型发生变化
person.save();

1.7 关于ObjectId

　　主键，一种特殊而且非常重要的类型，每个

Schema

都会默认配置这个属性，属性名为

_id

，除非自己定义，方可覆盖

var mongoose = require('mongoose');
var ObjectId = mongoose.Schema.Types.ObjectId;
var StudentSchema = new Schema({}); //默认会有_id:ObjectId
var TeacherSchema = new Schema({id:ObjectId});//只有id:ObjectId

　　该类型的值由系统自己生成，从某种意义上几乎不会重复，生成过程比较复杂，有兴趣的朋友可以查看源码。

1.8 关于Array

　　

Array

在

JavaScript

编程语言中并不是数组，而是集合，因此里面可以存入不同的值，以下代码等价：

var ExampleSchema1 = new Schema({array:[]});
var ExampleSchema2 = new Schema({array:Array});
var ExampleSchema3 = new Schema({array:[Schema.Types.Mixed]});
var ExampleSchema4 = new Schema({array:[{}]});

1.9 附言

　　

Schema

不仅定义了

文档结构

和

使用性能

，还可以有

扩展插件

、

实例方法

、

静态方法

、

复合索引

、

文档生命周期钩子

　　

Schema

可以定义插件，并且插件具有良好的可拔插性，请有兴趣的读者继续往后阅读或者查阅官方资料。

2. Schema的扩展

2.1 实例方法

　　有的时候，我们创造的

Schema

不仅要为后面的

Model

和

Entity

提供公共的属性，还要提供公共的方法。

　　下面例子比快速通道的例子更加高级，可以进行高级扩展：

var PersonSchema = new Schema({name:String,type:String});
//查询类似数据
PersonSchema.methods.findSimilarTypes = function(cb){
return this.model('Person').find({type:this.type},cb);
}

　　使用如下：

var PersonModel = mongoose.model('Person',PersonSchema);
var krouky = new PersonModel({name:'krouky',type:'前端工程师'});
krouky.findSimilarTypes(function(err,persons){
//persons中就能查询到其他前端工程师
});

2.2 静态方法

　　静态方法在

Model

层就能使用，如下：

PersonSchema.statics.findByName = function(name,cb){
this.find({name:new RegExp(name,'i'),cb});
}
var PersonModel = mongoose.model('Person',PersonSchema);
PersonModel.findByName('krouky',function(err,persons){
//找到所有名字叫krouky的人
});

2.3 索引

　　索引或者复合索引能让搜索更加高效，默认索引就是主键索引

ObjectId

，属性名为

_id

， 索引会作为一个专题来讲解

2.4 虚拟属性

　　

Schema

中如果定义了虚拟属性，那么该属性将不写入数据库，例如：

var PersonSchema = new Schema({
name:{
first:String,
last:String
}
});
var PersonModel = mongoose.model('Person',PersonSchema);
var krouky = new PersonModel({
name:{first:'krouky',last:'han'}
});

　　如果每次想使用全名就得这样

console.log(krouky.name.first + ' ' + krouky.name.last);

　　显然这是很麻烦的，我们可以定义

虚拟属性

：

PersonSchema.virtual('name.full').get(function(){
return this.name.first + ' ' + this.name.last;
});

　　那么就能用

krouky.name.full

来调用全名了，反之如果知道full，也可以反解

first

和

last

属性

PersonSchema.virtual('name.full').set(function(name){
var split = name.split(' ');
this.name.first = split[0];
this.name.last = split[1];
});
var PersonModel = mongoose.model('Person',PersonSchema);
var krouky = new PersonModel({});
krouky.name.full = 'krouky han';//会被自动分解
console.log(krouky.name.first);//krouky

2.5 配置项

　　在使用

new Schema(config)

时，我们可以追加一个参数

options

来配置

Schema

的配置，形如：

var ExampleSchema = new Schema(config,options);

　　或者使用

var ExampleSchema = new Schema(config);
ExampleSchema.set(option,value);

　　可供配置项有：

safe

、

strict

、

capped

、

versionKey

、

autoIndex

2.5.1 safe——安全属性（默认安全）
　　一般可做如下配置：

new Schema({...},{safe:true});

　　当然我们也可以这样

new Schema({...},{safe:{j:1,w:2,wtimeout:10000}});

　　

j

表示做1份日志，

w

表示做2个副本（尚不明确），超时时间10秒

2.5.2 strict——严格配置（默认启用）
　　确保

Entity

的值存入数据库前会被自动验证，如果你没有充足的理由，请不要停用，例子：

var ThingSchema = new Schema({a:String});
var ThingModel = db.model('Thing',SchemaSchema);
var thing = new Thing({iAmNotInTheThingSchema:true});
thing.save();//iAmNotInTheThingSchema这个属性将无法被存储

　　如果取消严格选项，

iAmNotInTheThingSchema

将会被存入数据库

　　该选项也可以在构造实例时使用，例如：

var ThingModel = db.model('Thing');
var thing1 = new ThingModel(doc,true);  //启用严格
var thing2 = new ThingModel(doc,false); //禁用严格

注意：

　　

strict

也可以设置为

throw

，表示出现问题将会抛出错误

2.5.3 shardKey
　　需要

mongodb

做分布式，才会使用该属性

2.5.4 capped——上限设置
　　如果有数据库的批量操作，该属性能限制一次操作的量，例如：

new Schema({...},{capped:1024});  //一次操作上线1024条数据

　　当然该参数也可是JSON对象，包含size、max、autiIndexId属性

new Schema({...},{capped:{size:1024,max:100,autoIndexId:true}});

2.5.5 versionKey——版本锁
　　版本锁是

Mongoose

默认配置（__v属性）的，如果你想自己定制，如下：

new Schema({...},{versionKey:'__someElse'});

　　此时存入数据库的版本锁就不是

__v

属性，而是

__someElse

，相当于是给版本锁取名字。

　　具体怎么存入都是由

Mongoose

和

MongoDB

自己决定，当然，这个属性你也可以去除

new Schema({...},{versionKey:false});

　　除非你知道你在做什么，并且你知道这样做的后果

2.5.6 autoIndex——自动索引
　　该内容将在索引章节单独讲解

3. Documents

　　

Document

是与

MongoDB

文档一一对应的模型，

Document

可等同于

Entity

，具有属性和操作性

注意：

　　

Document

的`CRUD都必须经过严格验证的，参看2.5.2 Schema的strict严格配置

3.1 查询

　　查询内容过多，专题讲解

3.2 更新

　　有许多方式来更新文件，以下是常用的传统方式：

PersonModel.findById(id,function(err,person){
person.name = 'MDragon';
person.save(function(err){});
});

　　这里，利用

Model

模型查询到了

person

对象，该对象属于

Entity

，可以有

save操作，如果使用

Model`操作，需注意：

PersonModel.findById(id,function(err,person){
person.name = 'MDragon';
var _id = person._id; //需要取出主键_id
delete person._id;    //再将其删除
PersonModel.update({_id:_id},person,function(err){});
//此时才能用Model操作，否则报错
});

　　

update

第一个参数是查询条件，第二个参数是更新的对象，但不能更新主键，这就是为什么要删除主键的原因。

　　当然这样的更新很麻烦，可以使用

$set

属性来配置，这样也不用先查询，如果更新的数据比较少，可用性还是很好的：

PersonModel.update({_id:_id},{$set:{name:'MDragon'}},function(err){});

　　需要注意，

Document

的

CRUD

操作都是异步执行，

callback

第一个参数必须是

err

，而第二个参数各个方法不一样，

update

的

callback

第二个参数是更新的数量，如果要返回更新后的对象，则要使用如下方法

Person.findByIdAndUpdate(_id,{$set:{name:'MDragon'}},function(err,person){
console.log(person.name); //MDragon
});

　　类似的方法还有

findByIdAndRemove

，如同名字，只能根据id查询并作

update

/

remove

操作，操作的数据仅一条

3.3 新增

　　如果是

Entity

，使用

save

方法，如果是

Model

，使用

create

方法

//使用Entity来增加一条数据
var krouky = new PersonModel({name:'krouky'});
krouky.save(callback);
//使用Model来增加一条数据
var MDragon = {name:'MDragon'};
PersonModel.create(MDragon,callback);

　　两种新增方法区别在于，如果使用

Model

新增时，传入的对象只能是纯净的

JSON

对象，不能是由

Model

创建的实体，原因是：由

Model

创建的实体

krouky

虽然打印是只有

{name:'krouky'}

，但是

krouky

属于

Entity

，包含有

Schema

属性和

Model

数据库行为模型。如果是使用

Model

创建的对象，传入时一定会将隐藏属性也存入数据库，虽然

3.x

追加了默认严格属性，但也不必要增加操作的报错

3.4 删除

　　和新增一样，删除也有2种方式，但

Entity

和

Model

都使用

remove

方法

4.Sub Docs

　　如同

SQL

数据库中2张表有主外关系，

Mongoose

将2个

Document

的嵌套叫做

Sub-Docs

（子文档）

　　简单的说就是一个

Document

嵌套另外一个

Document

或者

Documents

:

var ChildSchema1 = new Schema({name:String});
var ChildSchema2 = new Schema({name:String});
var ParentSchema = new Schema({
children1:ChildSchema1,   //嵌套Document
children2:[ChildSchema2]  //嵌套Documents
});

　　

Sub-Docs

享受和

Documents

一样的操作，但是

Sub-Docs

的操作都由父类去执行

var ParentModel = db.model('Parent',parentSchema);
var parent = new ParentModel({
children2:[{name:'c1'},{name:'c2'}]
});
parent.children2[0].name = 'd';
parent.save(callback);

　　

parent

在执行保存时，由于包含

children2

，他是一个数据库模型对象，因此会先保存

chilren2[0]

和

chilren2[1]

。

　　如果子文档在更新时出现错误，将直接报在父类文档中，可以这样处理：

ChildrenSchema.pre('save',function(next){
if('x' === this.name) return next(new Error('#err:not-x'));
next();
});
var parent = new ParentModel({children1:{name:'not-x'}});
parent.save(function(err){
console.log(err.message); //#err:not-x
});

4.1 查询子文档

　　如果

children

是

parent

的子文档，可以通过如下方法查询到

children

var child = parent.children.id(id);

4.2 新增、删除、更新

　　子文档是父文档的一个属性，因此按照属性的操作即可，不同的是在新增父类的时候，子文档是会被先加入进去的。

　　如果

ChildrenSchema

是临时的一个子文档，不作为数据库映射集合，可以这样：

var ParentSchema = new Schema({
children:{
name:String
}
});
//其实就是匿名混合模式

5.Model

5.1 什么是Model

　　

Model

模型，是经过

Schema

构造来的，除了

Schema

定义的数据库骨架以外，还具有数据库行为模型，他相当于管理数据库属性、行为的类

5.2 如何创建Model

　　你必须通过

Schema

来创建，如下：

//先创建Schema
var TankSchema = new Schema({
name:'String',
size:'String'
});
//通过Schema创建Model
var TankModel = mongoose.model('Tank',TankSchema);

5.2 操作Model

　　该模型就能直接拿来操作，具体查看

API

，例如：

var tank = {'something',size:'small'};
TankModel.create(tank);

注意：

　　你可以使用

Model

来创建

Entity

，

Entity

实体是一个特有

Model

具体对象，但是他并不具备

Model

的方法，只能用自己的方法。

//通过Model创建Entity
var tankEntity = new TankModel('someother','size:big');
tankEntity.save();

6.Query

　　查询是数据库中运用最多也是最麻烦的地方，这里对

Query

解读的并不完善，仅仅是自己的一点领悟而已。

6.1 查询的方式

　　通常有2种查询方式，一种是

直接查询

，一种是

链式查询

（2种查询都是自己命名的）

6.1.1 直接查询
　　在查询时带有回调函数的，称之为直接查询，查询的条件往往通过

API

来设定，例如：

PersonModel.findOne({'name.last':'dragon'},'some select',function(err,person){
//如果err==null，则person就能取到数据
});

　　具体的查询参数，请查询

API

6.1.2 链式查询
　　在查询时候，不带回调，而查询条件通过

API

函数来制定，例如：

var query = PersonModel.findOne({'name.last':'dragon'});
query.select('some select');
query.exec(function(err,pserson){
//如果err==null，则person就能取到数据
});

　　这种方式相对直接查询，分的比较明细，如果不带

callback

，则返回

query

，

query

没有执行的预编译查询语句，该

query

对象执行的方法都将返回自己，只有在执行

exec

方法时才执行查询，而且必须有回调。

　　因为

query

的操作始终返回自身，我们可以采用更形象的链式写法

Person
.find({ occupation: /host/ })
.where('name.last').equals('Ghost')
.where('age').gt(17).lt(66)
.where('likes').in(['vaporizing', 'talking'])
.limit(10)
.sort('-occupation')
.select('name occupation')
.exec(callback);

7.Validation

　　数据的存储是需要验证的，不是什么数据都能往数据库里丢或者显示到客户端的，数据的验证需要记住以下规则：

验证始终定义在

SchemaType

中

验证是一个内部中间件

验证是在一个

Document

被保存时默认启用的，除非你关闭验证

验证是异步递归的，如果你的

SubDoc

验证失败，

Document

也将无法保存

验证并不关心错误类型，而通过

ValidationError

这个对象可以访问

7.1 验证器

required

非空验证

min

/

max

范围验证（边值验证）

enum

/

match

枚举验证/匹配验证

validate

自定义验证规则

　　以下是综合案例：

var PersonSchema = new Schema({
name:{
type:'String',
required:true //姓名非空
},
age:{
type:'Nunmer',
min:18,       //年龄最小18
max:120     //年龄最大120
},
city:{
type:'String',
enum:['北京','上海']  //只能是北京、上海人
},
other:{
type:'String',
validate:[validator,err]  //validator是一个验证函数，err是验证失败的错误信息
}
});

7.2 验证失败

　　如果验证失败，则会返回

err

信息，

err

是一个对象该对象属性如下

err.errors                //错误集合（对象）
err.errors.color          //错误属性(Schema的color属性)
err.errors.color.message  //错误属性信息
err.errors.path             //错误属性路径
err.errors.type             //错误类型
err.name                //错误名称
err.message                 //错误消息

　　一旦验证失败，

Model

和

Entity

都将具有和

err

一样的

errors

属性

8.Middleware中间件

8.1 什么是中间件

　　中间件是一种控制函数，类似插件，能控制流程中的

init

、validate

、

save

、

remove`方法

8.2 中间件的分类

　　中间件分为两类

8.2.1 Serial串行
　　串行使用

pre

方法，执行下一个方法使用

next

调用

var schema = new Schema(...);
schema.pre('save',function(next){
//做点什么
next();
});

8.2.2 Parallel并行
　　并行提供更细粒度的操作

var schema = new Schema(...);
schema.pre('save',function(next,done){
//下一个要执行的中间件并行执行
next();
doAsync(done);
});

8.3 中间件特点

　　一旦定义了中间件，就会在全部中间件执行完后执行其他操作，使用中间件可以雾化模型，避免异步操作的层层迭代嵌套

8.4 使用范畴

复杂的验证

删除有主外关联的

doc

异步默认

某个特定动作触发异步任务，例如触发自定义事件和通知

　　例如，可以用来做自定义错误处理

schema.pre('save',function(next){
var err = new Eerror('some err');
next(err);
});
entity.save(function(err){
console.log(err.message); //some err
});