JpaRepository查询方法名规范

「爱情、让人受尽委屈。」 2022-06-03 08:25 193阅读 0赞

JpaRepository的查询

直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下：JpaRepository会对方法名进行校验 不符合规范会报错 除非添加@Query注解

[![005J0IXCzy73Q4xlLwx05][]][005J0IXCzy73Q4xlLwx05 1]

[![005J0IXCzy73Q4yX1Lsca][]][005J0IXCzy73Q4yX1Lsca 1]

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

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

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

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

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

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

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

Page findByName(String name, Pageable pageable);

List findByName(String name, Sort sort);

也可以使用JPA的NamedQueries，方法如下：

1：在实体类上使用@NamedQuery，示例如下：

@NamedQuery(name = "UserModel.findByAge",query = "select o from UserModel o where o.age >= ?1")

2：在自己实现的DAO的Repository接口里面定义一个同名的方法，示例如下：

public List findByAge(int age);

3：然后就可以使用了，Spring会先找是否有同名的NamedQuery，如果有，那么就不会按照接口定义的方法来解析

[005J0IXCzy73Q4xlLwx05]: /images/20220603/16b5fbf25b72457b8bdcb6a7c69a55ef.png
[005J0IXCzy73Q4xlLwx05 1]: http://photo.blog.sina.com.cn/showpic.html#blogid=&url=http://album.sina.com.cn/pic/005J0IXCzy73Q4xlLwx05
[005J0IXCzy73Q4yX1Lsca]: /images/20220603/afc2f9fc72e14ad0acc9a91d11d388ba.png
[005J0IXCzy73Q4yX1Lsca 1]: http://photo.blog.sina.com.cn/showpic.html#blogid=&url=http://album.sina.com.cn/pic/005J0IXCzy73Q4yX1Lsca