使用Spring访问Mongodb的方法大全——Spring Data MongoDB查询指南

1.概述

Spring Data MongoDB 是Spring框架访问mongodb的神器，借助它能够很是方便的读写mongo库。本文介绍使用Spring Data MongoDB来访问mongodb数据库的几种方法：

• 使用Query和Criteria类
• JPA自动生成的查询方法
• 使用@Query 注解基于JSON查询

在开始前，首先须要引入maven依赖

1.1 添加Maven的依赖

若是您想使用Spring Data MongoDB，则须要将如下条目添加到您的pom.xml文件中：

<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-mongodb</artifactId>
    <version>1.9.6.RELEASE</version>
</dependency>

版本根据须要选择。

2.文档查询

使用Spring Data来查询MongoDB的最经常使用方法之一是使用Query和Criteria类 ， 它们很是接近本地操做符。

2.1 is查询

在如下示例中 - 咱们正在寻找名为Eric的用户。

咱们来看看咱们的数据库：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 55
    }
}]

让咱们看看查询代码：

Query query = new Query();
query.addCriteria(Criteria.where("name").is("Eric"));
List<User> users = mongoTemplate.find(query, User.class);

如预期的那样，这个逻辑返回：

{
    "_id" : ObjectId("55c0e5e5511f0a164a581907"),
    "_class" : "org.baeldung.model.User",
    "name" : "Eric",
    "age" : 45
}

2.2 正则查询

正则表达式是一个更灵活和强大的查询类型。这使用了一个使用MongoDB $ regex的标准，该标准返回适用于这个字段的这个正则表达式的全部记录。

它的做用相似于startingWith，endingWith操做 - 让咱们来看一个例子。

寻找名称以A开头的全部用户，这是数据库的状态：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581909"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alice",
        "age" : 35
    }
]

咱们来建立查询：

Query query = new Query();
query.addCriteria(Criteria.where("name").regex("^A"));
List<User> users = mongoTemplate.find(query,User.class);

这运行并返回2条记录：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581909"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alice",
        "age" : 35
    }
]

下面是另外一个简单的例子，此次查找名称以c结尾的全部用户：

Query query = new Query();
query.addCriteria(Criteria.where("name").regex("c$"));
List<User> users = mongoTemplate.find(query, User.class);

因此结果是：

{
    "_id" : ObjectId("55c0e5e5511f0a164a581907"),
    "_class" : "org.baeldung.model.User",
    "name" : "Eric",
    "age" : 45
}

2.3 LT和GT

$ lt（小于）运算符和$ gt（大于）。

让咱们快速看一个例子 - 咱们正在寻找年龄在20岁到50岁之间的全部用户。

数据库是：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 55
    }
}

构造查询：

Query query = new Query();
query.addCriteria(Criteria.where("age").lt(50).gt(20));
List<User> users = mongoTemplate.find(query,User.class);

结果 - 年龄大于20且小于50的全部用户：

{
    "_id" : ObjectId("55c0e5e5511f0a164a581907"),
    "_class" : "org.baeldung.model.User",
    "name" : "Eric",
    "age" : 45
}

2.4 结果排序

Sort用于指定结果的排序顺序。

首先 - 这里是现有的数据：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581909"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alice",
        "age" : 35
    }
]

执行排序后：

Query query = new Query();
query.with(new Sort(Sort.Direction.ASC, "age"));
List<User> users = mongoTemplate.find(query,User.class);

这是查询的结果 - 很好地按年龄排序：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581909"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alice",
        "age" : 35
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    }
]

2.5 分页

咱们来看一个使用分页的简单例子。

这是数据库的状态：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581909"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alice",
        "age" : 35
    }
]

如今，查询逻辑，只须要一个大小为2的页面：

final Pageable pageableRequest = new PageRequest(0, 2);
Query query = new Query();
query.with(pageableRequest);

结果 ：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581907"),
        "_class" : "org.baeldung.model.User",
        "name" : "Eric",
        "age" : 45
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    }
]

为了探索这个API的所有细节，这里是Query和Criteria类的文档。

3.生成的查询方法（Generated Query Methods）

生成查询方法是JPA的一个特性，在Spring Data Mongodb里也可使用。

要作到2里功能，只须要在接口上声明方法便可，

public interface UserRepository 
  extends MongoRepository<User, String>, QueryDslPredicateExecutor<User> {
    ...
}

3.1 FindByX

咱们将经过探索findBy类型的查询来简单地开始 - 在这种状况下，经过名称查找：

List<User> findByName(String name);

与上一节相同 2.1 - 查询将具备相同的结果，查找具备给定名称的全部用户：

List<User> users = userRepository.findByName("Eric");

3.2 StartingWith and endingWith.

下面是操做过程的一个简单例子：

List<User> findByNameStartingWith(String regexp);

List<User> findByNameEndingWith(String regexp);

实际使用这个例子固然会很是简单：

List<User> users = userRepository.findByNameStartingWith("A");
List<User> users = userRepository.findByNameEndingWith("c");

结果是彻底同样的。

3.3 Between

相似于2.3，这将返回年龄在ageGT和ageLT之间的全部用户：

List<User> findByAgeBetween(int ageGT, int ageLT);
List<User> users = userRepository.findByAgeBetween(20, 50);

3.4 Like和OrderBy

让咱们来看看这个更高级的示例 - 为生成的查询组合两种类型的修饰符。

咱们将要查找名称中包含字母A的全部用户，咱们也将按年龄顺序排列结果：

List<User> users = userRepository.findByNameLikeOrderByAgeAsc("A");

结果：

[
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581908"),
        "_class" : "org.baeldung.model.User",
        "name" : "Antony",
        "age" : 33
    },
    {
        "_id" : ObjectId("55c0e5e5511f0a164a581909"),
        "_class" : "org.baeldung.model.User",
        "name" : "Alice",
        "age" : 35
    }
]

4. JSON查询方法

若是咱们没法用方法名称或条件来表示查询，那么咱们能够作更低层次的事情 - 使用@Query注解。

经过这个注解，咱们能够指定一个原始查询 - 做为一个Mongo JSON查询字符串。

4.1 FindBy

让咱们先从简单的，看看咱们是如何将是一个经过查找类型的方法第一：

@Query("{ 'name' : ?0 }")
List<User> findUsersByName(String name);

这个方法应该按名称返回用户 - 占位符?0引用方法的第一个参数。

4.2 $regex

让咱们来看一个正则表达式驱动的查询 - 这固然会产生与2.2和3.2相同的结果：

@Query("{ 'name' : { $regex: ?0 } }")
List<User> findUsersByRegexpName(String regexp);

用法也彻底同样：

List<User> users = userRepository.findUsersByRegexpName("^A");
List<User> users = userRepository.findUsersByRegexpName("c$");

4.3. $ lt和$ gt

如今咱们来实现lt和gt查询：

@Query("{ 'age' : { $gt: ?0, $lt: ?1 } }")
List<User> findUsersByAgeBetween(int ageGT, int ageLT);

5. 结论

在本文中，咱们探讨了使用Spring Data MongoDB进行查询的经常使用方法。

本文示例能够从 spring-data-mongodb这里下载。

本文参考A Guide to Queries in Spring Data MongoDB