spring-data-mongodb常用操作

刚接触mongodb不久。踩到许多坑，记录下一些基于spring-data-mongodb的东西吧

首先。应该了解下什么情况下使用mongodb，什么情况下用mysql：

1. 业务需要事物，使用mysql，因为mongodb不支持事物
2. 数据量大，但是数据本身价值不大，使用mongodb
3. 数据是非结构化的，且数据量大，使用mongodb
4. 业务未来走向不明确，使用mongodb，方便扩展

链接：csdn上关于什么时候使用mongodb的博客

简单使用

下面开始接入spring-data-mongodb
使用maven和spring-boot,pom文件里引入依赖即可

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

在java代码里，向集合的实体类上面加上@Document，表示这个类被spring-data-mongodb标识了，可以映射成mongodb里的一个集合，默认名字就是类名，也可以取别名@Document(collection="alias"),示例如下：

@Document
public class Example{
    private String id;
    private String picture;
}

注意，String类型的id属性不可缺少，因为mongodb的每个文档都要有一个id(也可以是其他类型的Id,详情可以去官方文档看看),setget方法我就不贴了，用lombok更方便。
这里就可以直接new 一个Example保存了，所以现在建个Repositry用于保存数据
非常简单只要继承一个接口就可以
public interface ExampleRepository extends CrudRepository<Example, String> {}
这里第一个泛型是上面的文档对象实体，第二个泛型是文档的id类型
然后就可以直接用exampleRepositry.save（example）保存文档了。简单的介绍就到这里

自定义实现复杂查询，修改等操作

定义一个Repository类，并加上@Repository注解，然后添加自己的方法就可以了，下面上代码

@Repository
public class ExampleAdvancedRepository {
    @Autowired
    private MongoOperations mongoOperations;

    public boolean updateAlias(String id, String alias) {
        return mongoOperations.updateFirst(
                query(where("id").is(id)),
                new Update().set("alias", alias),
                Example.class).isUpdateOfExisting();
    }
}

简单的一个实例，根据Id修改别名，这里一点要说的就是这个id属性我们传入进去是String类型，但是monogdbTemplate会将这个id转成ObjectId，但是只局限于这个文档属性名叫id的，如果是其他属性比如userId，虽然也是ObjectId，但是用where("userId").is(userId)这样查询是失败的，因为这里的userId并没有转成ObjectId，正确的做法是where("userId").is(new ObjectId(userId))

数组操作：
增：只要push进数组里就行

public boolean createReply(Reply reply) {
    return mongoOperations.updateFirst(
            query(where("id").is(reply.getCommentId())),
            new Update()
                    .inc("total_replies", 1)
                    .push("replies", reply),
            Comment.class).isUpdateOfExisting();
}

删：删除操作构建一个带id的DB对象，然后丢进pull方法里就行了，代码如下

public boolean deleteReply(String commentId, String replyId) {
    BasicDBObject object = new BasicDBObject();
    object.put("id", replyId);
    return mongoOperations.updateFirst(
            query(where("id").is(commentId)),
            new Update()
                    .inc("total_replies", -1)
                    .pull("replies", object),
            Comment.class).isUpdateOfExisting();
}

这个示例删除了数组里某个对象，所以要使用传入一个删除对象的id，如果数组里存的就是数字，或者字符串就可以直接pull("users","张三")
改：

1. 数组里的对象修改，用占位符即可，代码如下

public boolean createReplyVote(String commentId, String replyId, String userId) {
    return mongoOperations.updateFirst(
            query(where("id").is(commentId).andOperator(
                    where("replies.id").is(new ObjectId(replyId)))),
            new Update()
                    .addToSet("replies.$.voter_ids", userId)
                    .inc("replies.$.total_voters", 1),
            Comment.class).isUpdateOfExisting();
}

用占位符$表示数组里的某个匹配的元素

1. 数组里嵌套数组，更新里面数组里的某个对象的属性
   根据上面的方法，发现要用2个占位符，比如set("replies.$.voters.$.name","李四")但是这种写法是错误的。这种情况在mongodb3.6之前是没办法解决的，只能将数组嵌套数组的结构改变，变成Map的形式，不能出现两个占位符的情况，或者修改设计，将里边的数组拿出来作为独立的文档

