使用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