Spring Boot 之 JPA的查询方式

最新推荐文章于 2025-08-18 14:46:08 发布
原创 最新推荐文章于 2025-08-18 14:46:08 发布 · 4.8w 阅读 · 14 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#sql

本文详细介绍了如何在SpringData JPA中利用约定方法名进行高效查询，包括SQL符号与对应方法的映射，如And、Or、Like等，以及使用JPQL、原生SQL、Specifications和ExampleMatcher的实例。掌握这些技巧，提升数据检索的灵活性和代码可读性。

JPA 的查询方式

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

关键词SQL符号样例对应JPQL 语句片段
AndandfindByLastnameAndFirstname… where x.lastname = ?1 and x.firstname = ?2
OrorfindByLastnameOrFirstname… where x.lastname = ?1 or x.firstname = ?2
Is,Equals=findByFirstname,findByFirstnameIs,findByFirstnameEquals… where x.firstname = ?1
Betweenbetween xxx and xxxfindByStartDateBetween… 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
IsNullis nullfindByAgeIsNull… where x.age is null
IsNotNull,NotNullis not nullfindByAge(Is)NotNull… where x.age not null
LikelikefindByFirstnameLike… where x.firstname like ?1
NotLikenot likefindByFirstnameNotLike… where x.firstname not like ?1
StartingWithlike 'xxx%'findByFirstnameStartingWith… where x.firstname like ?1(parameter bound with appended %)
EndingWithlike 'xxx%'findByFirstnameEndingWith… where x.firstname like ?1(parameter bound with prepended %)
Containinglike '%xxx%'findByFirstnameContaining… where x.firstname like ?1(parameter bound wrapped in %)
OrderByorder byfindByAgeOrderByLastnameDesc… where x.age = ?1 order by x.lastname desc
Not<>findByLastnameNot… where x.lastname <> ?1
Inin()findByAgeIn(Collection<Age> ages)… where x.age in ?1
NotInnot in()findByAgeNotIn(Collection<Age> ages)… where x.age not in ?1
TRUE=truefindByActiveTrue()… where x.active = true
FALSE=falsefindByActiveFalse()… where x.active = false
IgnoreCaseupper(xxx)=upper(yyyy)findByFirstnameIgnoreCase… where UPPER(x.firstame) = UPPER(?1)

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

package com.example.repository;

import com.example.jpa.User;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Slice;
import org.springframework.data.domain.Sort;
import org.springframework.data.repository.Repository;

import java.util.List;

public interface UserRepository extends Repository<User, Long> {
    User findFirstByOrderByNameAsc();

    List<User> findByEmailOrName(String email, String name);

    Page<User> queryFirst100ByName(String name, Pageable pageable);

    Slice<User> findTop100ByName(String name, Pageable pageable);

    List<User> findFirst100ByName(String name, Sort sort);
}

用 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 的用法：


package com.example.repository;

import com.example.jpa.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;

import java.util.List;

public interface UserRepository2 extends JpaRepository<User, Long> {

    // 根据名称查询
    @Query("select u from User u where u.name = ?1")
    User fingByName(String name);
    
    // 根据名称模糊查询
    @Query("select u from User u where u.name like %?1")
    List<User> findByName(String name);
}

用原生 SQL 进行查询

package com.example.repository;

import com.example.jpa.User;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;

import java.util.List;
import java.util.Optional;

public interface UserRepository2 extends JpaRepository<User, Long> {

    // 根据 ID 查询
    @Query(value = "select * from User u where u.id = :id", nativeQuery = true)
    Optional<User> findById(@Param("id") Long id);

    // 查询所有用户
    @Query(value = "select * from User", nativeQuery = true)
    List<User> findAllNative();

    // 根据 Email 查询
    @Query(value = "select * from User where email = ?1", nativeQuery = true)
    User findByEmail(String email);

    // 根据 Name 查询，并返回分页对象 Page
    @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);

    // 根据 Name 来修改 Email 的值
    @Modifying
    @Transactional
    @Query("update User set email = :email where name = :name")
    Integer updateUserEmailByName(@Param("name") String name, @Param("email") String email);
}

