Eggjs笔记：MongoDB索引、explain及Mongoose索引、内置CURD、扩展Mongoose Model的静态和实例方法

Wang's Blog

已于 2022-08-04 23:40:26 修改

阅读量898

点赞数

CC 4.0 BY-SA版权

分类专栏： Full Stack NodeJs DataBase 文章标签： mongodb 数据库 nosql

于 2020-04-03 20:26:45 首次发布

本文链接：https://blog.youkuaiyun.com/Tyro_java/article/details/105299175

Full Stack 同时被 3 个专栏收录

94 篇文章

订阅专栏

NodeJs

68 篇文章

订阅专栏

DataBase

53 篇文章

订阅专栏

本文探讨MongoDB的索引原理及优化策略，包括复合索引、唯一索引的创建与应用，以及如何利用Mongoose简化索引设置。深入讲解索引参数、背景创建、唯一性检查，同时提供Mongoose内置CURD方法和自定义方法示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

关于索引

索引是对数据库表中一列或多列的值进行排序的一种结构，可以让我们查询数据库变得更快
MongoDB 的索引几乎与传统的关系型数据库一模一样，这其中也包括一些基本的查询优化技巧
创建索引 $ db.user.ensureIndex({"username":1})
获取当前集合的索引 $ db.user.getIndexes()
删除索引 $ db.user.dropIndex({"username":1})

创建复合索引

在MongoDB中，同样可以创建复合索引
数字 1 表示 username 键的索引按升序存储，-1 表示 age 键的索引按照降序方式存储
- $ db.user.ensureIndex({"username":1, "age":-1})
- 该索引被创建后，基于username和age的查询将会用到该索引
- 或者是基于username的查询也会用到该索引，但是只是基于age的查询将不会用到该复合索引
- 因此可以说，如果想用到复合索引，必须在查询条件中包含复合索引中的前N个索引列
- 然而如果查询条件中的键值顺序和复合索引中的创建顺序不一致的话
- MongoDB 可以智能的帮助我们调整该顺序，以便使复合索引可以为查询所用
- 如：$ db.user.find({"age": 30, "username": "stephen"})
- 对于上面示例中的查询条件，MongoDB在检索之前将会动态的调整查询条件文档的顺序，以使该查询可以用到刚刚创建的复合索引
- 对于上面创建的索引，MongoDB都会根据索引的keyname和索引方向为新创建的索引自动分配一个索引名
- 在创建索引时为其指定索引名 $ db.user.ensureIndex({"username":1},{"name":"userindex"})
随着集合的增长，需要针对查询中大量的排序做索引
如果没有对索引的键调用sort，MongoDB需要将所有数据提取到内存并排序
因此在做无索引排序时，如果数据量过大以致无法在内存中进行排序，此时 MongoDB 将会报错

唯一索引

在缺省情况下创建的索引均不是唯一索引
创建唯一索引示例：$ db.user.ensureIndex({"userid":1},{"unique":true})
如果再次插入userid重复的文档时，MongoDB 将报错，以提示插入重复键，如:
```
db.user.insert({"userid":5})
db.user.insert({"userid":5})
```
- 出现错误 E11000 duplicate key error index: user.user.$userid_1 dup key: { : 5.0 }
如果插入的文档中不包含 userid 键，那么该文档中该键的值为null
如果多次插入类似的文档，MongoDB 将会报出同样的错误，如：
```
db.user.insert({"userid1":5})
db.user.insert({"userid1":5})
```
- 出现错误 E11000 duplicate key error index: user.user.$userid_1 dup key: { : null }

如果在创建唯一索引时已经存在了重复项，我们可以通过下面的命令帮助我们在创建唯一索引时消除重复文档，仅保留发现的第一个文档，如：

# 先删除刚刚创建的唯一索引
db.user.dropIndex({"userid":1})
# 插入测试数据，以保证集合中有重复键存在
db.user.remove()
db.user.insert({"userid":5})
db.user.insert({"userid":5})
# 重新创建唯一索引
db.user.ensureIndex({"userid":1},{"unique":true})

我们同样可以创建复合唯一索引，即保证复合键值唯一即可
- $ db.user.ensureIndex({"userid":1,"age":1},{"unique":true})

索引的一些参数

Parameter	Type	Description
background	Boolean	建索引过程会阻塞其它数据库操作，background可指定以后台方式创建索引，即增加 "background" 可选参数。 "background" 默认值为false
unique	Boolean	建立的索引是否唯一。指定为true创建唯一索引。默认值为false
name	string	索引的名称。如果未指定，MongoDB的通过连接索引的字段名和排序顺序生成一个索引名称。
dropDups	Boolean	3.0+版本已废弃。在建立唯一索引时是否删除重复记录, 指定 true 创建唯一索引。默认值为 false
...	...	...

更多参数查阅：https://www.runoob.com/mongodb/mongodb-indexing.html
如果在为已有数据的文档创建索引时，可以执行下面的命令，以使 MongoDB 在后台创建索引，这样的创建时就不会阻塞其他操作
- $ db.user.ensureIndex({"username":1},{"background":true})
但是相比而言，以阻塞方式创建索引，会使整个创建过程效率更高，但是在创建时 MongoDB 将无法接收其他的操作

使用 explain

explain 是非常有用的工具，会帮助你获得查询方面诸多有用的信息
只要对游标调用该方法，就可以得到查询细节

explain 会返回一个文档，而不是游标本身, 如：

