当前位置：首页 > news >正文

Spring Data JPA 语法详解与使用案例

news 2025/9/25 14:11:43

一、Spring Data JPA 简介

1.1 什么是 Spring Data JPA？

Spring Data JPA 是 Spring 框架对 JPA（Java Persistence API）的封装，它提供了 简化数据库操作 的接口和方法，开发者无需手动编写 SQL 或 JPQL，只需通过 接口继承 即可实现 CRUD 操作和复杂查询。

二、核心特性

特性	说明
自动实现方法	通过方法名自动生成查询语句
分页与排序	支持分页查询和动态排序
自定义查询	使用 `@Query` 注解编写 JPQL
Specifications	动态查询条件构建
实体管理	集成 `EntityManager` 管理实体

三、核心接口与类

3.1 `JpaRepository` 接口

public interface UserRepository extends JpaRepository<User, Long> {
// 自动实现的查询方法
}

3.2 常用方法

User save(User user);// 保存
Optional<User> findById(Long id);// 查询
List<User> findAll();// 查询所有
long count();// 计数
void deleteById(Long id);// 删除

四、查询方法自动生成

4.1 方法名规则

Spring Data JPA 会根据方法名自动解析查询条件。

示例 1：简单查询

public interface UserRepository extends JpaRepository<User, Long> {
List<User> findByUsername(String username);// SELECT * FROM user WHERE username = ?
}

示例 2：多条件查询

List<User> findByUsernameAndEmail(String username, String email);// AND 条件
List<User> findByUsernameOrEmail(String username, String email);// OR 条件

示例 3：排序

List<User> findByUsernameOrderByEmailAsc(String username);// 升序
List<User> findByUsernameOrderByEmailDesc(String username); // 降序

示例 4：分页

Page<User> findByUsername(String username, Pageable pageable);// 分页查询

五、自定义查询

5.1 使用 `@Query` 注解

@Query("SELECT u FROM User u WHERE u.username LIKE %:keyword%")
List<User> searchByUsername(@Param("keyword") String keyword);

5.2 原生 SQL 查询

@Query(value = "SELECT * FROM user WHERE email = ?1",
nativeQuery = true)
User findByEmailNative(String email);

六、分页与排序

6.1 分页接口

public interface UserRepository extends JpaRepository<User, Long> {
Page<User> findAll(Pageable pageable);
}

6.2 使用示例

Pageable pageable = PageRequest.of(0, 10, Sort.by("id").descending());
Page<User> users = userRepository.findAll(pageable);

七、Specifications 动态查询

7.1 实现 `Specification` 接口

public class UserSpecifications {
public static Specification<User> hasUsername(String username) {
return (root, query, cb) -> cb.equal(root.get("username"), username);
}
}

7.2 使用 `JpaSpecificationExecutor`

public interface UserRepository extends JpaRepository<User, Long>, JpaSpecificationExecutor<User> {
// 动态查询
}// 调用示例
List<User> users = userRepository.findAll(UserSpecifications.hasUsername("admin"));

八、实体关联映射

8.1 一对一（`@OneToOne`）

@Entity
public class User {
@Id
private Long id;@OneToOne
@JoinColumn(name = "profile_id")
private Profile profile;
}

8.2 一对多（`@OneToMany`）

@Entity
public class User {
@Id
private Long id;@OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
private List<Order> orders;
}

8.3 多对多（`@ManyToMany`）

@Entity
public class User {
@Id
private Long id;@ManyToMany
@JoinTable(
name = "user_role",
joinColumns = @JoinColumn(name = "user_id"),
inverseJoinColumns = @JoinColumn(name = "role_id")
)
private Set<Role> roles;
}

九、事务管理

9.1 使用 `@Transactional` 注解

@Service
public class UserService {
@Autowired
private UserRepository userRepository;@Transactional
public void transferMoney(Long fromId, Long toId, Double amount) {
User fromUser = userRepository.findById(fromId).orElseThrow(...);
User toUser = userRepository.findById(toId).orElseThrow(...);fromUser.setBalance(fromUser.getBalance() - amount);
toUser.setBalance(toUser.getBalance() + amount);userRepository.save(fromUser);
userRepository.save(toUser);
}
}

十、性能优化

10.1 避免 N+1 问题

// 使用 JOIN FETCH 一次性加载关联数据
@Query("SELECT u FROM User u JOIN FETCH u.orders WHERE u.id = :id")
User findUserWithOrders(@Param("id") Long id);

10.2 使用缓存

spring:
jpa:
open-in-view: false
cache:
type: caffeine

十一、完整使用案例

11.1 用户管理系统

实体类

@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;private String username;
private String email;@OneToMany(mappedBy = "user", cascade = CascadeType.ALL)
private List<Order> orders = new ArrayList<>();
}

Repository 接口

public interface UserRepository extends JpaRepository<User, Long> {
List<User> findByUsername(String username);
Page<User> findAll(Pageable pageable);
}

Service 层

@Service
public class UserService {
@Autowired
private UserRepository userRepository;public User createUser(String username, String email) {
User user = new User();
user.setUsername(username);
user.setEmail(email);
return userRepository.save(user);
}public Page<User> searchUsers(int page, int size) {
Pageable pageable = PageRequest.of(page, size);
return userRepository.findAll(pageable);
}
}

Controller 层

@RestController
@RequestMapping("/users")
public class UserController {
@Autowired
private UserService userService;@PostMapping
public User createUser(@RequestBody UserDTO dto) {
return userService.createUser(dto.getUsername(), dto.getEmail());
}@GetMapping
public Page<User> getUsers(@RequestParam int page, @RequestParam int size) {
return userService.searchUsers(page, size);
}
}

十二、常见问题与解决方案

问题	解决方案
LazyInitializationException	使用 `JOIN FETCH` 或在事务中访问关联字段
StaleObjectStateException	检查乐观锁版本号是否冲突
主键冲突	检查 `@GeneratedValue` 策略
查询性能差	使用分页（`Pageable`）或缓存