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

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

目录最常见的做法是按照规范创建查询方法支持的规范表达式

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

最常见的做法是

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

public interface TaskDao extends JpaRepository{

}

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

@RepositoryDefinition(domainClass = Task.class, idClass = Long.class)

public interface TaskDao{

}

public interface TaskDao extends JpaRepository{

}

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

@NoRepositoryBean

interface MyBaseRepository extends Repository {

T findOne(ID id);

T save(T entity);

}

interface TaskDao extends MyBaseRepository {

}

按照规范创建查询方法

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

利用属性获取任务列表

interface TaskDao extends MyBaseRepository {

List

}

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

interface TaskDao extends JpaRepository {

List findByNameAndProjectId(String name,Long projectId);

List findByNameOrProjectId(String name,Long projectId);

}

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

interface TaskDao extends JpaRepository {

Page findByName(String name,Pageable pageable);

Slice findByName(String name, Pageable pageable);

List findByName(String name, Sort sort);

}

利用Distinct去重

interface TaskDao extends JpaRepository {

List findDistinctTaskByNameOrProjectId(String name, Long projectId);

}

利用OrderBy进行排序

interface TaskDao extends JpaRepository {

List findByNameOrderByProjectIdDesc(String name, Long projectId);

}

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

interface TaskDao extends JpaRepository {

User findFirstByOrderByLastnameAsc();

Task findTopByOrderByNameDesc(String name);

Page queryFirst10ByName(String name, Pageable pageable);

Slice findTop3ByName(String name, Pageable pageable);

List findFirst10ByName(String name, Sort sort);

List findTop10ByName(String name, Pageable pageable);

}

那么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()”

支持的规范表达式

这里以实体为Uhttp://ser，有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)

发现这些查询都是只针对单表进行查询，如果是多表的复杂查询，还有分页该怎么查，下次再研究看看…

}

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

interface TaskDao extends JpaRepository {

List findByNameAndProjectId(String name,Long projectId);

List findByNameOrProjectId(String name,Long projectId);

}

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

interface TaskDao extends JpaRepository {

Page findByName(String name,Pageable pageable);

Slice findByName(String name, Pageable pageable);

List findByName(String name, Sort sort);

}

利用Distinct去重

interface TaskDao extends JpaRepository {

List findDistinctTaskByNameOrProjectId(String name, Long projectId);

}

利用OrderBy进行排序

interface TaskDao extends JpaRepository {

List findByNameOrderByProjectIdDesc(String name, Long projectId);

}

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

interface TaskDao extends JpaRepository {

User findFirstByOrderByLastnameAsc();

Task findTopByOrderByNameDesc(String name);

Page queryFirst10ByName(String name, Pageable pageable);

Slice findTop3ByName(String name, Pageable pageable);

List findFirst10ByName(String name, Sort sort);

List findTop10ByName(String name, Pageable pageable);

}

那么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()”

支持的规范表达式

这里以实体为Uhttp://ser，有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)

发现这些查询都是只针对单表进行查询，如果是多表的复杂查询，还有分页该怎么查，下次再研究看看…

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。