什麼是 JPA
比較正式的說法是：
JPA (Java Persistence API) 是Sun官方提出的Java持久化規範
通俗來說，JPA 其實是一種事先說好的規定，規定它可以做什麼以及應該怎麼做等等。
JPA 可以做什麼
根據我自身的理解，JPA 的主要用途就是將數據庫裏的數據映射成對象 （ORM - Object Relational Mapping），接着我們可以通過調用對象的方法來增刪查改數據。
爲什麼需要 JPA
假設我們現在有一張用戶表 (User table)，裏面的有如下數據：
Users
+----+----------+--------------+
| id | username | email |
+----+--------+----------------+
| 1 | David | [email protected] |
+----+----------+--------------+
| 2 | Kevin | [email protected] |
+----+----------+--------------+
在 JPA 出現之前，我們需要使用 JDBC 來請求數據。然而，如果我們想要使用 JDBC 的話，則必須寫出大量繁瑣的代碼以及越來越複雜的 sql 語句。比如說單單只是想要查詢 id 爲 1 的用戶，就需要寫出如下代碼：
- 定義一個 sql 語句的變量
// 會因爲業務邏輯而變得越來越複雜。比如說還需要獲得 積分，等級，購物歷史記錄等等。
String query = "SELECT * FROM Users WHERE id = 1;";
- 寫出 try catch 語句
try {
// 執行JDBC
} catch (SQLException e) {
// SQLException 爲 checked exception，需要顯式處理異常
}
- 執行 JDBC
Statement stmt = con.createStatement();
ResultSet rs = stmt.executeQuery(query);
- 提取結果
while (rs.next()) {
Long userId = rs.getInt("id");
String userName = rs.getString("username");
// 業務邏輯省略
}
由此可見，如果一個項目的業務邏輯很複雜並且需要經常修改的話，JDBC 將變得非常難以維護。
如何使用 JPA
這裏我會爲大家示範如何在 Spring Boot 裏使用 JPA。
添加依賴
首先我們在 pom.xml 添加依賴。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
創建 User 實體類
@Entity
@Table(name = "Users")
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private int id;
private String username;
private String email;
// 此處省略 getters / setters
}
記得一定要給實體類寫 setters 與 getters 。
創建 JPA Repository 接口
@Repository
public interface UserJpaRepository extends CrudRepository<User, Integer> {
User findById(int id);
}
這裏我們只需要讓我們的 Repository 接口繼承 CrudRepository 接口，第一個泛型需要填寫實體類，第二個泛型則是填寫實體類 id 的數據類型。
我們不需要自己去實現這些方法，因爲 JPA 會幫我們實現這些方法。我們只需要根據命名規則聲明這些方法即可。
基本命名規則：
findBy + {column_name} + {logical_operator} + {column_name} + …
參數規則：
參數的順序爲方法名 column_name 的順序
舉例：
假設我想要查詢 username 爲 David 或者 郵箱爲 [email protected] 的用戶，則我們可以這樣聲明方法：
User findByUsernameOrEmail(String username, String email);
接着通過調用這個方法，我們就會得到一個 User 對象。這個 User 對象的 fields
包括 id, username, email。我們可以通過 getters / setters 來獲得或修改這些數據。這便是 ORM 的概念，通過與 對象 互動來增刪查改數據。
創建 UserService
然後我們創建 UserService 類來實現一些常見的業務邏輯。這裏會示範兩種業務邏輯：
- 根據 id 查詢用戶
- 修改用戶郵箱
@Service
public class UserService {
@Autowired
private UserJpaRepository userJpaRepository;
// 根據 id 查詢用戶
public User findById(int id) {
return userJpaRepository.findById(id);
}
// 修改用戶郵箱
public void changeUserEmailById(int userId, String email) {
User user = this.findById(userId);
user.setEmail(email);
userJpaRepository.save(user);
}
}
可以看到，相較於 JDBC，如果使用 JPA 的話，代碼的可讀性將會得到一個質的提升。
創建 UserController
接下來我們只需要創建相應的 API 接口就可以了。
@RestController
@RequestMapping(value = "/api/v1/users")
public class UserController {
@Autowired
private UserService userService;
@GetMapping(value = "/{id}")
public ResponseEntity<User> getUserById(@PathVariable int id) {
User user = userService.findById(id);
return ResponseEntity.ok().body(user);
}
@PostMapping(value = "/email")
public ResponseEntity<User> changeUserEmail(@RequestBody JSONObject payload) {
String userId = Integer.parseInt((String) payload.get("userId"));
String newEmail = (String) payload.get("newEmail");
userService.changeUserEmailById(userId, newEmail);
return ResponseEntity.ok().body(user);
}
}
示例 URL：
// 查詢 id 爲 1 的用戶
【GET】/api/v1/users/1
// 更改用戶郵箱
【POST】/api/v1/users/email
【PAYLOAD】
{
"userId": "1",
"newEmail": "[email protected]"
}
感謝大家的閱讀！ 感恩哦！
作者仍在學習中， 如果有什麼錯誤，請各位指出幷包含，謝謝！
作者：David Chou（溫哥華 Simon Fraser University 計算機學生）