登录 注册

Spring Data MongoDB 常用 CRUD 形式总结

本贴最后更新于 2236 天前，其中的信息可能已经时移世易

转载请注明出处 http://blog.arthurpapa.cn/articles/2017/11/05/1509882267235.html
作者：Arthur 联系方式：ArthurHappy@qq.com 博客：blog.arthurpapa.cn

Spring Data 操作 MongoDB 做 CRUD 的时候一般会使用两种方式。本文就这两种方式做个简单的对比介绍，并对我们在业务中经常使用到的查询做一些举例。
其中使用到的 User 类如下
User.java 如下

import org.springframework.data.annotation.*;
import org.springframework.data.mongodb.core.index.Indexed;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "User")
public class User(){
	@Id
	private String _id;
	private String name;
	private Integer age;
		
	// 只在本文最后一部分使用
	// @CreatedDate
	// @Indexed
	// private DateTime createdAt;
	// @LastModifiedDate
	// @Indexed
	// private DateTime updatedAt;
}
​

MongoTemplate 和 MongoRepository 使用介绍

  1. 直接使用 MongoTemplate 形式。
    首先注入 MongoTemplate 

     @Autowired
 MongoTemplate mongoTemplate;
​

    1. insert

       // insert用来插入一条数据
 User user = new User();
 user.setName("Jon");
 mongoTemplate.insert(user, "user");
​

    2. save

       // save的形式在首次插入的时候和insert效果一样
 User user = new User();
 user.setName("Albert"); 
 mongoTemplate.save(user, "user");
​

    3. save - update

       // save 还可以用来更新一条数据	
 user = mongoTemplate.findOne(
 Query.query(Criteria.where("name").is("Jack")), User.class);
 user.setName("Jim");
 mongoTemplate.save(user, "user");
​

    4. updateFirst

      假设我们现在有数据如下：

       [
     {
         "_id" : ObjectId("55b5ffa5511fee0e45ed614b"),
         "_class" : "org.baeldung.model.User",
         "name" : "Alex"
     },
     {
         "_id" : ObjectId("55b5ffa5511fee0e45ed614c"),
         "_class" : "org.baeldung.model.User",
         "name" : "Alex"
     }
 ]
​

      我们使用 updateFirst 更新数据

       Query query = new Query();
 query.addCriteria(Criteria.where("name").is("Alex"));
 Update update = new Update();
 update.set("name", "James");
 mongoTemplate.updateFirst(query, update, User.class);
​

      更新后的数据，我们发现只更新了第一条数据

       [
     {
         "_id" : ObjectId("55b5ffa5511fee0e45ed614b"),
         "_class" : "org.baeldung.model.User",
         "name" : "James"
     },
     {
         "_id" : ObjectId("55b5ffa5511fee0e45ed614c"),
         "_class" : "org.baeldung.model.User",
         "name" : "Alex"
     }
 ]
​

    5. updateMulti

      和上一条 updateFirst 对应的，如果要全部更新，使用 updateMuti，会将上一条例子中所有的 Alex 更新为 James

       Query query = new Query();
 query.addCriteria(Criteria.where("name").is("Alex"));
 Update update = new Update();
 update.set("name", "James");
 mongoTemplate.updateMulti(query, update, User.class);
​

    6. findAndModify

      这个方法其实和上一条类似，只是在更新后会把更新后的内容返回。

       Query query = new Query();
 query.addCriteria(Criteria.where("name").is("Markus"));
 Update update = new Update();
 update.set("name", "Nick");
 User user = mongoTemplate.findAndModify(query, update, User.class);
​

    7. upsert

      查找并更新，如果无法查到，则结合 query 和 update 的信息创建一条新的数据并插入。

       Query query = new Query();
 query.addCriteria(Criteria.where("name").is("Markus"));
 Update update = new Update();
 update.set("name", "Nick");
 mongoTemplate.upsert(query, update, User.class);
​

    8. remove

      删除

       mongoTemplate.remove(user, "user");	
​

  2. 使用 MongoRepository 形式。

    第一步，创建某个 collection 的 repository :

     @Repository
 public interface UserRepository  extends MongoRepository<User, String> {

 }
​

    不同于 mongoTemplate，repository 只需写方法名就能指定做的操作。我们一般只需要对删除和查找做一些自定义。下面就增删改查做一些介绍。

    1. 插入和更新

      MongoRepository 中已经有两个方法，save and insert。和上面的 mongoTemplate 一样，insert 用于插入，save 兼具插入和更新的功能。以下是 MongoRepository 中自带的 save and insert 方法。

       <S extends T> List<S> save(Iterable<S> entites);
 <S extends T> S insert(S entity);
 <S extends T> List<S> insert(Iterable<S> entities);
​

      使用用例

       // 1. 注入
 @Autowired
 UserRepository userRepository;
 // 2. 准备数据
 User user = new User("MIKE");
 User user2 = new User("ARHTUR");
 List<User> users = Arrays.asList(user, user2);
 // 3. insert 插入
 userRepository.insert(user);
 userRepository.insert(users);
 // 4. save 更新
 User user4save = userRepository.findUserByNameIs("ARHTUR");
 userRepository.save(user4save);
