JPA采坑记录

背景遇到的问题1. Field xxxRepository in XXX required a bean of type 'XXXRepository' that could not be found.2. org.hibernate.hql.internal.ast.QuerySyntaxException: xxx is not mapped

背景

最近在负责一个老产品的维护升级工作，此产品是个高龄产品，据说已经超过了十岁，产品代码结构中有公司自研的内容（已经无人维护），有spring 2.X的版本，有spring 4.X的版本，有ibatis也有jpa。

为了降低以后维护升级工作的难度，决定对产品代码做一次重构，去掉无法维护的自研框架，升级spring，统一持久化层使用jpa。在此过程中则遇到了一些问题在此留痕，希望能帮助到大家。

遇到的问题

1. Field xxxRepository in XXX required a bean of type ‘XXXRepository’ that could not be found.

异常信息：

Description:Field xxxRepository in XXX required a bean of type 'XXXRepository' that could not be found.Action:Consider defining a bean of type 'XXXRepository' in your configuration.

遇到上边的异常信息去网上找一般都会被带到package是否被扫描，@EntityScan @Entity @Repository等注解是否添加上去，但是加上@EntityScan等一些网上的解决方式又引起了一系列其他问题。

后经过分析发现，由于产品采用的是不同模块的代码实现是通过不同的maven module来隔离的，产品经过了很长时间维护期，一些人为了方便在维护过程中并没有严格按照产品功能模块去写代码，原本应该在A模块的Repository在B模块的代码中已经存在了，从而造成了Repository加载异常问题。

解决办法：

方法一：新的Repository与已存在的不要重名，修改新的Repository名称；（不推荐此方式，一旦这么做了在其他模块也很可能会引入相同表的Repository，别人也会这么干，一旦表结构发生变化需要在所有的代码模块中修改，产生一连串的连锁反应）方法二：将已存在的Repository移入它应该存在的代码模块，需要使用的地方去合理合法的依赖此代码模块，保证代码模块划分的规则被实际执行。

2. org.hibernate.hql.internal.ast.QuerySyntaxException: xxx is not mapped

异常信息：

org.hibernate.hql.internal.ast.QuerySyntaxException: xxx is not mapped

这个问题比较简单，那就是在需要使用实体类名的地方用的不是@Entity标记的实体类。

产生这个问题的原因通常有两种：

在应该使用实体类名的地方用了表名，如：

@Query("SELECT e.userName from USER_TABLE e")List<String> findAllUserName();

在使用实体类名时用了类的全名，在此情况下容易在代码重构过程中产生问题，如：

//实际类名为：com.ihai.auth.User,与注解中使用的不同产生了异常@Query("SELECT e.userName from com.ihai.User e")List<String> findAllUserName();

解决办法：

第一种情况引起的错误没什么说的，表名改成类名即可。第二种情况引起的错误则是大家编码习惯问题，为了避免此类问题，建议尽量不要使用完整类名，直接用User即可