索引

建立索引可以使用mongodb的脚本去建立，也可以用spring-data-mongo提供的注解建立索引
下面弄个简单的索引，代码如下：

@Document
@CompoundIndexes({
        @CompoundIndex(def = "{'userId': 1, 'createdDate': -1}")
})
public class Example {
    private String id;
    private String userId;
    private Date createdDate;
}

这里建立 了一个简单的聚合索引，根据userId和createdDate建立的索引。

查看索引是否起效果，可以使用explain方法查看执行计划，示例如下
collection结构

{ 
    "_id" : ObjectId("5b0cc0f2fde29f2ea0641b16"), 
    "userId" : "1",
    "createdDate" : ISODate("1995-09-30T16:00:00.000+0000"), 
    "gender" : "MALE"
}

执行语句db.Example.find({"userId":"1"}).explain();
可以查看到结果

{
    "queryPlanner": {
        "plannerVersion": 1.0,
        ...
        "winningPlan": {
            "stage": "FETCH",
            "inputStage": {
                "stage": "IXSCAN",
                "keyPattern": {
                    "user_id": 1.0,
                    "created_date": -1.0
                },
                "indexName": "user_id_1_created_date_-1",
                "isMultiKey": false,
                "isUnique": false,
                "isSparse": false,
                "isPartial": false,
                "indexVersion": 1.0,
                "direction": "forward",
                "indexBounds": {
                    "user_id": ["[\"22\", \"22\"]"],
                    "created_date": ["[MaxKey, MinKey]"]
                }
            }
        },
        "rejectedPlans": []
    }
    ...
}

可以看到关键的信息，winningPlan 表示走了索引，然后是具体的信息，rejectedPlans表示没有走的索引

外键引用@DBRef

在使用mongdb的时候经常会遇到一个集合嵌套了另一个集合的情况，如果不用引用的话，就得自己手动写代码冗余数据，修改的时候就比较麻烦，要同时修改多处。用mongodb提供的$ref 能很好的解决这个问题
首先写个例子

@Document
public class Clazz{
    private String id;
    private String name;
    @DBRef
    private People leader;
}

@Document
public class People{
    private String id;
    private String name;
    private Integer gender;
    private Integer age;
}

每个班级都需要个班主任leader，这个时候用外键非常合适使用很简单,只要在要用到外键的字段上，加上@DBRef就可以了。先创建个People集合，保存写people信息，然后再创建Clazz集合，可以发现Clazz存储的时候leader变成了一个引用类型。

{ 
    "_id" : ObjectId("5b10a741628e881fc8848d21"), 
    "name" : "王大锤",
    "leader" : DBRef("People", ObjectId("5b0cf065fde29f25486bf532")), 
}

那么查询的时候，如果要根据leader查询班级怎么办，@DBRef的查询也非常简单。

public Clazz findByLeaderId(String leaderId) {
    return mongoOperations.findOne(
            query(where("leader.$id").is(new ObjectId(leaderId))),
            GhostFriend.class);
}

这里注意2个地方，第一个就是引用的时候要加上$id,这样才能表示此id是引用，第二个地方就是new ObjectId() 在自定义复杂查询哪里有提到为什么要new ObjectId()

数组操作里有些特殊的场景

1.队列（先进先出）
比如我要保留最新的3个浏览记录，那么就应该建立一个数组，先进的先删除，永远保留3个元素

public boolean updateHistory(String id,History history) {
    return mongoOperations.updateFirst(
            query(where("id").is(id)),
            new Update()
                    .push("histories").slice(-3).each(history)
            People.class).isUpdateOfExisting();
}

这里利用了slice接收int类型的值，表示截取多少个元素，正值则是从前到后保留，负值表示从后到前保留，each则表示加入数组的元素
这里只是做一个简单的介绍，网上中文资料不多。详情可以查看mongodb官方文档slice用法