Spring Data MongoDB方法使用總結

1.概述

Spring Data MongoDB 是Spring框架訪問mongodb的神器，藉助它可以非常方便的讀寫mongo庫。本文介紹使用Spring Data MongoDB來訪問mongodb數據庫的幾種方法：

使用Query和Criteria類
JPA自動生成的查詢方法
使用@Query 註解基於JSON查詢

1.1 添加maven依賴

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

2.使用Query和Criteria類查詢DB

對於這一種方式，我將分一下幾點來詳細給大傢俱體的使用方法。

is查詢
in查詢
正則查詢（模糊匹配）
LT和GT
Criteria類方法總結
排序
分頁
特殊場景一：Criteria.orOperator
特殊場景二：Query.fields().exclude(“messageText”)
MongoTemplate.find()與MongoTemplate.count()

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 in查詢

當我們需要查詢name爲“Eric”和“Antony”的User時，需要使用到in查詢。
首先我們來看看我們的數據庫：

[
    {
        "_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();
List<String> names = Arrays.asList("Eric","Antony");
query.addCriteria(Criteria.where("name").in(names));
List<User> users = mongoTemplate.find(query,User.class);

這運行並返回2條記錄：

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

2.3 正則查詢（模糊匹配）

正則表達式是一個更靈活和強大的查詢類型。這使用了一個使用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.4 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.5 Criteria類方法總結

通過查看Criteria類的源碼，發現它還有很多類似的方法，這裏我把常用的幾種以表格形式總結如下：

Criteria類方法	對應字符串
Criteria.ne()	$ne ----> 不等於
Criteria.lte()	$lte ----> 小於等於
Criteria.gte()	$ne ----> 大於等於
Criteria.exists()	$exists ----> 是否存在

2.6 排序

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.7 分頁

我們來看一個使用分頁的簡單例子。

這是數據庫的狀態：

[
    {
        "_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
    }
]

2.8 特殊場景一：Criteria.orOperator

假設這樣一個場景：有一個Student類，這個類裏面有一個字段Score，這個Score本身又是一個類，裏面包含languageScore、mathScore, englishScore三個字段。現在需要查詢任何一科分數等於90的Student，這時就需要用到Criteria.orOperator。具體的寫法如下：

Criteria criteria = new Criteria();
criteria.orOperator(Criteria.where("Score.languageScore").is(90),
                    Criteria.where("Score.mathScore").is(90),
                    Criteria.where("Score.englishScore").is(90));
Query query = new Query(criteria );
List<Student> students = mongoTemplate.find(query,Student.class);

2.9 特殊場景二：Query.fields().exclude(“field”)

假設這樣一個場景：有一個Student類，它裏面有name、age、describle、height等字段，其中describle字段代表對這個學生的描述，一般內容比較長。於是，當我們在查詢Student時，我並不是很關注describle信息，這時爲了提高提高前臺查詢顯示的效率，我們可以使用Query.fields().exclude(“dexcrible”)，去忽略這個字段。這樣最後返回的Student集合中將不會包含這一個字段信息。具體代碼如下：

Criteria criteria = new Criteria();
criteria.orOperator(Criteria.where("Score.languageScore").is(90),
                    Criteria.where("Score.mathScore").is(90),
                    Criteria.where("Score.englishScore").is(90));
Query query = new Query(criteria );
query.fields().exclude("dexcrible");
List<Student> students = mongoTemplate.find(query,Student.class);

2.10 MongoTemplate.count()

當我們只關注查詢的記錄數目時，可以使用MongoTemplate.count()這一個方法，十分方便，而不用等查詢出來在去統計個數。

更多關於MongoTemplate的方法可以查看MongoTemplate類的源碼，一般可以通過方法的命名就知道所實現的功能。

3. JPA自動生成的查詢方法

生成查詢方法是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
    }
]

3.5 總結

關於這一類，比較麻煩的地方就是不知道有哪些方法是JPA自動生成的。除了通過idea的提示可以做一部分判斷，另一個方法還是要通過查看源碼來判斷。通過查看代碼，發現每個類的Repository類都會繼承MongoRepository，而MongoRepository繼承了PagingAndSortingRepository，PagingAndSortingRepository繼承CrudRepository，CrudRepository繼承Repository。所以這幾個Repository中已經有的方法都是JPA可以自動生成的。使用某一具體方法時可以在這幾個Repository中查找是否有對應方法

3.6 注意

在這裏我們需要區分兩種情況：一種是；本身的Repository類繼承的那一些Repository提供的基本的數據操作方法，包含基本的增刪改查、分頁查詢、排序查詢等，對於這一種，在創建的Repository類中是不需要再申明方法的。另一種是我們可以自己寫一些簡單的方法，這些方法只需要符合Spring Data制定的那一類規範就能被其識別出來，對於這一種就需要在Repository類中聲明方法。
在前面這兩種方法都不能滿足你的需要時，就需要用到下面這種@Query方式了。

4. 使用@Query 註解基於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);

4.3 其他

排序
一下語句代表按照updatedDate字段正序排序。

@Query(value = "{'exceptionStatus':'UNPROCESSED','forceReprocess':true}", sort = "{'updatedDate':1}")

當爲sort = "{‘updatedDate’:-1}時，代表逆序

表中含有類的字段時

@Query(value = "{?#{'Score.'+[0]}:?1 ,'status': ?2 }",sort = "{'age':1}")

上面的[0]代表Score類裏面的某個字段屬性（可能爲languageScore、mathScore, englishScore,[1]代表具體的查詢分數

以上就是Spring Data MongoDB方法的幾種情況總結。本文有參考如下鏈接：

https://www.cnblogs.com/xiaoqi/p/queries-in-spring-data-mongodb.html
https://docs.spring.io/spring-data/mongodb/docs/2.2.2.RELEASE/reference/html/#reference

dglsx123

發佈了22 篇原創文章 · 獲贊 6 · 訪問量 2萬+

私信關注

Spring Data MongoDB方法使用總結

1.概述

1.1 添加maven依賴

2.使用Query和Criteria類查詢DB

2.1 is查詢

2.2 in查詢

2.3 正則查詢（模糊匹配）

2.4 LT和GT

2.5 Criteria類方法總結

2.6 排序

2.7 分頁

2.8 特殊場景一：Criteria.orOperator

2.9 特殊場景二：Query.fields().exclude(“field”)

2.10 MongoTemplate.count()

3. JPA自動生成的查詢方法

3.1 FindByX

3.2 StartingWith and endingWith

3.3 Between

3.4 Like和OrderBy

3.5 總結

3.6 注意

4. 使用@Query 註解基於JSON查詢

4.1 FindBy

4.2 $regex

4.3 $ lt和$ gt

4.3 其他

Win10下安裝RabbitMQ[教程和安裝包]

Spring Data MongoDB方法使用總結

ElasticSearch 啓動時出現閃退問題解決

SOA、Rest、Soap、RPC概念理解與區分

JavaScript中Date對象使用總結

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結