【Spring Boot】Java 持久层 API（三）：JPA 的查询方式

已于 2024-09-15 22:34:25 修改
阅读量2k 收藏 17
点赞数 25
分类专栏： # Spring Boot 文章标签： spring boot JPA Spring Data java 数据库
于 2024-06-30 15:03:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/be_racle/article/details/140079663
版权

《用 ORM 操作 SQL 数据库》系列，共包含以下文章：

😊 如果您觉得这篇文章有用 ✔️ 的话，请给博主一个一键三连 🚀🚀🚀 吧 （点赞 🧡、关注 💛、收藏 💚）！！！您的支持 💖💖💖 将激励 🔥 博主输出更多优质内容！！！

Java 持久层 API（三）：JPA 的查询方式

1.使用约定方法名

约定方法名一定要根据命名规范来写，Spring Data 会根据前缀、中间连接词（Or、And、Like、NotNull 等类似 SQL 中的关键词）、内部拼接 SQL 代理生成方法的实现。

约定方法名的方法见下表（不完全示例）：

SQL
方法例子
JPQL 语句
andfindByLastnameAndFirstnamewhere x.lastname = ?1 and x.firstname = ?2
orfindByLastnameOrFirstnamewhere x.lastname = ?1 or x.firstname = ?2
=findByFirstname / findByFirstnameIs / findByFirstnameEqualswhere x.firstname = ?1

接口方法的命名规则也很简单，只要明白 And、Or、Is、Equal、Greater、StartingWith 等英文单词的含义，就可以写接口方法。具体用法如下：

public interface UserRepository extends Repository<User, Long> {
    List<User> findByEmailOrName(String email, String name);
}

上述代码表示，通过 email 或 name 来查找 User 对象。

约定方法名还可以支持以下几种语法：

  • User findFirstByOrderByNameAsc()
  • Page<User> queryFirst100ByName(String name, Pageable pageable)
  • Slice<User> findTop100ByName(String name, Pageable pageable)
  • List<User> findFirst100ByName(String name, Sort sort)
  • List<User> findTop100ByName(String name, Pageable pageable)

2.用 JPQL 进行查询

JPQL 语言（Java Persistence Query Language）是一种和 SQL 非常类似的中间性和对象化查询语言，它最终会被编译成针对不同底层数据库的 SQL 语言，从而屏蔽不同数据库的差异。

JPQL 语言通过 Query 接口封装执行，Query 接口封装了执行数据库查询的相关方法。调用 EntityManager 的 Query、NamedQuery 及 NativeQuery 方法可以获得查询对象，进而可调用 Query 接口的相关方法来执行查询操作。

JPQL 是面向对象进行查询的语言，可以通过自定义的 JPQL 完成 UPDATE 和 DELETE 操作。JPQL 不支持使用 INSERT。对于 UPDATE 或 DELETE 操作，必须使用注解 @Modifying 进行修饰。

JPQL 的用法见以下两段代码。

（1）下面代码表示根据 name 值进行查找。

public interface UserRepository extends JpaRepository<User, Long> (
　　@Query("select u from User u where u.name = ?1")
　　User findByName(String name);
}

（2）下面代码表示根据 name 值进行模糊查找。

public interface UserRepository extends JpaRepository<User, Long> { 
	@Query("select u from User u where u.name like %?1")
	List<User> findByName(String name);
}

3.用原生 SQL 进行查询

在使用原生 SQL 查询时，也使用注解 @Query。此时，nativeQuery 参数需要设置为 true。 下面先看一些简单的查询代码。

3.1 根据 ID 查询用户

public interface UserRepository extends JpaRepository<User, Long> (
	// 根据 ID 查询用户
	@Query(value = "select * from user u where u.id=:id", nativeQuery = true)
	User findById(@Param("id")Long id);
)

3.2 查询所有用户

