1. 程式人生 > >使用Spring訪問Mongodb的方法大全——Spring Data MongoDB查詢指南

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

轉載自