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

---

作者：Jadepeng
出處：jqpeng的技術記事本--http://www.cnblogs.com/xiaoqi
您的支持是對博主最大的鼓勵，感謝您的認真閱讀。
本文版權歸作者所有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責任的權利。