什么是 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 计算机学生）
