引言
JPA(Java Persistence API)是一种Java持久化规范,并不是具体的实现,它定义了一套面向对象的关系型数据库操作接口。JPA提供了一些注解和API,用于定义实体类、映射关系以及数据的持久化等方面。JPA的使用可以避免手写SQL语句,提高代码的可读性和可维护性。
环境准备
在开始使用Spring Boot JPA进行开发之前,我们需要完成以下环境准备工作:
- 搭建Spring Boot JPA项目的环境:可以通过Spring官网提供的Spring Initializr工具快速搭建一个基本的Spring Boot项目。
- 配置JPA相关依赖和数据源:在pom.xml文件中添加如下依赖(版本号可根据实际情况选择):
<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相关依赖,而h2则是一个内存型数据库,方便我们进行测试。如果需要连接其他类型的数据库,还需要引入对应的数据库驱动依赖。同时,我们还需要在application.properties或application.yml文件中配置数据源相关信息,例如:
spring.datasource.driver-class-name=org.h2.Driver
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.username=username
spring.datasource.password=password
实体类定义
在使用JPA进行数据库操作时,我们需要先定义实体类。实体类是一个普通的Java类,用来映射关系型数据库中的表。每个实体类都对应着数据库中的一张表,每个实体类的属性则对应着这张表中的字段。
1.定义实体类,并添加注解
我们可以通过@Entity注解将一个Java类声明为实体类,并使用@Table注解指定对应的表名。例如:
@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方法
}
上述代码定义了一个名为User的实体类,它对应着名为t_user的表。@Id注解用来标识实体类中的主键字段,@GeneratedValue注解用来指定主键生成策略。@Column注解用来指定字段的属性,例如nullable表示是否允许为空,length表示长度等属性。
2.属性映射
- @Id:标识主键属性;
- @GeneratedValue:指定主键生成策略;
- @Column:指定属性名和数据库中字段名的对应关系;
- @Temporal:指定日期类型属性的映射方式。
3.关系映射
- @OneToOne:一对一关系;
- @OneToMany:一对多关系;
- @ManyToOne:多对一关系;
- @ManyToMany:多对多关系。
Repository接口定义
Repository是Spring Data JPA中的核心概念之一,它是一个抽象的DAO(Data Access Object)层,用于封装对数据库的访问操作。Repository接口定义了一系列对实体类进行增删改查等操作的方法,可以方便地进行数据操作。
例如,对于User实体类,我们可以这样定义一个对应的Repository接口:
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
List<User> findByName(String name);
}
上述代码中,@Repository注解用来标识该接口为Repository,继承自JpaRepository接口,并指定泛型参数分别为实体类类型和主键类型。在接口中定义了一个findByName方法,用于根据name属性查询用户列表。
除了使用Spring Data JPA提供的默认方法外,我们还可以通过自定义方法的方式来扩展Repository接口。例如,如果需要按照年龄范围查询用户列表,则可以在UserRepository接口中添加如下方法:
List<User> findByAgeBetween(Integer minAge, Integer maxAge);
此外,我们还可以使用@RepositoryDefinition注解来自定义Repository接口,或者使用@Query注解来自定义SQL语句以执行更复杂的数据库操作。例如:
@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注解来自定义Repository接口,指定了实体类类型和主键类型。在接口中定义了一个findByAgeRange方法,使用@Query注解指定查询语句,并通过@Param注解绑定参数值。
测试代码编写
在使用Spring Data JPA进行开发时,通常需要编写测试代码来验证CRUD操作的功能是否正确。我们可以使用Junit框架进行单元测试。
例如,对于User实体类和UserRepository接口,我们可以编写如下测试代码:
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserRepositoryTest {
@Autowired
private UserRepository userRepository;
@Test
public void testCrudOperations() {
// 创建一个新用户
User user = new User();
user.setName("张三");
user.setAge(18);
// 插入新用户
userRepository.save(user);
Long userId = user.getId();
// 根据ID查询用户
Optional<User> optionalUser = userRepository.findById(userId);
Assert.assertTrue(optionalUser.isPresent());
// 更新用户信息
user.setAge(20);
userRepository.save(user);
// 根据name查询用户列表
List<User> userList = userRepository.findByName("张三");
Assert.assertEquals(1, userList.size());
// 删除用户
userRepository.delete(user);
// 验证用户已被删除
optionalUser = userRepository.findById(userId);
Assert.assertFalse(optionalUser.isPresent());
}
}
多表关联
假设有两个实体类,一个是订单 Order,另一个是商品 Item,每个订单中都包含多个商品。
1.定义实体类
@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.属性映射和关系映射
- Order 实体类中使用了 @OneToMany 注解表示一对多关系,mappedBy 参数指定了 Item 实体类中与 Order 相关的属性名。
- Item 实体类中使用了 @ManyToOne 注解表示多对一关系,JoinColumn 注解指定了外键名称。
3.测试代码
@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);
}
}
至此就完成了多表关联查询操作。