spring data jpa怎么创建方法名进行简单查询

2024-10-26 技术教程

本文小编为大家详细介绍“springdatajpa怎么创建方法名进行简单查询”，内容详细，步骤清晰，细节处理妥当，希望这篇“springdatajpa怎么创建方法名进行简单查询”文章能帮助大家解决疑惑，下面跟着小编的思路慢慢深入，一起来学习新知识吧。

spring data jpa 可以通过在接口中按照规定语法创建一个方法进行查询，spring data jpa 基础接口中，如CrudRepository中findOne，save，delete等，那么我们自己怎么按照需要创建一个方法进行查询呢？

最常见的做法是

声明一个接口继承于CrudRepository 或者 PagingAndSortingRepository，JpaRepository,Repository

publicinterfaceTaskDaoextendsJpaRepository<Task,Long>{}

或者利用注释的方式表名继承于JpaRepository，例如下面这俩种是等价的

@RepositoryDefinition(domainClass=Task.class,idClass=Long.class)publicinterfaceTaskDao{}publicinterfaceTaskDaoextendsJpaRepository<Task,Long>{}

继承CrudRepository 或者 PagingAndSortingRepository，JpaRepository会抽出一些常用的方法，如果你spring data jpa帮你自定义那么多方法，你可以继承于JpaRepository，然后复制一些方法到你的接口中，可以选择性的要一些方法

@NoRepositoryBeaninterfaceMyBaseRepository<T,IDextendsSerializable>extendsRepository<T,ID>{TfindOne(IDid);Tsave(Tentity);}interfaceTaskDaoextendsMyBaseRepository<Task,Long>{}按照规范创建查询方法

一般按照java驼峰式书写规范加一些特定关键字，例如我们想通过任务名来获取任务实体类列表

利用属性获取任务列表

interfaceTaskDaoextendsMyBaseRepository<Task,Long>{List<Task>findByName(Stringname);}

利用and 和 or来获取任务列表

interfaceTaskDaoextendsJpaRepository<Task,Long>{List<Task>findByNameAndProjectId(Stringname,LongprojectId);List<Task>findByNameOrProjectId(Stringname,LongprojectId);}

利用Pageable ，Sort，Slice获取分页的任务列表和排序

interfaceTaskDaoextendsJpaRepository<Task,Long>{Page<Task>findByName(Stringname,Pageablepageable);Slice<Task>findByName(Stringname,Pageablepageable);List<Task>findByName(Stringname,Sortsort);}

利用Distinct去重

interfaceTaskDaoextendsJpaRepository<Task,Long>{List<Person>findDistinctTaskByNameOrProjectId(Stringname,LongprojectId);}

利用OrderBy进行排序

interfaceTaskDaoextendsJpaRepository<Task,Long>{List<Person>findByNameOrderByProjectIdDesc(Stringname,LongprojectId);}

利用 Top 和 First来获取限制数据

interfaceTaskDaoextendsJpaRepository<Task,Long>{UserfindFirstByOrderByLastnameAsc();TaskfindTopByOrderByNameDesc(Stringname);Page<Task>queryFirst10ByName(Stringname,Pageablepageable);Slice<Task>findTop3ByName(Stringname,Pageablepageable);List<Task>findFirst10ByName(Stringname,Sortsort);List<Task>findTop10ByName(Stringname,Pageablepageable);}

那么spring data jpa是怎么通过这些规范来进行组装成查询语句呢？

Spring Data JPA框架在进行方法名解析时，会先把方法名多余的前缀截取掉，比如 find、findBy、read、readBy、get、getBy，然后对剩下部分进行解析。

假如创建如下的查询：findByTaskProjectName()，框架在解析该方法时，首先剔除 findBy，然后对剩下的属性进行解析，假设查询实体为Doc

先判断 taskProjectName （根据 POJO 规范，首字母变为小写）是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，继续第二步；

从右往左截取第一个大写字母开头的字符串此处为Name），然后检查剩下的字符串是否为查询实体的一个属性，如果是，则表示根据该属性进行查询；如果没有该属性，则重复第二步，继续从右往左截取；最后假设task为查询实体Person的一个属性；

接着处理剩下部分(ProjectName），先判断 task 所对应的类型是否有projectName属性，如果有，则表示该方法最终是根据 “ Person.task.projectName”的取值进行查询；否则继续按照步骤 2 的规则从右往左截取，最终表示根据 “Person.task.project.name” 的值进行查询。

可能会存在一种特殊情况，比如 Person包含一个 task 的属性，也有一个 projectName 属性，此时会存在混淆。可以明确在属性之间加上 “_” 以显式表达意图，比如 “findByTask_ProjectName()”

支持的规范表达式

这里以实体为User，有firstName和lastName,age

表达式例子hql查询语句AndfindByLastnameAndFirstname… where x.lastname = ?1 and x.firstname = ?2OrfindByLastnameOrFirstname… where x.lastname = ?1 or x.firstname = ?2Is,EqualsfindByFirstname,findByFirstnameIs,findByFirstnameEqual… where x.firstname = 1?BetweenfindByStartDateBetween… where x.startDate between 1? and ?2LessThanfindByAgeLessThan… where x.age < ?1LessThanEqualfindByAgeLessThanEqual… where x.age ⇐ ?1GreaterThanfindByAgeGreaterThan… where x.age > ?1GreaterThanEqualfindByAgeGreaterThanEqual… where x.age >= ?1AfterfindByStartDateAfter… where x.startDate > ?1BeforefindByStartDateBefore… where x.startDate < ?1IsNullfindByAgeIsNull… where x.age is nullIsNotNull,NotNullfindByAge(Is)NotNull… where x.age not nullLikefindByFirstnameLike… where x.firstname like ?1NotLikefindByFirstnameNotLike… where x.firstname not like ?1StartingWithfindByFirstnameStartingWith… where x.firstname like ?1 (parameter bound with appended %)EndingWithfindByFirstnameEndingWith… where x.firstname like ?1 (parameter bound with prepended %)ContainingfindByFirstnameContaining… where x.firstname like ?1 (parameter bound wrapped in %)OrderByfindByAgeOrderByLastnameDesc… where x.age = ?1 order by x.lastname descNotfindByLastnameNot… where x.lastname <> ?1InfindByAgeIn(Collection ages)… where x.age in ?1NotInfindByAgeNotIn(Collection age)… where x.age not in ?1TruefindByActiveTrue()… where x.active = trueFalsefindByActiveFalse()… where x.active = falseIgnoreCasefindByFirstnameIgnoreCase… where UPPER(x.firstame) = UPPER(?1)

读到这里，这篇“springdatajpa怎么创建方法名进行简单查询”文章已经介绍完毕，想要掌握这篇文章的知识点还需要大家自己动手实践使用过才能领会，如果想了解更多相关内容的文章，欢迎关注亿速云行业资讯频道。