Spring Boot JPA：簡(jiǎn)單高效的數(shù)據(jù)庫(kù)操作利器
引言
JPA（Java Persistence API）是一種Java持久化規(guī)范，并不是具體的實(shí)現(xiàn)，它定義了一套面向?qū)ο蟮年P(guān)系型數(shù)據(jù)庫(kù)操作接口。JPA提供了一些注解和API，用于定義實(shí)體類(lèi)、映射關(guān)系以及數(shù)據(jù)的持久化等方面。JPA的使用可以避免手寫(xiě)SQL語(yǔ)句，提高代碼的可讀性和可維護(hù)性。
環(huán)境準(zhǔn)備
在開(kāi)始使用Spring Boot JPA進(jìn)行開(kāi)發(fā)之前，我們需要完成以下環(huán)境準(zhǔn)備工作：
- 搭建Spring Boot JPA項(xiàng)目的環(huán)境：可以通過(guò)Spring官網(wǎng)提供的Spring Initializr工具快速搭建一個(gè)基本的Spring Boot項(xiàng)目。
- 配置JPA相關(guān)依賴和數(shù)據(jù)源：在pom.xml文件中添加如下依賴（版本號(hào)可根據(jù)實(shí)際情況選擇）：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
</dependency>其中，spring-boot-starter-data-jpa是Spring Boot提供的JPA相關(guān)依賴，而h2則是一個(gè)內(nèi)存型數(shù)據(jù)庫(kù)，方便我們進(jìn)行測(cè)試。如果需要連接其他類(lèi)型的數(shù)據(jù)庫(kù)，還需要引入對(duì)應(yīng)的數(shù)據(jù)庫(kù)驅(qū)動(dòng)依賴。同時(shí)，我們還需要在application.properties或application.yml文件中配置數(shù)據(jù)源相關(guān)信息，例如：
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=username
spring.datasource.password=password實(shí)體類(lèi)定義
在使用JPA進(jìn)行數(shù)據(jù)庫(kù)操作時(shí)，我們需要先定義實(shí)體類(lèi)。實(shí)體類(lèi)是一個(gè)普通的Java類(lèi)，用來(lái)映射關(guān)系型數(shù)據(jù)庫(kù)中的表。每個(gè)實(shí)體類(lèi)都對(duì)應(yīng)著數(shù)據(jù)庫(kù)中的一張表，每個(gè)實(shí)體類(lèi)的屬性則對(duì)應(yīng)著這張表中的字段。
1.定義實(shí)體類(lèi)，并添加注解
我們可以通過(guò)@Entity注解將一個(gè)Java類(lèi)聲明為實(shí)體類(lèi)，并使用@Table注解指定對(duì)應(yīng)的表名。例如：
@Entity
@Table(name = "t_user")
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(nullable = false)
private String name;
@Column(nullable = false)
private Integer age;
//省略getter和setter方法
}上述代碼定義了一個(gè)名為User的實(shí)體類(lèi)，它對(duì)應(yīng)著名為t_user的表。@Id注解用來(lái)標(biāo)識(shí)實(shí)體類(lèi)中的主鍵字段，@GeneratedValue注解用來(lái)指定主鍵生成策略。@Column注解用來(lái)指定字段的屬性，例如nullable表示是否允許為空，length表示長(zhǎng)度等屬性。
2.屬性映射
- @Id：標(biāo)識(shí)主鍵屬性；
- @GeneratedValue：指定主鍵生成策略；
- @Column：指定屬性名和數(shù)據(jù)庫(kù)中字段名的對(duì)應(yīng)關(guān)系；
- @Temporal：指定日期類(lèi)型屬性的映射方式。
3.關(guān)系映射
- @OneToOne：一對(duì)一關(guān)系；
- @OneToMany：一對(duì)多關(guān)系；
- @ManyToOne：多對(duì)一關(guān)系；
- @ManyToMany：多對(duì)多關(guān)系。
Repository接口定義
Repository是Spring Data JPA中的核心概念之一，它是一個(gè)抽象的DAO（Data Access Object）層，用于封裝對(duì)數(shù)據(jù)庫(kù)的訪問(wèn)操作。Repository接口定義了一系列對(duì)實(shí)體類(lèi)進(jìn)行增刪改查等操作的方法，可以方便地進(jìn)行數(shù)據(jù)操作。
例如，對(duì)于User實(shí)體類(lèi)，我們可以這樣定義一個(gè)對(duì)應(yīng)的Repository接口：
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
List<User> findByName(String name);
}上述代碼中，@Repository注解用來(lái)標(biāo)識(shí)該接口為Repository，繼承自JpaRepository接口，并指定泛型參數(shù)分別為實(shí)體類(lèi)類(lèi)型和主鍵類(lèi)型。在接口中定義了一個(gè)findByName方法，用于根據(jù)name屬性查詢用戶列表。
除了使用Spring Data JPA提供的默認(rèn)方法外，我們還可以通過(guò)自定義方法的方式來(lái)擴(kuò)展Repository接口。例如，如果需要按照年齡范圍查詢用戶列表，則可以在UserRepository接口中添加如下方法：
List<User> findByAgeBetween(Integer minAge, Integer maxAge);此外，我們還可以使用@RepositoryDefinition注解來(lái)自定義Repository接口，或者使用@Query注解來(lái)自定義SQL語(yǔ)句以執(zhí)行更復(fù)雜的數(shù)據(jù)庫(kù)操作。例如：
@RepositoryDefinition(domainClass = User.class, idClass = Long.class)
public interface CustomUserRepository {
@Query("SELECT u FROM User u WHERE u.age >= :minAge AND u.age <= :maxAge")
List<User> findByAgeRange(@Param("minAge") Integer minAge, @Param("maxAge") Integer maxAge);
}上述代碼中，使用@RepositoryDefinition注解來(lái)自定義Repository接口，指定了實(shí)體類(lèi)類(lèi)型和主鍵類(lèi)型。在接口中定義了一個(gè)findByAgeRange方法，使用@Query注解指定查詢語(yǔ)句，并通過(guò)@Param注解綁定參數(shù)值。
測(cè)試代碼編寫(xiě)
在使用Spring Data JPA進(jìn)行開(kāi)發(fā)時(shí)，通常需要編寫(xiě)測(cè)試代碼來(lái)驗(yàn)證CRUD操作的功能是否正確。我們可以使用Junit框架進(jìn)行單元測(cè)試。
例如，對(duì)于User實(shí)體類(lèi)和UserRepository接口，我們可以編寫(xiě)如下測(cè)試代碼：
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserRepositoryTest {
@Autowired
private UserRepository userRepository;
@Test
public void testCrudOperations() {
// 創(chuàng)建一個(gè)新用戶
User user = new User();
user.setName("張三");
user.setAge(18);
// 插入新用戶
userRepository.save(user);
Long userId = user.getId();
// 根據(jù)ID查詢用戶
Optional<User> optionalUser = userRepository.findById(userId);
Assert.assertTrue(optionalUser.isPresent());
// 更新用戶信息
user.setAge(20);
userRepository.save(user);
// 根據(jù)name查詢用戶列表
List<User> userList = userRepository.findByName("張三");
Assert.assertEquals(1, userList.size());
// 刪除用戶
userRepository.delete(user);
// 驗(yàn)證用戶已被刪除
optionalUser = userRepository.findById(userId);
Assert.assertFalse(optionalUser.isPresent());
}
}多表關(guān)聯(lián)
假設(shè)有兩個(gè)實(shí)體類(lèi)，一個(gè)是訂單 Order，另一個(gè)是商品 Item，每個(gè)訂單中都包含多個(gè)商品。
1.定義實(shí)體類(lèi)
@Entity
@Table(name="orders")
public class Order {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@OneToMany(mappedBy = "order", cascade = CascadeType.ALL)
private List<Item> items;
// getters/setters
}@Entity
@Table(name="items")
public class Item {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@ManyToOne
@JoinColumn(name="order_id")
private Order order;
// getters/setters
}2.屬性映射和關(guān)系映射
- Order 實(shí)體類(lèi)中使用了 @OneToMany 注解表示一對(duì)多關(guān)系，mappedBy 參數(shù)指定了 Item 實(shí)體類(lèi)中與 Order 相關(guān)的屬性名。
- Item 實(shí)體類(lèi)中使用了 @ManyToOne 注解表示多對(duì)一關(guān)系，JoinColumn 注解指定了外鍵名稱(chēng)。
3.測(cè)試代碼
@RunWith(SpringRunner.class)
@SpringBootTest
public class OrderRepositoryTest {
@Autowired
private OrderRepository orderRepository;
@Test
public void testSaveOrder() {
Order order = new Order();
List<Item> items = new ArrayList<>();
Item item1 = new Item();
Item item2 = new Item();
item1.setOrder(order);
item2.setOrder(order);
items.add(item1);
items.add(item2);
order.setItems(items);
orderRepository.save(order);
Order savedOrder = orderRepository.findById(order.getId()).get();
assertThat(savedOrder.getItems().size()).isEqualTo(2);
}
}至此就完成了多表關(guān)聯(lián)查詢操作。
