摘要：暫未驗證聲明主鍵。為提供一個默認的構造方法。提供一個不可為的屬性的構造方法以防止出錯。根據字段查詢并排序根據字段查詢并排序，默認是順序。統計對象數量統計對象數量這是調用接口的方法來統計對象數量。
初探 SDJ
先讓我們來鞏固一下 Java 的基礎知識。Java 是面向對象的語言，目的是解決現實生活中的問題，可以通過使用類來包裝現實生活中的事物成對象、使用屬性來描述對象的特點并使用方法來控制對象的行為。我們在 Java 里一切的操作都是針對對象本身，這也是為什么我們需要 ORM 來操作存儲在數據庫里面的“對象”。題外話，對于類似于 Redis 這種基于 Key-Value 存儲的 NoSQL（非關系型數據庫）來說，我們并不能很顯然地觀察到存儲在里面的“對象”，因為這種“對象”不同于關系型數據庫里的對象，比如 MySQL。在 MySQL 中，其 Table 就對應 Java 中的類，每一條 Column 對應的就是對象，每一個字段對應的就是屬性，當然 MySQL 也有自己的方法，不過不在本文討論范圍內。我們可以很直觀地通過 SQL 的查詢語句來觀察“對象”，但在 NoSQL 中，我們只能通過序列化和反序列化來寫和讀對象。相信我，您寧愿看匯編也不想看序列化之后的對象……
為了節省時間，關于用什么和怎么來構建基本環境不在此贅述，這里提供 SDJ 的官方指南之一供您參考，只要您能引用 SDJ 的包（org.springframework.data:spring-data-jpa:1.11.6.RELEAS）就行。
SDJ 對于應用來說最應該關注的就是以下幾個核心接口（按照從子類到父類的繼承順序）：
JpaRepository —— JPA 協議的具體實現的接口。
package org.springframework.data.jpa.repository;
public interface JpaRepository extends PagingAndSortingRepository, QueryByExampleExecutor {}
PagingAndSortingRepository ——分頁和排序的接口。QueryByExampleExecutor ——范例查詢的接口。
package org.springframework.data.repository;
public interface PagingAndSortingRepository extends CrudRepository {}
package org.springframework.data.repository.query;
public interface QueryByExampleExecutor {}
CrudRepository ——通用CRUD操作的接口。
package org.springframework.data.repository;
public interface CrudRepository extends Repository {}
就如同名稱所示，我們可以根據情況繼承特定的接口，不同的接口提供不同的功能，如果我們需要分頁和排序，就繼承 PagingAndSortingRepository 接口。但為了全方位地了解 SDJ，本文使用 JpaRepository 接口，由于其位于繼承樹的最底端，可以理解成二叉樹里面的樹葉，所以可以使用包括其父類的所有未被重寫方法。當然這樣也有一些不影響功能實現的矛盾點，我們一會會見到。
為使用默認的接口方法做準備
如同之前所說，我們需要針對性地通過類來構建一個對象。這里創建一個用戶類（推薦使用 Lombok 來簡化代碼）。
// SDJ 使用 @Entity，NoSQL 使用 @Document。(暫未驗證)
@Entity
public class User {
// 聲明主鍵。
@Id
// 聲明由程序控制主鍵生成策略。
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
// 約束、不可為空、長度16。
@Column(unique = true, nullable = false, length = 16)
private String username;
@Column(unique = true, nullable = false)
private String email;
// 設定默認值。
private Double balance = 0.0;
// 不允許更新。
@Column(updatable = false)
private Date createTime = new Date();
// 為 SDJ 提供一個默認的構造方法。
public User() {
}
// 提供一個不可為 null 的屬性的構造方法以防止出錯。
public User(String username, String email) {
this.username = username;
this.email = email;
}
// 省略一大堆 Getter、Setter 和 ToString 方法。也可以通過 Lombok 插件以注解的方式大幅度簡化，各大 IDE 均提供！
}
然后創建一個簡單到可能懷疑自己人生接口，繼承自 JpaRepository。
import org.springframework.data.jpa.repository.JpaRepository;
import top.cciradih.spring.data.jpa.entity.User;
// 泛型指定了能接受的對象類型和其主鍵類型，主鍵類型在一些方法里很有用。
public interface UserRepository extends JpaRepository {
}
驚不驚喜？意不意外？我們已經可以使用它了！什么都不用寫！
試試接口默認的方法
保存
保存單個對象并返回
// 保存單個對象并返回。
User savedUser = userRepository.save(new User("Cciradih", "hidarichaochen@gmail.com"));
這是調用 CrudRepository 接口的 S save(S entity) 方法來保存并返回存儲的對象。
保存多個對象并返回
// 保存多個對象并返回。
List userList = new ArrayList<>();
User newUser;
for (int i = 0; i < 10; i++) {
newUser = new User("Cciradih" + i, "hidarichaochen@gmail.com" + i);
userList.add(newUser);
}
List savedUserList = userRepository.save(userList);
這是調用 JpaRepository 接口的 List save(Iterable entities) 方法來保存多個對象。
查詢
根據主鍵查詢單個對象
// 根據主鍵查詢單個對象。
User foundUser = userRepository.findOne(1L);
這是調用 CrudRepository 接口的 T findOne(ID id) 方法來查詢單個對象。
查詢全部對象
// 查詢全部對象。
List foundUserList = userRepository.findAll();
這是調用 JpaRepository 接口的 List findAll() 方法來查全部對象。
根據 ID 字段查詢并排序
import org.springframework.data.domain.Sort;
// 根據 id 字段查詢并排序，默認是順序（ASC）。
List foundASCSortedUserList = userRepository.findAll(new Sort("id"));
// 根據 id 字段倒序查詢（DESC）。
List foundDESCSortedUserList = userRepository.findAll(new Sort(Sort.Direction.DESC, "id"));
這里涉及到新的對象—— new Sort("id")。從名字可以看得出來是為了排序的，其內部的具體邏輯在本文就不贅述。通過 JpaRepository 接口的 List findAll(Sort sort) 方法來查詢并排序。
范例查詢
import org.springframework.data.domain.Example;
import org.springframework.data.domain.ExampleMatcher;
User user = new User("Cciradih", "hidarichaochen@gmail.com");
// 1.使用 Example。
// 創建 Example。
Example userExample = Example.of(user);
User foundExampleUser = userRepository.findOne(userExample);
// 2.使用 ExampleMatcher。
// 創建 ExampleMatcher。
ExampleMatcher exampleMatcher = ExampleMatcher.matching()
// 忽略 id 和 createTime 字段。
.withIgnorePaths("id", "createTime")
// 忽略大小寫。
.withIgnoreCase()
// 忽略為空字段。
.withIgnoreNullValues();
// 攜帶 ExampleMatcher。
userExample = Example.of(user, exampleMatcher);
User foundExampleWithExampleMatcherUser = userRepository.findOne(userExample);
這里涉及到 Example 和 ExampleMatcher 的使用。
Example 通過其靜態方法 Example of(T probe) 來引入一個 Example 對象。然后就通過 QueryByExampleExecutor 接口的 S findOne(Example example) 方法來查詢符合范例的對象。當然這里在通常情況下是查詢不到任何對象的，因為 User 有不同的 Id 和某種意義上講不會相同的 createTime。
ExampleMatcher 通過靜態方法 Example of(T probe, ExampleMatcher matcher) 攜帶一個符合的泛型對象和 ExampleMatcher 對象，這里忽略了 id 和 createTime 字段，所以能夠查找到符合條件的對象。
ExampleMatcher 是對 Example 的拓展，這也是為什么我說 SDJ 的控制細膩度依然很高的原因。
關于 ExampleMatcher 更多的過濾方法可以自行參照源碼。
分頁查詢
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
// 分頁查詢，從 0 頁開始查詢 5 個。
Page foundUserPage = userRepository.findAll(new PageRequest(0, 5));
// 分頁表。
List content = foundUserPage.getContent();
// 總數量。
long totalElements = foundUserPage.getTotalElements();
// 總頁數。
long totalPages = foundUserPage.getTotalPages();
// 分頁表大小。
int size = foundUserPage.getSize();
這里涉及到新的對象—— new PageRequest(0, 5)。從名字可以看得出來是為了分頁的，其內部的具體邏輯在本文就不贅述。通過 PagingAndSortingRepository 接口的 Page findAll(Pageable pageable) 方法來查詢 Page 對象。Page 包含了所有分頁需要的屬性，可以通過其方法來獲取。
刪除
根據主鍵刪除單個對象
// 根據主鍵刪除單個對象
userRepository.delete(1L);
這是調用 CrudRepository 接口的 void delete(ID id) 方法來根據主鍵刪除單個對象。
根據對象刪除單個對象
// 根據對象刪除單個對象
User user = new User("Cciradih", "hidarichaochen@gmail.com");
userRepository.delete(user);
這是調用 CrudRepository 接口的 void delete(T entity) 方法來根據對象刪除單個對象。和 Example 的例子一樣，也不會刪除任何對象，請自行思考。
刪除全部
// 刪除全部
userRepository.deleteAll();
這是調用 CrudRepository 接口的 void deleteAll() 方法來根據對象刪除單個對象。
之前提到過的一些不影響功能實現的矛盾點，在這里體現。由于 JpaRepository 間接繼承自 CrudRepository 所以我們可以同時使用 void deleteAllInBatch() 和 void deleteAll() 方法，兩者的功能是一樣的，可以二者取其一。想要避免這樣的事，只能在不影響實際業務邏輯的情況下往上繼承接口。
刪除多個對象
// 刪除多個對象
List userList = new ArrayList<>();
User user;
for (int i = 0; i < 10; i++) {
user = new User("Cciradih" + i, "hidarichaochen@gmail.com" + i);
userList.add(user);
}
userRepository.delete(userList);
這是調用 CrudRepository 接口的 void delete(Iterable entities) 方法來刪除多個對象。和 Example 的例子一樣，也不會刪除任何對象，請自行思考。
統計對象數量
// 統計對象數量
long count = userRepository.count();
這是調用 CrudRepository 接口的 long count() 方法來統計對象數量。
根據主鍵判斷對象是否存在
// 判斷對象是否存在
boolean exists = userRepository.exists(1L);
這是調用 CrudRepository 接口的 boolean exists(ID id) 方法來根據主鍵判斷對象是否存在。
結語
我盡可能地列舉了默認方法，但為了行文方便，其中有些方法是可以配合使用的，比如 JpaRepository 接口的 List findAll(Example example, Sort sort)，可以同時傳入 Example 和 Sort 對象進行查詢，請自行參照源碼使用。
我希望您能夠通過此文對 SDJ 的默認方法達到“知其然”的程度，在軟件開發中，我認為需要從“知其然”到”知其所以然“再到”造其所以然“的地步，但路需要一步一步走。
源碼倉庫
Learn/Spring Data JPA at master · cciradih/Learn
系列目錄
Spring Data JPA 詳盡指南
參考
Spring Data JPA - Reference Documentation
我的咖啡館
如果您對本文有什么建議或者問題，歡迎您來我的咖啡館坐坐338147322。