> db.user.find().explain()
{
    "queryPlanner" : {
        "plannerVersion" : 1,
        "namespace" : "eggcms.user",
        "indexFilterSet" : false,
        "parsedQuery" : {
            
        },
        "queryHash" : "8B3D4AB8",
        "planCacheKey" : "8B3D4AB8",
        "winningPlan" : {
            "stage" : "COLLSCAN",
            "direction" : "forward"
        },
        "rejectedPlans" : [ ]
    },
    "serverInfo" : {
        "host" : "Johnny",
        "port" : 27017,
        "version" : "4.2.2",
        "gitVersion" : "a0bbbff6ada159e19298d37946ac8dc4b497eadf"
    },
    "ok" : 1
}
>

explain 会返回查询使用的索引情况，耗时和扫描文档数的统计信息

explain executionStats 查询具体的执行时间

db.tablename.find().explain( "executionStats" )

关注输出的如下数值：explain.executionStats.executionTimeMillis

> db.user.find().explain("executionStats")
{
    "queryPlanner" : {
        "plannerVersion" : 1,
        "namespace" : "eggcms.user",
        "indexFilterSet" : false,
        "parsedQuery" : {
            
        },
        "winningPlan" : {
            "stage" : "COLLSCAN",
            "direction" : "forward"
        },
        "rejectedPlans" : [ ]
    },
    "executionStats" : {
        "executionSuccess" : true,
        "nReturned" : 2,
        "executionTimeMillis" : 0,
        "totalKeysExamined" : 0,
        "totalDocsExamined" : 2,
        "executionStages" : {
            "stage" : "COLLSCAN",
            "nReturned" : 2,
            "executionTimeMillisEstimate" : 0,
            "works" : 4,
            "advanced" : 2,
            "needTime" : 1,
            "needYield" : 0,
            "saveState" : 0,
            "restoreState" : 0,
            "isEOF" : 1,
            "direction" : "forward",
            "docsExamined" : 2
        }
    },
    "serverInfo" : {
        "host" : "Johnny",
        "port" : 27017,
        "version" : "4.2.2",
        "gitVersion" : "a0bbbff6ada159e19298d37946ac8dc4b497eadf"
    },
    "ok" : 1
}
>

Mongoose 索引

索引是对数据库表中一列或多列的值进行排序的一种结构，可以让我们查询数据库变得更快
MongoDB 的索引几乎与传统的关系型数据库一模一样，这其中也包括一些基本的查询优化技巧

一般设置索引的几种方式

通过命令行设置
通过可视化工具设置

通过Schema给字段配置索引(在定义Schema的时候指定创建索引)

// 这里sn设备的串号，比较唯一，有利于查询速度的优化
const DeviceSchema = new mongoose.Schema({
    sn: {
        type: Number, 
        unique: true // 设置唯一索引
    }, 
    name: {
        type: String, 
        index: true // 设置普通索引
    }
});

每次new出一个新的设备，该数据会自动添加上索引

设置索引是为了优化查询速度，有些字段基本用不着就不用给它设置索引，因为设置索引会使得数据库表的增加速度减慢
查看是否设置了索引和详细信息 $ db.yourcollectionname.getIndexes()

Mongoose内置的CURD

所有API：https://mongoosejs.com/docs/api.html
关于Model: https://mongoosejs.com/docs/api/model.html
常用的一些 https://mongoosejs.com/docs/queries.html
- Model.deleteMany()
- Model.deleteOne()
- Model.find()
- Model.findById()
- Model.findByIdAndDelete()
- Model.findByIdAndRemove()
- Model.findByIdAndUpdate()
- Model.findOne()
- Model.findOneAndDelete()
- Model.findOneAndRemove()
- Model.findOneAndUpdate()
- Model.replaceOne()
- Model.updateMany()
- Model.updateOne()

扩展Mongoose CURD方法

示例：

在app/model/user.js中

var mongoose=require('./db.js');
var UserSchema=mongoose.Schema({
    name:{
        type:String
    },
    age:Number,
    status:{
        type:Number, 
        default:1
    }
})

// 静态方法
UserSchema.statics.findByUid = function(uid,cb){
    this.find({"_id":uid},function(err,docs){
        cb(err,docs)
    })
}

// 实例方法
UserSchema.methods.print = function() {
    console.log('这是一个实例方法');
    console.log(this);
};

module.exports=mongoose.model('User',UserSchema,'user');

在app/controller/user.js中调用

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

// 此处举例，传入参数是硬编码 调用静态方法
UserModel.findBySn('123456782',function(err,docs){
    if(err) {
        console.log(err);
        return;
    }
    console.log(docs)
});

var user = new UserModel({
    name: '赵六',
    sn:'123456781',
    age: 29
});
// user.save(); // 添加

user.print();   // 调用自定义的实例方法

关于静态方法和实例方法

实例方法：需要通过new出来一个实例来调用方法
静态方法：直接调用挂载在类上的方法，不需要实例化

这里通过两种方式来实现

1 ） ES5的方式实现

function Person(){
    this.run1 = function() {}
}

Person.name='哈哈哈';
// 静态方法
Person.run2 = function(){
}
var p = new Person();
// 静态方法的调用
Person.run2();
// 实例方法
p.run1();

2 ）typescript中实现

类似ES6, 不再举例

//ts中
class Per {
     public name:string;
     public age:number=20;

     //静态属性
     static sex="男";
     constructor(name:string) {
             this.name=name;
     }
     /*实例方法*/
     run(){

         alert(`${this.name}在运动`)
     }
     work(){

         alert(`${this.name}在工作`)
     }
     static print(){  /*静态方法  里面没法直接调用类里面的属性*/

         alert('print方法'+Per.sex);
     }
 }
 
 // var p=new Per('张三');
 // p.run();
 Per.print();
 alert(Per.sex);