public interface UserRepository extends JpaRepository<User, Long> {
	// 查询所有用户
	@Query(value = "select * from user", nativeQuery = true)
	List<User> findAllNative();
}

3.3 根据 email 查询用户

public interface UserRepository extends JpaRepository<User, Long> (
	// 根据 email 查询用户
	@Query(value = "select * from user where email= ?1", nativeQuery = true) 
	User findByEmail(String email);
)

3.4 根据 name 查询用户，并返回分页对象 Page

public interface UserRepository extends JpaRepository<User, Long> (
	@Query(value = "select * from user where name= ?1",
		   countQuery = "select count(*) from user where name= ?1", nativeQuery = true)
	Page<User> findByName(String name, Pageable pageable);
}

3.5 根据名字来修改 email 的值

@Modifying 
@Query("update user set email = :email where name =:name")
Void updateUserEmailByName(@Param("name")String name, @Param("email")String email);

3.6 使用事务

UPDATE 或 DELETE 操作需要使用事务。此时需要先定义 Service 层，然后在 Service 层的方法上添加事务操作。

对于自定义的方法，如果需要改变 Spring Data 提供的事务默认方式，则可以在方法上使用注解 @Transactional，如以下代码：

@Service
public classUserService {
　　@Autowired
　　private UserRepository userRepository;
　　@Transactional
　　public void updateEmailByName(String name, String email) {
　　　　userRepository.updateUserEmaiByName(name, email);
　　}
)

测试代码：

@Test
public void testUsingModifingAnnotation() {
　　userService.updateEmailByName("pipi", "88888888@qq.com");
}

在进行多个 Repository 操作时，也应该使这些操作在同一个事务中。按照分层架构的思想，这些操作属于业务逻辑层，因此需要在 Service 层实现对多个 Repository 的调用，并在相应的方法上声明事务。

4.用 Specifications 进行查询

如果要使 Repository 支持 Specification 查询，则需要在 Repository 中继承 JpaSpecificationExecutor 接口，具体使用见如下代码：

public interface CardRepository extends JpaRepository<Card,Long>, JpaSpecificationExecutor<Card> {
	Card findById(long id);
}

下面以一个例子来说明 Specifications 的具体用法：

@SpringBootTest
@RunWith(SpringRunner.class)
public class testJpaSpecificationExecutor (
　　@Autowired
　　private CardRepository cardRepository;
　　@Test
　　public void testJpaSpecificationExecutor() (
　　　　int pageNo = 0;
　　　　int pageSize = 5;
　　　　PageRequest pageable = PageRequest.of(pageNo, pageSize);
　　　　// 通常使用 Specification 的匿名内部类
　　　　Specification<Card> specification = new Specification<Card>() {
　　　　　　　　@Override
　　　　　　　　public Predicate toPredicate(Root<Card> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
　　　　　　　　　　Path path = root.get("id");
　　　　　　　　　　// gt 是大于的意思。这里代表 id 大于 2
　　　　　　　　　　Predicate predicate1 = cb.gt(path, 2);
　　　　　　　　　　// equal 是等于的意思，代表查询 num 值为 422803 的数据记录
　　　　　　　　　　Predicate predicate2 = cb.equal(root.get("num"), 422803);
　　　　　　　　　　// 构建组合的 Predicate
　　　　　　　　　　Predicate predicate = cb.and(predicate1, predicate2); 
　　　　　　　　　　return predicate;
　　　　　　　 }
　　　　};
　　　　Page<Card> page = cardRepository.findAll(specification, pageable);
　　　　System.out.println("总记录数: " + page.getTotalElements());
　　　　System.out.println("当前第: " + (page.getNumber() + 1) + "页");
　　　　System.out.println("总页数: " + page.getTotalPages());
　　　　System.out.println("当前页面的 List: " + page.getContent());
　　　　System.out.println("当前页面的记录数: "+ page.getNumberOfElements());
　　}
)

