spring boot jpa之 从方法名创建查询

Repository是总接口，CrudRepository继承它，PagingAndSortingRepository又继承CrudRepository   ，
JpaRepository继承PagingAndSortingRepository
dao层例如定义了 UserRepository  extends JpaRepository<User,Long>{

              //........这里面就是查询方法，可以按方法名字来定义，或者命名式查询、按示例查询、@Query查询等

}

想知道他们中的api可以引入jar包源码，点进去查看；项目中dao层定义的接口继承JpaRepository或者PagingAndSortingRepository；
dao层上自定义的接口不用使用 @Repository ,只需要在数据源的配置@Configuration 里指定dao层的路径即可，spring boot自动会把数据源注入到dao层来实例化 ；@NoRepositoryBean只加在中间的过度接口中，这中接口不用实例化；MyBaseRepository的作用就是有选择地暴露CRUD方法；

定义查询方法：

这里先说按方法名字来定义查询方法

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

利用属性获取任务列表

1 2 3

interface TaskDao extends MyBaseRepository<Task, Long> {   List<Task> findByName(String name); }

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

1 2 3 4

interface TaskDao extends JpaRepository<Task, Long> {   List<Task> findByNameAndProjectId(String name,Long projectId);   List<Task> findByNameOrProjectId(String name,Long projectId); }

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

1 2 3 4 5

interface TaskDao extends JpaRepository<Task, Long> {   Page<Task> findByName(String name,Pageable pageable);   Slice<Task> findByName(String name, Pageable pageable);   List<Task> findByName(String name, Sort sort); }

 利用Distinct去重

1 2 3

interface TaskDao extends JpaRepository<Task, Long> {     List<Person> findDistinctTaskByNameOrProjectId(String name, Long projectId); }

 利用OrderBy进行排序

1 2 3

interface TaskDao extends JpaRepository<Task, Long> {     List<Person> findByNameOrderByProjectIdDesc(String name, Long projectId); }

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

1 2 3 4 5 6 7 8 9 10 11 12 13

interface TaskDao extends JpaRepository<Task, Long> {     User findFirstByOrderByLastnameAsc();   Task findTopByOrderByNameDesc(String name);   Page<Task> queryFirst10ByName(String name, Pageable pageable);   Slice<Task> findTop3ByName(String name, Pageable pageable);   List<Task> findFirst10ByName(String name, Sort sort);   List<Task> findTop10ByName(String name, Pageable pageable); }

 

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

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

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

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

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

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

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

支持的规范表达式，这里以实体为User，有firstName和lastName,age

表达式	例子	hql查询语句
And	findByLastnameAndFirstname	… where x.lastname = ?1 and x.firstname = ?2
Or	findByLastnameOrFirstname	… where x.lastname = ?1 or x.firstname = ?2
Is,Equals	findByFirstname,findByFirstnameIs,findByFirstnameEqual	… 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	findByAgeIsNull	… where x.age is null
IsNotNull,NotNull	findByAge(Is)NotNull	… 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 (parameter bound with appended %)
EndingWith	findByFirstnameEndingWith	… where x.firstname like ?1 (parameter bound with prepended %)
Containing	findByFirstnameContaining	… where x.firstname like ?1 (parameter bound wrapped in %)
OrderBy	findByAgeOrderByLastnameDesc	… where x.age = ?1 order by x.lastname desc
Not	findByLastnameNot	… where x.lastname <> ?1
In	findByAgeIn(Collection ages)	… where x.age in ?1
NotIn	findByAgeNotIn(Collection age)	… where x.age not in ?1
True	findByActiveTrue()	… where x.active = true
False	findByActiveFalse()	… where x.active = false
IgnoreCase	findByFirstnameIgnoreCase	… where UPPER(x.firstame) = UPPER(?1)

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