Spring Data JPA方法定义规范

Posted 2020-10-16 jae

Spring Data Jpa方法定义的规则： 

（1）简单条件查询

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

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

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

classPeople{
       private String firstName;
       private String lastName;
}

      以上使用and条件查询时，应这样写：findByLastNameAndFirstName(StringlastName,String firstName); 

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

（2）支持的关键字

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

 

（3）查询方法解析流程

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

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

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

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

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

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

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

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