使用事务

UPDATE 或 DELETE 操作需要使用事务。此时需要先定义 Service 层，然后在 Service 层的方法上添加事务操作。对于自定义的方法，如果需要改变 Spring Data 提供的事务默认方法，则可以在方法上使用注解 @Transactional：

    // 根据 Name 来修改 Email 的值
    @Modifying
    @Transactional
    @Query("update User set email = :email where name = :name")
    Integer updateUserEmailByName(@Param("name") String name, @Param("email") String email);

测试

package com.example.bean;

import com.example.jpa.User;
import com.example.repository.UserRepository2;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class UserServiceTest {

    @Autowired
    UserRepository2 userRepository2;

    @Test
    void TestUpdateEmailByName() {
        Integer i = userRepository2.updateUserEmailByName("张三", "sdfgsgsdfg@163.com");
        System.out.println(i);
    }

    @Test
    void TestFindById() {
        List<User> list = userRepository2.findAllNative();
        System.out.println(list);
    }
}

用 Specifications 查询

如果想使 Repository 支持 Specification 查询，则需要在 Repository 中继承 JpaSpecificationExecutor 接口

package com.example.repository;

import com.example.jpa.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.jpa.domain.Specification;

import javax.persistence.criteria.*;

@SpringBootTest
class UserRepository3Test {

    @Autowired
    private UserRepository3 userRepository3;

    @Test
    public void testJpa() {
        PageRequest pageable = PageRequest.of(0, 10);
        // 通常使用 Specification 的匿名内部类

        Specification<User> specification = new Specification<User>() {
            @Override
            public Predicate toPredicate(Root<User> root, CriteriaQuery<?> criteriaQuery, CriteriaBuilder criteriaBuilder) {
                Path path = root.get("id");
                // gt 是大于的意思，这里表示 ID 大于 2
                Predicate predicate1 = criteriaBuilder.gt(path, 2);
                // equal 是等于的意思，代表查询 name 值为 赵四 的数据记录
                Predicate predicate2 = criteriaBuilder.equal(root.get("name"), "赵四");
                // 构建组合的 Predicate
                Predicate predicate = criteriaBuilder.and(predicate1, predicate2);
                return predicate;
            }
        };

        Page<User> page = userRepository3.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());
    }
}

Hibernate: select user0_.id as id1_0_, user0_.email as email2_0_, user0_.name as name3_0_, user0_.pswd as pswd4_0_ from user user0_ where user0_.id>2 and user0_.name=? limit ?
Hibernate: select count(user0_.id) as col_0_0_ from user user0_ where user0_.id>2 and user0_.name=?
总记录数：100
当前第：1 页
总页数：10
当前页面的 List：[User(id=4, name=赵四, pswd=123456, email=345634@qq.com), User(id=5, name=赵四, pswd=123456, email=345634@qq.com), User(id=6, name=赵四, pswd=123456, email=345634@qq.com), User(id=7, name=赵四, pswd=123456, email=345634@qq.com), User(id=8, name=赵四, pswd=123456, email=345634@qq.com), User(id=9, name=赵四, pswd=123456, email=345634@qq.com), User(id=10, name=赵四, pswd=123456, email=345634@qq.com), User(id=11, name=赵四, pswd=123456, email=345634@qq.com), User(id=12, name=赵四, pswd=123456, email=345634@qq.com), User(id=13, name=赵四, pswd=123456, email=345634@qq.com)]
当前页面的记录数：10

用 ExampleMatcher 进行查询

Spring Data 可以通过 Example 对象来构造 JPQL 查询

package com.example.repository;

import com.example.jpa.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.domain.Example;
import org.springframework.data.domain.ExampleMatcher;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.jpa.domain.Specification;

import javax.persistence.criteria.*;
import java.util.List;

@SpringBootTest
class UserRepository3Test {

    @Autowired
    private UserRepository3 userRepository3;

