Spring Boot JPA Repository之existsBy查询方法失效的解决
引言: Spring Boot号称微服务的利器,在结合了Spring Data与JPA之后,更是如虎添翼,开发快速的不像话,本文将讲述一个关于JPA中一个诡异问题的诊断分析过程以及修复方法。
环境介绍
JDK 1.8 Spring 4.2 Spring Boot 1.5.9
问题描述
在Spring Data中的Repository接口中创建了一个检查数据是否存在的接口方法:
@Repository public interface VideoEntityRepository extends JpaRepository<VideoEntity, Long> { ........ public boolean existsByUserIdAndName(long userId, String name); }
VideoEntity的类如下:
@SuppressWarnings("serial") @Table(name="flook_video") @Entity @Data @EqualsAndHashCode(callSuper=true) public class VideoEntity extends BaseEntity { @Column(name="user_id") private long userId; @Column(name="name") private String name; @Column(name="change_version") private double changeVersion; }
在调用方法existsBy方法的时候,返回的结果一直为false, 结果不正确,在偶的期望中,其执行结果应该不会出错的?那问题出在哪里呢?
关于existsBy的介绍
Spring Data提供了若干非常实用的扩展,将数据库表日常的CRUD操作都进行很好的实现,并提供了若干扩展机制,基于一套简单易用的命名规则,来基于声明式实现场景的数据库查询操作:
countByColumName existsByColumnName
上述两种方式都是由Spring Data来帮助动态生成SQL的。
基于@Query方式
除了基于countBy/existsBy两种方式之外,可以直接使用@Query方式来标注特定的SQL或者JPQL来实现功能,由于这种方式需要些SQL,功能上完全覆盖,但是工作量略大,不是最优的方式。
问题分析
由于底层使用了Hibernate/JPA/Spring Data来实现的数据访问层的实现,所以,最好的方式当然是查看动态生成的SQL了,于是找到了生成的SQL语句:
select videoentit0_.id as col_0_0_ from video videoentit0_ where videoentit0_.user_id=? and videoentit0_.name=? limit ?
表的名称是video,这个名称是不对的。这个情况是怎么发生的呢?
问题的解决
经过分析发现,是由于在代码中存在两个类名完全相同VideoEntity的类,虽然在Repository中我们的的确确没有引用错误相关的,问题应该出在当Spring Data碰到两个相同的类名之时,其实不知道如何来生成SQL的,换句话说,其应该是基于类名而非类路径来动态生成执行SQL的。
TODO: 基于源代码中找到相关部分内容。
问题解决
将当前的VideoEntity重新命名,确保不存在重名的问题,即使类的路径不一样,但是类名一样,也是会产生这样的问题。
从一个侧面来分析,在Spring Data中所有的DataBean都是需要使用全路径的类名的,否则同样会出现问题。
JpaRepository 查询规范
1.JpaRepository支持接口规范方法名查询
意思是如果在接口中定义的查询方法符合它的命名规则,就可以不用写实现,目前支持的关键字如下。
Keyword |
Sample |
JPQL snippet |
IsNotNull |
findByAgeNotNull |
... where x.age not null |
Like |
findByNameLike |
... where x.name like ?1 |
NotLike |
findByNameNotLike |
... where x.name not like ?1 |
StartingWith |
findByNameStartingWith |
... where x.name like ?1(parameter bound with appended %) |
EndingWith |
findByNameEndingWith |
... where x.name like ?1(parameter bound with prepended %) |
Containing |
findByNameContaining |
... where x.name like ?1(parameter bound wrapped in %) |
OrderBy |
findByAgeOrderByName |
... where x.age = ?1 order by x.name desc |
Not |
findByNameNot |
... where x.name <> ?1 |
In |
findByAgeIn |
... where x.age in ?1 |
NotIn |
findByAgeNotIn |
... where x.age not in ?1 |
True |
findByActiveTrue |
... where x.avtive = true |
Flase |
findByActiveFalse |
... where x.active = false |
And |
findByNameAndAge |
... where x.name = ?1 and x.age = ?2 |
Or |
findByNameOrAge |
... where x.name = ?1 or x.age = ?2 |
Between |
findBtAgeBetween |
... where x.age between ?1 and ?2 |
LessThan |
findByAgeLessThan |
... where x.age < ?1 |
GreaterThan |
findByAgeGreaterThan |
... where x.age > ?1 |
After/Before |
... |
... |
IsNull |
findByAgeIsNull |
... where x.age is null |
2.JpaRepository相关查询功能
a.Spring DataJPA框架在进行方法名解析时,会先把方法名多余的前缀截取掉,比如find、findBy、read、readBy、get、getBy,然后对剩下部分进行解析。
b.假如创建如下的查询: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()"
c.特殊的参数: 还可以直接在方法的参数上加入分页或排序的参数,比如:
Page<UserModel>findByName(String name, Pageable pageable); List<UserModel>findByName(String name, Sort sort);
d.也可以使用JPA的NamedQueries,方法如下:
1:在实体类上使用@NamedQuery:
@NamedQuery(name ="UserModel.findByAge",query = "select o from UserModel o where o.age >=?1")
2:在自己实现的DAO的Repository接口里面定义一个同名的方法,示例如下:
publicList<UserModel> findByAge(int age);
3:然后就可以使用了,Spring会先找是否有同名的NamedQuery,如果有,那么就不会按照接口定义的方法来解析。
e.还可以使用@Query来指定本地查询,只要设置nativeQuery为true,比如:
@Query(value="select* from tbl_user where name like %?1" ,nativeQuery=true) publicList<UserModel> findByUuidOrAge(String name);
注意:当前版本的本地查询不支持翻页和动态的排序
f.使用命名化参数,使用@Param即可,比如:
@Query(value="selecto from UserModel o where o.name like %:nn") publicList<UserModel> findByUuidOrAge(@Param("nn") String name);
g.同样支持更新类的Query语句,添加@Modifying即可,比如:
@Modifying @Query(value="updateUserModel o set o.name=:newName where o.name like %:nn") public intfindByUuidOrAge(@Param("nn") String name,@Param("newName")String newName);
注意:
1:方法的返回值应该是int,表示更新语句所影响的行数
2:在调用的地方必须加事务,没有事务不能正常执行
f.创建查询的顺序
Spring Data JPA在为接口创建代理对象时,如果发现同时存在多种上述情况可用,它该优先采用哪种策略呢?
<jpa:repositories>提供了query-lookup-strategy 属性,用以指定查找的顺序。
它有如下三个取值:
1:create-if-not-found:如果方法通过@Query指定了查询语句,则使用该语句实现查询;如果没有,则查找是否定义了符合条件的命名查询,如果找到,则使用该命名查询;如果两者都没有找到,则通过解析方法名字来创建查询。这是querylookup-strategy 属性的默认值
2:create:通过解析方法名字来创建查询。即使有符合的命名查询,或者方法通过
@Query指定的查询语句,都将会被忽略
3:use-declared-query:如果方法通过@Query指定了查询语句,则使用该语句实现查询;如果没有,则查找是否定义了符合条件的命名查询,如果找到,则使用该命名查询;如果两者都没有找到,则抛出异常
以上为个人经验,希望能给大家一个参考,也希望大家多多支持猪先飞。
相关文章
解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题
这篇文章主要介绍了解决springboot使用logback日志出现LOG_PATH_IS_UNDEFINED文件夹的问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-04-28- 这篇文章主要为大家详细介绍了SpringBoot实现excel文件生成和下载,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-02-09
- 这篇文章主要介绍了详解springBoot启动时找不到或无法加载主类解决办法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-16
- 这篇文章主要介绍了SpringBoot集成Redis实现消息队列的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-02-10
- 这篇文章主要介绍了解决Springboot get请求是参数过长的情况,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-09-17
Spring Boot项目@RestController使用重定向redirect方式
这篇文章主要介绍了Spring Boot项目@RestController使用重定向redirect方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-02- 这篇文章主要介绍了Springboot+TCP监听服务器搭建过程,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-10-28
- 这篇文章主要介绍了springBoot 项目排除数据库启动方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-10
详解SpringBoot之访问静态资源(webapp...)
这篇文章主要介绍了详解SpringBoot之访问静态资源(webapp...),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-14- 这篇文章主要介绍了SpringBoot接口接收json参数解析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-10-19
springboot中使用@Transactional注解事物不生效的坑
这篇文章主要介绍了springboot中使用@Transactional注解事物不生效的原因,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-01-26Spring Data JPA 关键字Exists的用法说明
这篇文章主要介绍了Spring Data JPA 关键字Exists的用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-06-10- 这篇文章主要介绍了springboot多模块包扫描问题的解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-09-16
JPA如何使用nativequery多表关联查询返回自定义实体类
这篇文章主要介绍了JPA如何使用nativequery多表关联查询返回自定义实体类,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-11-18Springboot mybatis plus druid多数据源解决方案 dynamic-datasource的使用详解
这篇文章主要介绍了Springboot mybatis plus druid多数据源解决方案 dynamic-datasource的使用,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下...2020-11-18- 这篇文章主要介绍了Springboot实现多线程注入bean的工具类操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-27
Springboot+MDC+traceId日志中打印唯一traceId
本文主要介绍了Springboot+MDC+traceId日志中打印唯一traceId,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-10-17SpringBoot部署到Linux读取resources下的文件及遇到的坑
本文主要给大家介绍SpringBoot部署到Linux读取resources下的文件,在平时业务开发过程中,很多朋友在获取到文件内容乱码或者文件读取不到的问题,今天给大家分享小编遇到的坑及处理方案,感兴趣的朋友跟随小编一起看看吧...2021-06-21- 这篇文章主要介绍了springboot中nacos动态路由的配置方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-11
SpringBoot高版本修改为低版本时测试类报错的解决方案
这篇文章主要介绍了SpringBoot高版本修改为低版本时测试类报错的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教...2021-09-18