代码解释如下:

  • CriteriaQuery 接口：specific 的顶层查询对象，它包含查询的各个部分，比如，select、from、 where、group by、order by 等。CriteriaQuery 对象只对实体类型或嵌入式类型的 Criteria 查询起作用。
  • root：代表查询的实体类是 Criteria 查询的根对象。Criteria 查询的根定义了实体类型，能为将来的导航获得想要的结果。它与 SQL 查询中的 From 子句类似。Root 实例是类型化的， 且规定了 From 子句中能够出现的类型。查询根实例通过传入一个实体类型给 AbstractQuery.from 方法获得。
  • query：可以从中得到 Root 对象，即告知 JPA Criteria 查询要查询哪一个实体类。还可以添加查询条件，并结合 EntityManager 对象得到最终查询的 TypedQuery 对象。
  • CriteriaBuilder 对象：用于创建 Criteria 相关对象的工厂，可以从中获取到 Predicate 对象。
  • Predicate 类型：代表一个查询条件。

运行上面的测试代码，在控制台会输出如下结果（确保数据库已经存在数据）：

Hibernate: select card0_.id as id1_0_, card0_.num as num2_0_ from card cardO_ where card0_.id>2 and card0_.num=422803 limit ?
Hibernate: select count(card0_.id) as col_0_0_ from card card0_ where card0_.id>2 and card0_.num=422803
总记录数: 6
当前第: 1页 
总页数: 2 
当前页面的 List: [Card(id=4, num=422803), Card(id=8, num=422803), Card(id=10, num=422803), Card(id=20, num=422803), Card(id=23, num=422803)] 
当前页面的记录数: 5

5.用 ExampleMatcher 进行查询

Spring Data 可以通过 Example 对象来构造 JPQL 查询，具体用法见以下代码：

User user = new User();
//构建查询条件
user.setName("pipi")；
ExampleMatcher matcher = ExampleMatcher.matching()
	// 创建一个 ExampleMatcher, 不区分大小写匹配 name
	.withIgnorePaths("name")
	// 包括 null 值
	.withIncludeNullValues()
	// 执行后缀匹配
	.withStringMatcherEnding();
// 通过 Example 构建查询
Example<User> example = Example.of(user, matcher);
List<User> list = userRepository.findALL(example);

默认情况下，ExampleMatcher 会匹配所有字段。

可以指定单个属性的行为（如 name 或内嵌属性 name.user）。如：

  • withMatcher("name", endsWith())
  • withMatcher("name", startsWith().ignoreCase())

6.用谓语 QueryDSL 进行查询