​

    2. 查找

      查找可以使用函数名作为查询的条件，几乎所有的简单查询都能用这种方式实现，这种方式也是最简单的方式。

       // 根据name查找 只返回一条
 User findUserByNameIs(String name);
 // 根据name查找 返回匹配的所有数据
 List<User> findUsersByNameIs(String name);
 // 根据name查找，in匹配
 List<User> findUsersByNameIn(List<String> name);
 // 根据名字等于给定名字和年龄大于给定年龄来作为筛选条件
 List<User> findUsersByNameIsAndAgeGreaterThan(String name,Integer age)
​

      类似的还有很多，可以根据 ide 的提示来写，基本上符合我们正常的思维模式。

    3. 删除

      删除和查询基本类似。

       // 删除和name匹配的一条数据
 Integer removeUserByNameIs(String name);
 // 删除所有和name匹配的数据
 Integer removeUsersByNameIs(String name);
 // 根据name查找，删除in匹配的数据
 Integer removeUsersByNameIn(List<String> name);
 // 根据名字等于给定名字和年龄大于给定年龄来作为筛选条件s删除
 Integer removeUsersByNameIsAndAgeGreaterThan(String name,Integer age)
​

两种方式的对比

MongoTemplate 在写法上比 MongoRepository 更复杂一些，但是带来更多的灵活性。对于复杂的查询操作，我们一般使用 MongoTemplate，对于一些简单的查询我们会使用 MongoRepository 。可以这么理解，MongoRepository 只是作为一种对于简单查询的简便操作，而 MongoTemplate 才是我们在做一些复杂查询时的首选。

常见业务问题做法

我们在业务中经常会有这样的情况：判断一个条件是否为空，如果为空就不使用该查询条件作为约束，另外我们也会经常使用到分页功能。
举例：

数据：

[
    {
        "_id" : ObjectId("55b5ffa5511fee0e45ed614b"),
        "_class" : "org.baeldung.model.User",
        "name" : "James",
        "age"  : 12
    },
    {
        "_id" : ObjectId("55b5ffa5511fee0e45ed614c"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alex",
        "age"  : 13
    },
    {
        "_id" : ObjectId("55bsafa5511fee0e45ed6asf"),
        "_class" : "org.baeldung.model.User",
        "name" : "Marray",
        "age"  : 15
    }
]
​

查询要求：能根据给定的 name list 和 age list 查询，给定的如果为空则不作为查询条件。另外给出时间范围作为条件之一，并提供分页功能。 其中 User 为文章开头的 User.java。
实现：

// 请确保names和ages不为null或者自行添加非null判断
public List<User> findUsers(List names,List ages,Date from,Date to,Integer offset,Integer limit){
	Criteria criteria = new Criteria();
	// 非空判断
	if(!names.isEmpty())
		criteria = criteria.and("name").in(names);
	if(!ages.isEmpty())
		criteria = criteria.and("age").in(ages);
	// 时间范围
   criteria.and("createdAt").gte(from).lte(to);
   // 分页条件
   Pageable pageableRequest = new PageRequest(offset, limit);
   // 查询
   return mongoTemplate.find(new Query().addCriteria(criteria).with(pageableRequest), User.class);
}
​

转载请注明出处 http://blog.arthurpapa.cn/articles/2017/11/05/1509882267235.html
作者：Arthur 联系方式：ArthurHappy@qq.com 博客：blog.arthurpapa.cn

  • MongoDB

    MongoDB（来自于英文单词“Humongous”，中文含义为“庞大”）是一个基于分布式文件存储的数据库，由 C++ 语言编写。旨在为应用提供可扩展的高性能数据存储解决方案。MongoDB 是一个介于关系数据库和非关系数据库之间的产品，是非关系数据库当中功能最丰富，最像关系数据库的。它支持的数据结构非常松散，是类似 JSON 的 BSON 格式，因此可以存储比较复杂的数据类型。

    90 引用 • 59 回帖 • 5 关注
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言，是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    3194 引用 • 8214 回帖
  • Spring

    Spring 是一个开源框架，是于 2003 年兴起的一个轻量级的 Java 开发框架，由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构，分层架构允许使用者选择使用哪一个组件，同时为 JavaEE 应用程序开发提供集成的框架。

    946 引用 • 1460 回帖 • 1 关注
上海 位置
1 关注
1 收藏
1 赞同
1 回帖
7.6k 47 1.6k 382 255 101 1 133 5.0k

相关帖子

1 回帖
Spring Data MongoDB 常用 CRUD 形式总结

欢迎来到这里！

我们正在构建一个小众社区，大家在这里相互信任，以平等 • 自由 • 奔放的价值观进行分享交流。最终，希望大家能够找到与自己志同道合的伙伴，共同成长。

注册 关于
请输入回帖内容 ...
  • alanfans •

    马上要用，mark 一下

Arthur
喜欢新朋友,喜欢新技术 上海
回帖
1
 帖子
6
 积分
742