【Spring Boot】第7.2課－使用 Spring Data 存取 MongoDB 資料庫，進行基本 CRUD 操作

日期：

https://unsplash.com/photos/LmyPLbbUWhA

準備好 MongoDB 的環境後，就能在 Spring Boot 中存取資料庫了。本文首先展示要儲存的資料內容，接著介紹「Spring Data」框架的特色，建立 ORM / ODM 的概念。

隨後透過「MongoRepository」內建的 CRUD 方法，存取資料庫。而下一篇才會介紹自定義查詢條件。

本文的練習用專案：
https://github.com/ntub46010/SpringBootTutorial/tree/Ch7-1


一、資料類別

以下是自定義的類別，叫做「Student」，用來描述學生資料。

它包含 id、名字、年級、生日、聯繫方式與證照，共 6 個欄位。其中 id 欄位冠上了 @Id 注解，代表它在資料庫中對應到文件的主鍵欄位。

這個類別還冠上了 @Document 注解，代表它是資料庫中的「文件」。並透過 collection 參數，指定「集合」的名稱。參數請不要誤寫成「collation」了。

以下的「Contact」類別是描述聯繫方式，包含信箱與電話這 2 個欄位。

以下的「Certificate」類別是描述證照，包含種類、分數與等級這 3 個欄位。

本文會將 Student 類別的物件，儲存到 MongoDB 資料庫。


二、認識 Spring Data 框架

（一）建立 Repository 介面

如果讀者有用過早期的 JDBC（Java Database Connectivity），應該對存取資料庫的程式流程還留有一點印象，大致包含以下步驟：

  1. 建立資料庫連線。
  2. 撰寫原生 SQL 語法。
  3. 將查詢結果（Result Set），轉換成商業邏輯要用的程式物件。
  4. 釋放資源。

由於太過繁瑣，於是「Spring Data」這套框架封裝了此過程，讓開發者能更輕鬆地存取資料庫。上一篇在專案中添加的「spring-boot-starter-data-mongodb」依賴，就是 Spring Data 的產品之一。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

在第 6 課，我們有練習過建立一個「ProductRepository」介面，將其注入到商業邏輯中。還提供兩種實作類別，分別用 List 與 Map 結構來儲存範例資料。

本節會建立一個特殊的介面，定位與上述的 ProductRepository 相同。但我們不必親自實作它，而是交給框架處理。

這個「StudentRepository」介面繼承了 MongoRepository，並傳入兩個泛型類別，分別是文件與主鍵的類別。其中主鍵的類別，必須和上述 Student 類別中的 id 欄位相同。

（二）查詢語法與物件對映

使用 Spring Data 時，我們最直接感受到的好處，就是「產生查詢語法」與「物件對映」。

在 MongoRepository 介面，以及它的父介面中，已經有內建一些基本方法。舉例來說，我們可以將 Student 物件傳入 repository 的 insert 方法。

僅僅一句程式，Spring Data 就會產生如下的 MongoDB 操作：

db.student.insert(
    {
        "name": "Vincent",
        "grade": 2
        "contact": {
            "email": "vincent@school.com",
            "phone": "0911111111"
        }
    }
);

此時該方法會回傳插入成功的文件資料，且包含由 MongoDB 產生的 id。

又或者是呼叫 findById 方法，則會產生如下的操作：

db.student.find(
    {
        "_id": ObjectId("...")
    }
);

此時該方法除了回傳符合條件的結果，更重要的是文件資料會被轉換成 Java 物件，也就是 Student。

資料庫中的資料，與程式物件互相轉換，這項技術在關聯式資料庫稱為「物件關聯對映」（Object-Relational Mapping，ORM）。而在 MongoDB 則稱為「物件文件對映」（Object-Document Mapping，ODM）。

從上面這兩個例子，我們可看出 Spring Data 會解讀 repository 的方法名稱、傳入參數，以及回傳值型態，產生對應的資料庫語法。而在下一篇，讀者也能依照命名規則，設計出自己的查詢方法，讓操作更簡單。

三、使用 MongoRepository

本節讓我們來實際使用 MongoRepository 提供的內建方法。

為了在程式中有地方呼叫 StudentRepository，讀者可在 Controller 準備 API，屆時便能搭配如 Postman 之類的工具，對後端發送 request。

（一）插入資料

以下提供一支 API，用來建立學生資料。

呼叫 insert 方法即可插入資料。若該資料沒有 id 的值，則 MongoDB 將自行產生。若 id 發生重複，則拋出 DuplicatedKeyException 例外。

該方法最後會回傳含有 id 的資料，此處附加到 response header 中，讓 API 回傳。

（二）取得資料

以下是查詢指定 id 的資料，呼叫 findById 方法即可。

以下是給予 List，查詢多筆指定 id 的資料。呼叫 findAllById 方法即可。

攜帶 query string 存取此 API 的方式，示意如下：

GET /students/ids?idList=111,222,333

由於在資料庫中，文件主鍵的欄位名稱為「_id」，且型態是 Object Id，因此 MongoDB 會做這部份的轉換。

（三）更新資料

以下是更新指定 id 的資料。

在邏輯中，我們先判斷該筆資料是否存在。是的話，就將 request 中的資料更新上去，最後呼叫 save 方法儲存。

這個 save 方法，其實是「upsert」的性質。也就是說，若 id 所對應的資料存在，便進行覆蓋，否則視為插入新資料。

（四）刪除資料

以下是刪除指定 id 的資料，呼叫 deleteById 方法即可。


四、測試資料

若讀者有需要，為了方便下一篇的練習，以下提供一支 API，用途是在資料庫插入 3 筆測試資料。

此處會呼叫 deleteAll 方法，刪除 collection 中的所有資料。接著再呼叫另一個多載的 insert 方法，插入多筆資料。

下圖是透過 GUI 工具「NoSQLBooster」查詢到的內容。

nosqlbooster-find-documents

可確認到 MongoDB 會自動產生「_id」欄位，其型態為 Object Id。


本文都是使用 MongoRepository 內建的方法存取資料庫。下一篇將說明如何設計自己的查詢條件，以及排序方式。

本文的完成專案：
https://github.com/ntub46010/SpringBootTutorial/tree/Ch7-2

上一篇：【Spring Boot】第7.1課－MongoDB 介紹與準備資料庫環境

下一篇：【Spring Boot】第7.3課－在 MongoRepository 定義查詢條件與排序方式

留言

張貼留言