Spring Data JPA 查询终极指南:四种利器,一套打通
在 Spring Data JPA 的查询世界里,开发者常常面临一个经典难题:面对层出不穷的数据访问需求,究竟该选用哪种查询方式?是依赖方法命名派生查询的极致简洁,还是拥抱 @Query 的无限自由?是钟情于 Specification 的类型安全与动态组合,还是青睐 Query by Example 的天然直观?
本文将逐一拆解这四种查询利器,从基础用法到高阶技巧(含投影、更新、子查询、动态条件拼接),并深入剖析分页与排序的统一实践,辅以大量实战案例,给出清晰的选择策略。无论你是刚入门的初学者,还是寻求进阶的开发者,都能在这里找到通往高效数据访问的钥匙。
一、方法命名派生查询(Derived Query Methods)—— 最优雅的“零代码”方案
方法命名派生查询是 Spring Data JPA 最核心、最便捷的特性。你只需遵循一套约定好的命名规则,框架便会在运行时自动生成 JPQL 查询语句,真正实现“不写一行 SQL,也能查数据”。
1.1 命名结构解剖
一个派生查询方法由两部分组成,中间以 By 分隔:
- 引导词(Introducer):定义操作类型,如
find、read、get、count、exists、delete等。 - 条件部分(Criteria):
By之后的部分,由属性名和关键字组合而成。
List<User> findByName(String name);
─┬─ ──┬──
引导词 条件部分
| 引导词 | 含义 | 示例 |
|---|---|---|
find…By | 返回匹配的实体或集合 | findByName(String name) |
read…By | 同 find | readByName(String name) |
get…By | 同 find | getByName(String name) |
count…By | 返回匹配结果的数量 | countByName(String name) |
exists…By | 判断是否存在匹配结果 | existsByName(String name) |
delete…By | 删除匹配的实体(先查后删) | deleteByName(String name) |
1.2 结果集控制:Top / First / Distinct
在引导词和 By 之间可插入 Top、First 或 Distinct,用于限制结果数量或去重:
// 年龄最大的前3条
List<User> findTop3ByAge();
// 年龄最大的第1条(等价于 Top1)
User findFirstByAge();
// 去重查询
List<User> findDistinctByLastNameAndFirstName(String lastName, String firstName);
1.3 查询条件关键字大全
下表罗列了 Spring Data JPA 支持的所有查询关键字及其对应的 JPQL 片段,掌握这些组合,便能覆盖绝大多数简单查询。
| 关键字 | 示例方法 | JPQL 片段 |
|---|---|---|
And | findByLastnameAndFirstname | … where x.lastname = ?1 and x.firstname = ?2 |
Or | findByLastnameOrFirstname | … where x.lastname = ?1 or x.firstname = ?2 |
Is, Equals | findByFirstname、findByFirstnameIs | … where x.firstname = ?1 |
Between | findByStartDateBetween | … where x.startDate between ?1 and ?2 |
LessThan | findByAgeLessThan | … where x.age < ?1 |
LessThanEqual | findByAgeLessThanEqual | … where x.age <= ?1 |
GreaterThan | findByAgeGreaterThan | … where x.age > ?1 |
GreaterThanEqual | findByAgeGreaterThanEqual | … where x.age >= ?1 |
After | findByStartDateAfter | … where x.startDate > ?1 |
Before | findByStartDateBefore | … where x.startDate < ?1 |
IsNull, Null | findByAgeIsNull | … where x.age is null |
IsNotNull, NotNull | findByAgeIsNotNull | … where x.age not null |
Like | findByFirstnameLike | … where x.firstname like ?1 |
NotLike | findByFirstnameNotLike | … where x.firstname not like ?1 |
StartingWith | findByFirstnameStartingWith | … where x.firstname like ?1(参数追加 %) |
EndingWith | findByFirstnameEndingWith | … where x.firstname like ?1(参数前置 %) |
Containing | findByFirstnameContaining | … where x.firstname like ?1(参数前后加 %) |
NotContaining | findByFirstnameNotContaining | … where x.firstname not like ?1(参数前后加 %) |
In | findByAgeIn | … where x.age in ?1 |
NotIn | findByAgeNotIn | … where x.age not in ?1 |
True | findByActiveTrue | … where x.active = true |
False | findByActiveFalse | … where x.active = false |
IgnoreCase | findByFirstnameIgnoreCase | … where UPPER(x.firstname) = UPPER(?1) |
OrderBy | findByAgeOrderByAgeDesc | … order by x.age desc |
安全提示:对于
StartingWith、EndingWith、Containing等含LIKE的关键字,Spring Data JPA 会自动对参数中的通配符(%、_)进行转义,防止注入攻击。
1.4 属性表达式与嵌套属性
条件部分可以引用嵌套属性,通过 . 或 _ 连接:
// 假设 User 有 Address 类型的 address 属性,Address 有 city 字段
List<User> findByAddressCity(String city);
Spring Data JPA 会自动生成 JOIN 查询。若属性名本身包含下划线,框架会优先识别为属性路径。
1.5 完整示例
@Entity
@Table(name = "users")
public class User {
@Id @GeneratedValue private Integer id;
private String name;
private Integer age;
private Boolean active;
// getters/setters
}
public interface UserRepository extends JpaRepository<User, Integer> {
// 等值查询
List<User> findByName(String name);
// 模糊匹配(包含)
List<User> findByNameContaining(String infix);
// 组合条件 + 排序
List<User> findByNameAndAgeOrderByAgeDesc(String name, int age);
// 计数与存在判断
long countByName(String name);
boolean existsByName(String name);
// 删除
void deleteByName(String name);
}
1.6 何时告别方法命名?
方法命名虽好,但当方法名变得冗长、需要复杂关联或数据库特有函数时,就该改用 @Query 了。
二、@Query 注解——突破命名约束的万能钥匙
@Query 注解允许你在 Repository 方法上直接编写查询语句,支持 JPQL 和 原生 SQL,是处理复杂查询的终极武器。
2.1 基础语法与参数绑定
① 基本用法
public interface UserRepository extends JpaRepository<User, Long> {
// JPQL(操作实体)
@Query("SELECT u FROM User u WHERE u.age > ?1")
List<User> findUsersByAgeGreaterThan(int age);
// 原生 SQL(操作表)
@Query(value = "SELECT * FROM users WHERE age > ?1", nativeQuery = true)
List<User> findUsersByAgeGreaterThanNative(int age);
}
| 属性 | 说明 |
|---|---|
value | 查询语句(JPQL 或原生 SQL) |
nativeQuery | 是否为原生 SQL,默认 false |
countQuery | 分页时用于计数的查询语句(重要!) |
countProjection | 计数时使用的投影字段 |
② 参数绑定方式
- 位置参数(索引从 1 开始):
@Query("SELECT u FROM User u WHERE u.name = ?1 AND u.age = ?2")
User findByNameAndAge(String name, int age);
- 命名参数(推荐,可读性强):
@Query("SELECT u FROM User u WHERE u.name = :name AND u.age = :age")
User findByNameAndAge(@Param("name") String name, @Param("age") int age);
- 集合参数(自动展开 IN 子句):
@Query("SELECT u FROM User u WHERE u.age IN :ages")
List<User> findByAgeIn(@Param("ages") List<Integer> ages);
2.2 高级查询技巧
① 多表关联(JOIN)
// 隐式 JOIN(通过属性路径)
@Query("SELECT u FROM User u WHERE u.address.city = :city")
List<User> findByCity(@Param("city") String city);
// 显式 JOIN
@Query("SELECT u FROM User u JOIN u.orders o WHERE o.status = :status")
List<User> findUsersWithOrderStatus(@Param("status") OrderStatus status);
// 左外连接
@Query("SELECT u FROM User u LEFT JOIN u.orders o WHERE o.total > :amount")
List<User> findUsersWithLargeOrders(@Param("amount") BigDecimal amount);
② 子查询
// 查询年龄大于平均值的用户
@Query("SELECT u FROM User u WHERE u.age > (SELECT AVG(age) FROM User)")
List<User> findUsersOlderThanAverage();
// EXISTS 子查询
@Query("SELECT u FROM User u WHERE EXISTS (SELECT 1 FROM Order o WHERE o.user = u AND o.total > :amount)")
List<User> findUsersWithOrderAbove(@Param("amount") BigDecimal amount);
③ 投影(Projection)—— 只查部分字段
- 接口投影(推荐):
public interface UserNameAndAge {
String getName();
int getAge();
}
@Query("SELECT u.name AS name, u.age AS age FROM User u WHERE u.id = :id")
UserNameAndAge findUserNameAndAgeById(@Param("id") Long id);
- DTO 类投影(使用构造器表达式):
public class UserDTO {
private String name;
private int age;
public UserDTO(String name, int age) { this.name = name; this.age = age; }
// getters
}
@Query("SELECT new com.example.dto.UserDTO(u.name, u.age) FROM User u WHERE u.id = :id")
UserDTO findUserDTOById(@Param("id") Long id);
④ 集合表达式与动态 IN
@Query("SELECT u FROM User u WHERE u.name IN :names")
List<User> findByNameIn(@Param("names") Collection<String> names);
传入空集合时可能产生异常,建议调用前做非空校验。
⑤ 使用 SpEL 表达式
// 引用实体名(多租户/动态表名)
@Query("SELECT u FROM #{#entityName} u WHERE u.name = :name")
List<User> findByEntityName(@Param("name") String name);
// 动态排序(慎用于原生SQL)
@Query("SELECT u FROM User u ORDER BY #{#sortField} #{#sortDirection}")
List<User> findAllSorted(@Param("sortField") String field, @Param("sortDirection") String direction);
2.3 更新与删除(@Modifying)
@Query 可执行 UPDATE/DELETE,但必须与 @Modifying 联用。
① 基础用法
@Modifying
@Query("UPDATE User u SET u.active = false WHERE u.lastLoginDate < :cutoff")
int deactivateInactiveUsers(@Param("cutoff") LocalDateTime cutoff);
返回值为受影响行数。
② 清除持久化上下文
更新后一级缓存可能残留旧数据,可通过 clearAutomatically 自动清理:
@Modifying(clearAutomatically = true)
@Query("UPDATE User u SET u.active = false WHERE u.id = :id")
int deactivateUser(@Param("id") Long id);
若需要立即刷新缓存,可同时设置 flushAutomatically = true。
③ 事务要求
@Modifying 方法必须在事务中执行,通常在 Service 层用 @Transactional 包裹。
2.4 原生 SQL 的特殊处理
- 结果映射:默认返回
Object[],若映射为实体,需确保查询字段与实体字段一致。 - 分页:必须同时指定
countQuery,否则分页可能失效(详见第五章分页专项)。 - 命名参数:支持
@Param,写法与 JPQL 相同。
2.5 实战案例集锦
案例 1:可选参数(COALESCE 模拟动态条件)
@Query("SELECT u FROM User u WHERE (:name IS NULL OR u.name = :name) AND (:age IS NULL OR u.age = :age)")
List<User> searchUsers(@Param("name") String name, @Param("age") Integer age);
大数据量下慎用,建议改用
Specification。
案例 2:计算字段 + 排序
@Query("SELECT u, (u.age - (SELECT AVG(age) FROM User)) AS ageDiff FROM User u WHERE u.active = true ORDER BY ageDiff DESC")
List<Object[]> findUsersWithAgeDifference();
案例 3:批量更新状态
@Modifying(clearAutomatically = true)
@Query("UPDATE Order o SET o.status = :newStatus WHERE o.status = :oldStatus AND o.createdDate < :cutoff")
int batchUpdateOrderStatus(@Param("newStatus") OrderStatus newStatus,
@Param("oldStatus") OrderStatus oldStatus,
@Param("cutoff") LocalDateTime cutoff);
案例 4:调用数据库函数(如 DATE)
@Query("SELECT o FROM Order o WHERE FUNCTION('DATE', o.createdDate) = CURRENT_DATE")
List<Order> findTodayOrders();
案例 5:分组聚合
@Query("SELECT u.department, COUNT(u), AVG(u.salary) FROM User u GROUP BY u.department HAVING AVG(u.salary) > :avg")
List<Object[]> getDepartmentStats(@Param("avg") double avg);
2.6 调试与最佳实践
- SQL 日志:在
application.properties开启:
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true
logging.level.org.hibernate.SQL=DEBUG
logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE
- JPQL vs 原生 SQL:优先 JPQL(数据库无关、自动映射),原生 SQL 仅在 JPQL 无法实现时使用。
- 性能优化:避免
SELECT *,使用投影;为分页查询测试countQuery效率。
三、Specification——类型安全的动态查询工厂
当查询条件动态变化(如多字段组合搜索),且希望编译期类型安全时,Specification 是最佳搭档。它基于 JPA 2.0 的 Criteria API,将查询条件的构建以规范(Specification)对象的形式封装,并可自由组合。
3.1 启用 Specification
让 Repository 同时继承 JpaSpecificationExecutor(JpaRepository 已包含):
public interface UserRepository extends JpaRepository<User, Long>,
JpaSpecificationExecutor<User> {
}
JpaSpecificationExecutor 提供了 findOne、findAll、count、exists 等方法,均接受 Specification 参数,且天然支持分页(传入 Pageable)。
3.2 编写与使用 Specification
Specification 是一个函数式接口,只需实现 toPredicate 方法:
@FunctionalInterface
public interface Specification<T> {
Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder builder);
}
示例:查询年龄大于 18 的用户。
Specification<User> ageGreaterThan18 = (root, query, builder) ->
builder.greaterThan(root.get("age"), 18);
List<User> users = userRepository.findAll(ageGreaterThan18);
多条件组合:
Specification<User> spec = (root, query, builder) -> {
Predicate ageBetween = builder.between(root.get("age"), 18, 30);
Predicate isActive = builder.isTrue(root.get("active"));
return builder.and(ageBetween, isActive);
};
List<User> users = userRepository.findAll(spec);
3.3 复用与组合
将常用规范抽取为静态方法:
public class UserSpecs {
public static Specification<User> ageGreaterThan(int age) {
return (root, query, builder) -> builder.greaterThan(root.get("age"), age);
}
public static Specification<User> isActive() {
return (root, query, builder) -> builder.isTrue(root.get("active"));
}
public static Specification<User> nameContains(String keyword) {
return (root, query, builder) ->
builder.like(root.get("name"), "%" + keyword + "%");
}
}
组合使用(AND / OR):
List<User> users = userRepository.findAll(
Specification.where(UserSpecs.ageGreaterThan(18))
.and(UserSpecs.isActive())
.and(UserSpecs.nameContains("张"))
);
3.4 结合 JPA 静态元模型(终极类型安全)
使用字符串 "age" 存在字段改名导致运行时错误的风险。通过 JPA 静态元模型(如 Hibernate JPAModelGen 生成 User_ 类),可获得编译期检查:
Specification<User> ageGreaterThan18 = (root, query, builder) ->
builder.greaterThan(root.get(User_.age), 18); // 编译期安全!
启用方式:在 Maven/Gradle 中添加 org.hibernate:hibernate-jpamodelgen 注解处理器,编译后自动生成 User_ 类。
3.5 Specification 的适用场景
- 后台管理系统多条件筛选(如用户列表搜索)
- 动态报表查询
- 需要复用和组合查询条件的场景
- 执行基于条件的删除(
delete(Specification))
四、Query by Example(QBE)—— 用样本对象驱动查询
按示例查询(QBE)提供了一种极简的动态查询方式:你只需填充一个样本实体对象,框架便会自动以其非空字段为条件生成查询,无需编写任何字段名。
4.1 核心概念
- Probe(探针):填充了属性值的领域对象实例。
- ExampleMatcher(匹配器):定义字段匹配规则(如字符串匹配模式、忽略大小写等)。
- Example:Probe + ExampleMatcher 的组合。
4.2 基本用法
// 创建探针(null 属性默认忽略)
User probe = new User();
probe.setName("张三");
probe.setAge(25);
Example<User> example = Example.of(probe);
List<User> results = userRepository.findAll(example);
默认行为:精确匹配所有非空字段,字符串采用数据库默认匹配方式(通常为 =)。
4.3 ExampleMatcher:精细控制匹配规则
ExampleMatcher matcher = ExampleMatcher.matching()
.withIgnorePaths("id", "createdAt") // 忽略这些字段
.withStringMatcher(StringMatcher.CONTAINING) // 全局包含匹配
.withIgnoreCase() // 全局忽略大小写
.withMatcher("email", match -> match.endsWith())
.withMatcher("name", match -> match.startsWith().ignoreCase());
Example<User> example = Example.of(probe, matcher);
List<User> results = userRepository.findAll(example);
字符串匹配策略:
| 策略 | 说明 | SQL 效果 |
|---|---|---|
DEFAULT | 存储特定默认值(通常精确匹配) | = ? |
EXACT | 精确匹配 | = ? |
STARTING | 前缀匹配 | LIKE ?% |
ENDING | 后缀匹配 | LIKE %? |
CONTAINING | 包含匹配 | LIKE %?% |
4.4 FetchableFluentQuery(流式查询)
自 Spring Data JPA 2.5 起,支持链式调用进行排序、分页和投影:
User probe = new User();
probe.setActive(true);
Example<User> example = Example.of(probe);
List<User> results = userRepository.findBy(example,
query -> query
.sortBy(Sort.by("age").descending())
.page(PageRequest.of(0, 10))
.stream()
.collect(Collectors.toList())
);
4.5 QBE 的适用场景与局限性
适用场景:
- 查询条件动态变化,且不想编写复杂代码
- 领域对象频繁重构,希望减少字段变更带来的影响
- 快速原型开发
局限性:
- 不支持嵌套或分组条件(如
(a=1 and b=2) or (c=3)) - 同一字段只能有一个过滤值
- 字符串匹配能力受数据库限制
- 不支持集合类型属性的匹配
五、分页与排序全攻略:四种方式统一实践
分页是几乎所有业务系统都绕不开的需求。在 Spring Data JPA 中,无论你使用上述哪一种查询方式,分页机制都是高度统一的——核心依赖 Pageable 和 Page / Slice 接口。下面我们先了解基础,再逐一展示四种方式如何具体落地。
5.1 分页核心概念
- Pageable:分页请求对象,封装了页码、每页大小、排序信息。
- PageRequest:
Pageable的常用实现类,通过PageRequest.of(page, size, sort)创建。 - Page:分页结果对象,包含数据列表、总记录数、总页数等完整分页信息(会额外执行 count 查询)。
- Slice:分页结果切片,仅知道是否有下一页,不执行 count 查询,性能优于
Page,适用于无限滚动等场景。
// 创建分页请求:第0页,每页10条,按年龄降序
Pageable pageable = PageRequest.of(0, 10, Sort.by("age").descending());
// 多字段排序
Pageable pageable = PageRequest.of(0, 10, Sort.by("age").descending().and(Sort.by("id").ascending()));
5.2 方式一:方法命名派生查询 + 分页
派生查询方法只需在参数列表中增加 Pageable 参数,返回值改为 Page 或 Slice,框架便会自动解析并生成分页 SQL。
public interface UserRepository extends JpaRepository<User, Long> {
// 返回 Page(含总记录数)
Page<User> findByNameContaining(String keyword, Pageable pageable);
// 返回 Slice(不含总记录数,性能更高)
Slice<User> findByAgeGreaterThan(int age, Pageable pageable);
// 结合排序(Pageable 中已包含排序,无需单独加 OrderBy)
Page<User> findByActiveTrue(Pageable pageable);
}
调用示例:
// 查询姓名包含"张"的用户,按年龄降序分页
Pageable pageable = PageRequest.of(0, 10, Sort.by(Sort.Direction.DESC, "age"));
Page<User> page = userRepository.findByNameContaining("张", pageable);
System.out.println("总记录数:" + page.getTotalElements());
System.out.println("总页数:" + page.getTotalPages());
System.out.println("当前页数据:" + page.getContent());
重要:方法命名派生查询中,如果方法名里已经带了
OrderBy(如findByNameOrderByAgeDesc),再传入带排序的Pageable,排序会叠加,可能导致意外结果。建议仅在Pageable中指定排序,保持方法名干净。
5.3 方式二:@Query 注解 + 分页
@Query 对分页的支持极为灵活,JPQL 和原生 SQL 都适用。
① JPQL 标准分页
直接在方法参数中加入 Pageable,无需在 JPQL 中写 OFFSET / LIMIT,框架会自动拼接:
@Query("SELECT u FROM User u WHERE u.age > :age")
Page<User> findByAgeGreaterThan(@Param("age") int age, Pageable pageable);
② 自定义 count 查询(性能优化关键)
当 JPQL 查询包含多表 JOIN 或复杂条件时,自动生成的 count 查询可能效率低下,甚至因语法问题报错。此时应手动指定 countQuery:
@Query(value = "SELECT u FROM User u LEFT JOIN u.orders o WHERE o.total > :amount",
countQuery = "SELECT COUNT(u) FROM User u WHERE EXISTS (SELECT 1 FROM Order o WHERE o.user = u AND o.total > :amount)")
Page<User> findUsersWithLargeOrders(@Param("amount") BigDecimal amount, Pageable pageable);
③ 原生 SQL 分页(必须指定 countQuery)
原生 SQL 的分页语句因数据库方言而异(如 MySQL 的 LIMIT、Oracle 的 ROWNUM),Spring Data JPA 会根据方言自动拼接,但 count 查询必须手工提供,否则分页会失效:
@Query(value = "SELECT * FROM users WHERE age > ?1 ORDER BY id",
countQuery = "SELECT COUNT(*) FROM users WHERE age > ?1",
nativeQuery = true)
Page<User> findUsersByAgeGreaterThanNative(int age, Pageable pageable);
注意:原生 SQL 的
ORDER BY必须写在主查询中,且如果Pageable中带有Sort,二者可能冲突,建议统一在Pageable中控制排序,主查询中不写ORDER BY。
5.4 方式三:Specification + 分页
Specification 与 Pageable 是天生的搭档,通过 JpaSpecificationExecutor 提供的方法可以直接传入分页参数:
public interface UserRepository extends JpaRepository<User, Long>,
JpaSpecificationExecutor<User> {
// 无需额外定义方法,父接口已提供
}
调用示例:
// 构建动态条件
Specification<User> spec = (root, query, builder) -> {
Predicate agePredicate = builder.between(root.get("age"), 18, 30);
Predicate activePredicate = builder.isTrue(root.get("active"));
return builder.and(agePredicate, activePredicate);
};
// 分页 + 排序
Pageable pageable = PageRequest.of(0, 10, Sort.by("age").descending());
Page<User> page = userRepository.findAll(spec, pageable);
结合静态元模型(类型安全):
Specification<User> spec = (root, query, builder) ->
builder.greaterThan(root.get(User_.age), 18);
Page<User> page = userRepository.findAll(spec, PageRequest.of(0, 10, Sort.by(User_.AGE).descending()));
5.5 方式四:Query by Example(QBE)+ 分页
QueryByExampleExecutor 同样原生支持分页,使用方式与 Specification 极其相似:
public interface UserRepository extends JpaRepository<User, Long> {
// 继承自 QueryByExampleExecutor,无需额外定义
}
传统分页写法:
// 构建探针
User probe = new User();
probe.setName("张");
probe.setActive(true);
// 构建匹配器
ExampleMatcher matcher = ExampleMatcher.matching()
.withStringMatcher(StringMatcher.CONTAINING)
.withIgnorePaths("id", "createdAt");
Example<User> example = Example.of(probe, matcher);
// 分页查询
Pageable pageable = PageRequest.of(0, 10, Sort.by("age").ascending());
Page<User> page = userRepository.findAll(example, pageable);
流式 API(FetchableFluentQuery)分页(Spring Data JPA 2.5+):
// 获取 List
List<User> results = userRepository.findBy(example,
query -> query
.sortBy(Sort.by("age").descending())
.page(PageRequest.of(0, 10))
.stream()
.collect(Collectors.toList())
);
// 若需要完整 Page 对象
Page<User> page = userRepository.findBy(example,
query -> query
.sortBy(Sort.by("age").descending())
.page(PageRequest.of(0, 10))
);
5.6 Page 与 Slice 的选择策略
| 特性 | Page | Slice |
|---|---|---|
| 是否执行 count 查询 | ✅ 是(消耗性能) | ❌ 否(性能高) |
| 能否获取总记录数 | ✅ 可以 | ❌ 不可以 |
| 能否获取总页数 | ✅ 可以 | ❌ 不可以 |
| 适用场景 | 后台管理系统、需要显示总条数的表格 | 移动端列表、无限滚动、API 网关透传 |
5.7 分页最佳实践
- 统一封装分页请求:在 Controller 层接收
page、size、sort参数,转换为Pageable对象,避免在 Service 层硬编码。 - 避免超大页码:对
page参数做合理性校验,防止恶意请求导致内存溢出。 - count 查询优化:对于复杂 JOIN 查询,务必测试自动生成的 count SQL,必要时手动指定
countQuery。 - 排序字段白名单:若排序字段由前端传入,请做白名单校验,防止 SQL 注入(尤其是原生 SQL 场景)。
- 善用
Sort.by静态工厂:
// 安全且优雅的排序构建
Sort sort = Sort.by("age").descending()
.and(Sort.by("id").ascending());
六、四大查询方式终极对比与选择策略
现在,我们在之前的对比表中增加“分页支持”这一关键维度:
| 对比维度 | 方法命名派生 | @Query | Specification | QBE |
|---|---|---|---|---|
| 代码量 | ⭐⭐⭐⭐⭐ 最少 | ⭐⭐⭐ 中等 | ⭐⭐ 较多 | ⭐⭐⭐⭐ 较少 |
| 可读性 | 方法名即文档 | 需阅读 JPQL/SQL | 需理解 Criteria API | 需理解匹配器配置 |
| 动态性 | ❌ 固定条件 | ❌ 固定条件(除非拼装字符串) | ✅ 天然动态 | ✅ 天然动态 |
| 类型安全 | ⚠️ 无编译检查 | ⚠️ 无编译检查 | ✅ 配合元模型可编译检查 | ⚠️ 无编译检查 |
| 灵活性 | 受关键字限制 | 最高(任意 JPQL/SQL) | 高(编程构建) | 受匹配器限制 |
| 复杂查询能力 | 弱(简单条件) | 极强(任意复杂度) | 强(可构建复杂条件) | 弱(单层简单条件) |
| 分页支持 | ✅ 原生支持 | ✅ 原生支持(可自定义 count) | ✅ 原生支持 | ✅ 原生支持 |
| 重构友好 | 需同步改方法名 | 需同步改 JPQL | 配合元模型自动感知 | 修改 setter 调用即可 |
尽管四种方式都支持分页,但
@Query在复杂分页场景(如多表 JOIN 的 count 优化)中拥有最强的控制力;而方法命名派生和 QBE 在简单分页场景中则更加便捷。
分页场景选择速查表
| 分页场景 | 推荐方式 | 理由 |
|---|---|---|
| 单表简单条件分页(如根据名称模糊查询) | 方法命名派生 | 代码极简,无需额外 SQL |
| 单表动态多条件分页(如后台搜索表单) | Specification | 条件灵活组合,类型安全 |
| 多表关联分页(如用户+订单联合查询) | @Query + 自定义 count | 可精准控制 JOIN 和 count 查询,避免性能陷阱 |
| 动态条件且不想写复杂代码的原型开发 | QBE | 以样本对象驱动,上手快 |
| 需要调用数据库特有函数的分页(如全文检索) | @Query(原生 SQL) | 可编写数据库专属 SQL,不受 JPQL 限制 |
协同使用建议
在实际项目中,这四种方式并非互斥,而是可以共存于同一个 Repository 中。例如:
public interface UserRepository extends JpaRepository<User, Long>,
JpaSpecificationExecutor<User> {
// 简单查询 → 派生
List<User> findByName(String name);
// 复杂关联 → @Query
@Query("SELECT u FROM User u JOIN u.orders o WHERE o.total > :amount")
List<User> findUsersWithOrderTotalGreaterThan(@Param("amount") BigDecimal amount);
// 动态多条件 → Specification(由外部调用)
// 由 Service 层构建 Specification 传入 findAll(Specification)
// 快速原型 → QBE(由外部调用)
// 由 Service 层构建 Example 传入 findAll(Example)
}
七、结语
Spring Data JPA 的四种查询方式——方法命名派生、@Query、Specification 和 Query by Example——各有侧重,互为补充。方法命名派生用最少的代码搞定最常见的查询;@Query 让你在复杂场景下掌控全局,并精细优化分页性能;Specification 则以类型安全的方式编织动态条件;QBE 则用最自然的方式表达动态查询。
在分页能力上,它们殊途同归,均通过统一的 Pageable 机制实现了优雅的支持。选择何种方式,应综合考量查询复杂度、动态性需求、类型安全要求和性能敏感度:
- 简单固定条件 → 派生查询
- 复杂固定逻辑 →
@Query - 动态组合条件 →
Specification - 快速动态样本 →
QBE
掌握这四种武器,并根据实际场景灵活选择,你便能在 Spring Data JPA 的查询世界里游刃有余,既写出简洁优雅的代码,又能应对层出不穷的业务变化。希望这份涵盖了分页细节与进阶特性的完整指南,能切实帮助你在实际项目中做出最优决策,高效、高质量地完成数据访问层的构建。