QueryDSL 也是基于各种 ORM 之上的一个通用查询框架，它与 Spring Data JPA 是同级别的。使用 QueryDSL 的 API 可以写出 SQL 语句(Java 代码，非真正标准 SQL），不需要懂 SQL 语句。它能够构建类型安全的查询。这与 JPA 使用原生查询时有很大的不同，可以不必再对 Object[] 进行操作。它还可以和 JPA 联合使用。

7.用 NamedQuery 进行查询

官方不推荐使用 NamedQuery，因为它的代码必须写在实体类上面，这样不够独立。其使用方法见以下代码：

©Entity 
@NamedQuery(name = "User.findByName", query = "select u from User u where u.name = ?1") 
public class User {
}
Spring-data-jpa最全的查询语法总结，直入超神
我是香菜
06-05 1644
spring-data 一统江湖，玩转多种数据源今天这篇文章总结下spring data jpa的查询语法，在开发中能够灵活使用，在开始下面的之前我们定义一个entity，以便后面的部分使用这里定义一个玩家的entity@Data@Entity@ApiModel(description = "玩家信息")@Id@ApiModelProperty(value = "主键")@ApiModelProperty(value = "玩家名字")
Spring Boot 整合持久层技术全解析：构建高效数据访问层
2301_82182564的博客
12-20 841
开发者可以根据项目的需求、团队的技术栈以及性能要求等因素，选择合适的持久层技术进行整合。在实际应用中，深入理解这些技术的特点、整合步骤以及性能优化策略，能够构建出高效、稳定、可维护的数据访问层，为整个企业级应用的成功运行奠定坚实的基础。本文将深入探讨 Spring Boot 如何整合常见的持久层技术，包括 JDBC、MyBatis 以及 JPA（Hibernate），并通过详细的代码示例和原理讲解，让读者全面掌握这些整合的技巧与要点，能够在实际项目开发中灵活运用，构建出稳定、高效的数据访问层。
Spring Boot 之 JPA的查询方式
热门推荐
惟忆
05-24 4万+
JPA 的查询方式 约定方法名一定要根据命名规范来书写，Spring Data 会根据前缀、中间连接词（Or、And、Like、NotNull 等类似 SQL 中的关键字）、内部拼接 SQL 代理生成方法的实现。约定方法名的方法见表： 关键词 SQL符号 样例 对应JPQL 语句片段 And and findByLastnameAndFirstname … where x.lastname = ?1 and x.first
SpringData JPA查询方法：方法名称查询与@Query注解
最新发布
程序媛学姐的博客
03-14 848
虽然方法名称查询强大且便捷，但对于复杂的查询场景，使用@Query注解可以提供更大的灵活性和更好的可读性。@Query注解允许开发者自定义JPQL或原生SQL查询。Spring Data JPA的查询方法体系为开发者提供了强大而灵活的数据访问能力。基于方法名称的查询机制通过简洁的命名约定自动生成查询，适用于简单到中等复杂度的查询场景，显著减少样板代码。而@Query注解则为复杂查询提供了更大的灵活性，支持自定义JPQL和原生SQL，解决了方法名称查询的局限性。
JPA 三种查询方式
andybbc的博客
01-30 2433
Java JPA有三种查询方式： 1）JPQL 2）Criteria API 3）SQL 下面一一详解。 一、本地SQL查询 SQL是标准化的查询语言，用于管理数据。下面的例子说明了怎样实现本地SQL查询： [java] view plaincopyprint? // 获得实体管理器EntityManager em = …// 建立SQL查询Strin
Spring Boot+JPA项目，查询功能，多种场景实现方法
pi_tiger的博客
01-17 1063
Spring Boot+JPA项目，多条件查询的(3种)写法 此文章描述的三种写法，皆为本人遇到的3种，改文章主要用于记录，后续如有其他写法会及时更新 使用Specification Specification<ParkingLot> query = new Specification<ParkingLot>() { private static final long serialVersionUID = 1L; @Override public Predi
12、JPA查询-3种查询方式
红鹰
07-11 6182
JPA查询JPA 3中查询方式案例数据准备1、Entity类型定义2、persistence.xml配置3、初始化查询案例数据查询案例1、JPQL查询2、SQL查询3、命名查询@NamedNativeQuery @NamedQuery3.1、命名查询 JPQL和SQL定义3.2、命名查询案例 JPA 3中查询方式 JPQL 方式查询，表和列名称都是类和字段名称 @Entity 名称 SQL 传统SQL查询 @NamedNativeQuery 和@NamedQuery 命名查询，最大程度复用JPQL或S
别再拼sql了，JPA中还可以使用这几种查询方式
园区阿祖的博客
03-14 1100
JPA几种查询方式，Example、Specification、Criteria
spring-boot-javafx-jpa-demo：Spring Boot Java FX JPA集成示例
02-12
【Spring Boot JavaFX JPA集成示例】是一个项目，展示了如何在Spring Boot框架下整合JavaFX图形用户界面和JPA（Java Persistence API）持久层技术，以实现数据库操作。这个项目可以帮助开发者理解如何构建一个完整的...
Spring-Boot-Hibernate-JPA:员工管理工具
05-11
总结起来，"Spring-Boot-Hibernate-JPA:员工管理工具"项目展示了如何结合Spring Boot的便捷性、Hibernate的ORM功能以及JPA的标准API，构建一个高效且易于维护的员工管理系统。这对于理解和掌握这些技术，以及提升...
dbApi-spring-boot-starter-demo:dbApi-spring-boot-starter案例代码
03-15
dbApi-spring-boot-starter的核心功能在于简化数据库访问层的实现，它集成了Spring Data JPA、MyBatis等主流持久层框架，同时也支持自定义数据访问策略。通过自动配置，开发者可以快速接入数据库，无需编写大量的DAO...
Spring-Boot-REST-Contact：REST API com Spring Boot e JPA
02-15
【描述】"这个项目是关于如何使用Spring Boot框架和Java Persistence API（JPA）来创建一个RESTful API的实例。REST（Representational State Transfer）是一种网络应用程序的设计风格和开发方式，基于HTTP协议，...
从零开始 Spring Boot 65：JPA 中的查询语句
梦幻天空
07-09 585
用 Query 或 NativeQuery 构建查询语句相对简单，前者相比后者，更具移植性（屏蔽了具体数据库产品的差异）和通用性，并且可以利用 JPA 层的缓存和过滤器等特性，但缺点是无法使用具体数据库的特异化查询语句。所谓的条件 API（Criteria API）指的是可以帮助我们构建 SQL 查询条件的一组 API，可以利用这些 API 来构建查询语句并执行。对于需要重复使用的 JPQL 语句，可以定义被称作 NamedQuery 的查询语句。相应的，也不使用表字段，用实体属性名称取代。
SpringData JPA 接口查询
路边烧卖
09-09 1265
SpringData JPA 接口查询 1、SpringData 接口继承结构 Repository：最顶层的接口，是一个空的接口，目的是为了统一所有Repository的类型，且能让组件扫描的时候自动识别。 CrudRepository ：是Repository的子接口，提供CRUD的功能 PagingAndSortingRepository：是CrudRepository的子接口，添加分页和排序的功能 JpaRepository：是PagingAndSortingRepository的子接口，增加了一
Spring Data JPA 实例查询
2401_86940371的博客
10-10 1173
查询时，对一个要进行匹配的属性（如：姓名 name），只能传入一个过滤条件值，如以Customer为例，要查询姓“刘”的客户，“刘”这个条件值就存储在表示条件对象的Customer对象的name属性中，针对于“姓名”的过滤也只有这么一个存储过滤值的位置，没办法同时传入两个过滤值。正是由于这个限制，有些查询是没办法支持的，例如要查询某个时间段内添加的客户，对应的属性是 addTime，需要传入“开始时间”和“结束时间”两个条件值，而这种查询方式没有存两个值的位置，所以就没办法完成这样的查询。
JPA--SpringDataJPA的四种查询方式
吴声子夜歌的博客
12-16 569
SpringDataJPA的四种查询方式 借助接口中的定义好的方法完成查询 jpql的查询方式 sql语句的查询 方法名称规则查询 示例 创建Maven工程并导入依赖 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns...
spring boot jpa之 从方法名创建查询
qq_27886997的博客
10-09 1192
Repository是总接口，CrudRepository继承它，PagingAndSortingRepository又继承CrudRepository   ， JpaRepository继承PagingAndSortingRepository dao层例如定义了 UserRepository  extends JpaRepository&lt;User,Long&gt;{         ...
spring data jpa基本查询
weixin_43326384的博客
12-14 245
PageRequest pageRequest = PageRequest.of(0, 5); String name = null; List<Integer> saleList = new ArrayList<>(); // saleList.add(10); // saleList.add(6); List<Long> categoryList = new ArrayList<>(); categoryList.add(12l)..
JPA查询-3种查询方式
没有伞的孩子必须努力奔跑！—小林
09-03 5963
spring data jpa
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

G皮T

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值