74. Spring Data JPA方法定义规范【从零开始学Spring Boot】

【从零开始学习Spirng Boot—常见异常汇总】

    事情的起因：有人问过我们这个这个问题：为什么我利用Spring data jpa写的方法没有按照我想要的情况进行执行呢？我记得当时只是告诉他你你先看看Spring Data的命名规则吧。所以在这一小节把Spring Data方法定义的规则简单说明下。

 

（1）简单条件查询

       简单条件查询：查询某一个实体类或者集合。

       按照Spring Data的规范的规范，查询方法以find | read | get 开头，涉及查询条件时，条件的属性用条件关键字连接，要注意的是：条件属性以首字母大写。

       例如：定义一个Entity实体类：

class People{

       private String firstName;

       private String lastName;

}

       以上使用and条件查询时，应这样写：

findByLastNameAndFirstName(String lastName,String firstName); 

注意：条件的属性名称与个数要与参数的位置与个数一一对应 

       那么接下里我们看看Spring Data支持的关键字。

      

（2）支持的关键字

       直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下：

 

 

 

 

       好了这些关键词具体大家可以自己去实战下。接下里我觉得有必要说说Spring Data查询方法解析流程。

 

（3）查询方法解析流程

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

  -- 先判断userDepUuid (根据POJO（Plain Ordinary Java Object简单java对象，实际就是普通java bean）规范，首字母变为小写。)是否是查询实体的一个属性，如果根据该属性进行查询；如果没有该属性，继续第二步。

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

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

 -- 可能会存在一种特殊情况，比如 Doc包含一个 user 的属性，也有一个 userDep 属性，此时会存在混淆。可以明确在属性之间加上 "_" 以显式表达意图，比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"。

  -- 特殊的参数： 还可以直接在方法的参数上加入分页或排序的参数，比如：

Page<UserModel> findByName(String name, Pageable pageable);

List<UserModel> findByName(String name, Sort sort);

 

（4）结束语

 

       Spring Data确实博大精深，没有实战过，真的是没法很灵活在项目中进行使用。在实际使用过程中，理论知道了但是还是会碰到很多的坑，这个就只能是熟能生巧了。

【Spring Boot 系列博客】