    @Test
    public void testExample() {
        User user = new User();
        // 构建查询条件
        user.setName("张三");
        // 创建一个 ExampleMatcher
        ExampleMatcher matcher = ExampleMatcher.matching()
                // 不区分大小写匹配 Name
                .withIgnorePaths("name")
                // 包含 null 值
                .withIncludeNullValues();
        // 通过 Example 构建查询
        Example<User> example = Example.of(user, matcher);
        List<User> list = userRepository3.findAll(example);
        System.out.println(list);
    }
}
憶
关注
Springboot 快速学会使用 JPA 分页查询
默默不代表沉默
10-16 6186
如果还不知道springboot怎么使用JPA的，先参考这篇 Springboot快速整合JPA实现增删查改：https://blog.csdn.net/qq_35387940/article/details/102541311 接下来回到正题 示例场景,将下面表数据分页查询出来： 简单模拟， mapper： @Query(value="select * from u...
【Spring Boot】Spring Boot中的简单查询
衍生星球的博客
09-12 1219
JPA除了可以直接使用JpaRepository接口提供的基础功能外，还支持根据实体的某个属性实现数据库操作，Spring Data JPA能够根据其方法名为其自动生成SQL，支持的关键字有find、query、get、read、count、delete等，主要的语法是findByXX、queryByXX、getByXX、readByXX、countByXX等。
org.springframework.data.domain.Sort 教程
最新发布
wobenwoxiangfei的博客
08-18 420
是 Spring Data 提供的用于排序查询结果的工具类，支持单字段或多字段排序，可与 Spring Data JPA、MongoDB 等模块集成。，可以轻松实现动态排序需求。
SpringBoot系列教程JPA之query使用姿势详解之基础篇
程序员高级码农的博客
01-09 2071
本篇将介绍一些基础的查询使用姿势，主要包括根据字段查询，语句，数字比较，排序以及分页。
【Spring Boot】Java 持久层 API（三）：JPA 的查询方式
Code · Cloud · Think · Repeat
06-30 2186
QueryDSL 也是基于各种 ORM 之上的一个通用查询框架，它与 Spring Data JPA 是同级别的。使用 QueryDSL 的 API 可以写出 SQL 语句(Java 代码，非真正标准 SQL），不需要懂 SQL 语句。它能够构建类型安全的查询。这与 JPA 使用原生查询时有很大的不同，可以不必再对 Object[] 进行操作。它还可以和 JPA 联合使用。
Spring Boot+JPA项目，查询功能，多种场景实现方法
pi_tiger的博客
01-17 1153
Spring Boot+JPA项目，多条件查询的(3种)写法 此文章描述的三种写法，皆为本人遇到的3种，改文章主要用于记录，后续如有其他写法会及时更新 使用Specification Specification<ParkingLot> query = new Specification<ParkingLot>() { private static final long serialVersionUID = 1L; @Override public Predi
spring boot整合JPA——demo
01-25
Spring Boot 整合 JPA（Java Persistence API）是现代Java应用程序中常见的数据访问技术，它提供了简化数据库操作的抽象层，让开发者可以更专注于业务逻辑而不是底层的SQL语句。本示例“spring boot整合JPA——demo...
java + spring boot +jpa 拦截器分库分表demo
03-30
本Demo主要展示了如何结合Java、Spring Boot以及JPA实现一个分库分表的解决方案。 首先，我们要理解什么是JPA（Java Persistence API）。JPA是Java提供的一种ORM（对象关系映射）规范，用于简化数据库操作，使得...
Spring-Boot-JPA-Hibernate-Query-Methods:Spring Boot JPAHibernate查询方法
04-04
Spring Boot JPAHibernate查询方法 Spring Data JPA是提供各种API来执行CRUD操作的Spring Data模块之一.Spring Data JPA主要用于存储库层的开发。 在Spring Data中，我们可以定义存储库接口和方法来检索数据。 所有...
spring boot jpa security
05-08
Spring Data JPA是Spring框架的一个模块，提供了对JPA的高级支持，包括自动配置、查询生成和仓库抽象层，使得数据库操作更加便捷。 Spring Security是一个功能强大的安全框架，用于保护基于Spring的应用程序。它...
Spring Boot之JPA实战视频课程
06-09
本套课程，以实际操作演示为主，代码实例详细讲解了在Spring Boot框架使用JPA的一些规则与常见套路。课程中涉及到JPA的使用规则、核心概念、实体关系使用规则和常见问题等内容。该套课程后，让你全面熟悉与掌握...
springboot 中Jpa查询
Dalton2017的博客
05-06 370
Jpa (Java Persistence API) 是 Sun 官方提出的 Java 持久化规范。它为 Java 开发人员提供了一种对象/关联映射工具来管理 Java 应用中的关系数据。它的出现主要是为了简化现有的持久化开发工作和整合 ORM 技术，结束现在 Hibernate，TopLink，JDO 等 ORM 框架各自为营的局面。 值得注意的是，Jpa是在充分吸收了现有 Hibernate...
SpringBoot使用SpringDataJPA通过方法名查询
weixin_44232093的博客
05-02 1306
文章目录JPA方法名查询1. 方法名表图2. 举例说明3. 测试 JPA方法名查询 约定方法名一定要根据命名规范来书写，Spring Data 会根据前缀、中间连接词（Or、And、Like、NotNull 等类似 SQL 中的关键字）、内部拼接 SQL 代理生成方法的实现,约定方法名的方法见表: 1. 方法名表图 关键词 SQL符号 举例 最终执行的JPQL 片段 And and findByAddressLikeAndState … where x.lastname = ?1 and x
spring boot jpa之 从方法名创建查询
qq_27886997的博客
10-09 1213
Repository是总接口，CrudRepository继承它，PagingAndSortingRepository又继承CrudRepository   ， JpaRepository继承PagingAndSortingRepository dao层例如定义了 UserRepository  extends JpaRepository&lt;User,Long&gt;{         ...
68、Spring Data JPA 的 方法名关键字查询（全自动，既不需要提供sql语句，也不需要提供方法体）
Java 领域技术分享
09-15 1376
Spring Data JPA 的 方法名关键字查询
从零开始 Spring Boot 65：JPA 中的查询语句
梦幻天空
07-09 618
用 Query 或 NativeQuery 构建查询语句相对简单，前者相比后者，更具移植性（屏蔽了具体数据库产品的差异）和通用性，并且可以利用 JPA 层的缓存和过滤器等特性，但缺点是无法使用具体数据库的特异化查询语句。所谓的条件 API（Criteria API）指的是可以帮助我们构建 SQL 查询条件的一组 API，可以利用这些 API 来构建查询语句并执行。对于需要重复使用的 JPQL 语句，可以定义被称作 NamedQuery 的查询语句。相应的，也不使用表字段，用实体属性名称取代。
史上最全的SpringBoot | JPA基本查询SQL
qq_31532979的博客
07-17 2270
JPA操作SQL
SpringBoot_JPA之命名查询
tangyaya8的博客
11-04 2486
Named-Query 就是在Entity上定义相关的查询方法，然后在Session中查询的时候，可以调用这个方法，实现相关的查询 XML方式 Person类： package com.tangbaobao.springbootjpa.pojo; import lombok.Data; import javax.persistence.Entity; import javax.persiste...
spring data jpa根据方法名查询
weixin_33862514的博客
09-19 361
表达式例子hql查询语句 And findByLastnameAndFirstname … where x.lastname = ?1 and x.firstname = ?2 Or findByLastnameOrFirstname … where x.lastname = ?1 or x.firstname = ?2 Is,Equals fi...
Spring Boot与JPA整合实例演示
Spring Boot的快速搭建和自动配置功能可以大大简化JPA项目的基础设置，同时Spring Data JPA为JPA的使用提供了更简洁的API，包括简化查询方法的命名规则等。此外，Spring Data JPA的Repository抽象层简化了数据访问层...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值