java打包有时报错Consider defining a bean named ‘entityManagerFactory‘ in your configuration.的解决方法

一、问题描述

最近碰到一个奇葩问题，java后台项目的代码，本地启动是没有问题的；

使用maven打包成war/jar，也没有问题；

但是，启动war/jar包，有时候没有问题，有时候就会报错：

Description:

Parameter 0 of constructor in com.sinosoft.service.SysSessionService required a bean named 'entityManagerFactory' that could not be found.


Action:

Consider defining a bean named 'entityManagerFactory' in your configuration.

其中，SysSessionService.java是自己写的一个类，其中注入了自己写的SysSessionRepository.java类；

SysSessionRepository.java类就是一个写有@Repository的接口类，里面有数据库查询方法，框架负责具体实现，自己查询数据库时只调用接口里的方法即可。

奇葩的点是，打成war/jar包后启动，有时候没有问题，有时候就会报这个错；这时只能重新打包，看哪次打的包能成功启动……

总是重打包也不行，因此研究了下要怎么解决这个问题。

二、排查流程

1.使用BCompare对比工具，比较了下可以启动的jar包和无法启动的jar包；

普通比较规则里没有什么区别；

二进制比较规则里有区别，但是也看不懂哪里不一样。

2.排查代码，发现这个项目需要连接3个数据库，因此自己创建了3个java文件，其中有3个LocalContainerEntityManagerFactoryBean对象（这个就是entityManagerFactory），样例如下：

    //第一个对象，加了Primary注解
    @Primary
    @Bean(name = "entityManagerFactoryPrimary")
    public LocalContainerEntityManagerFactoryBean entityManagerFactoryPrimary(EntityManagerFactoryBuilder builder) {

-------------------------

    //第二个对象
    @Bean(name = "entityManagerFactorySecondary")
    public LocalContainerEntityManagerFactoryBean entityManagerFactorySecondary(EntityManagerFactoryBuilder builder) {

-------------------------

    //第3个对象
    @Bean(name = "entityManagerFactoryDB2")
    public LocalContainerEntityManagerFactoryBean entityManagerFactoryDB2(EntityManagerFactoryBuilder builder) {
 

看起来有Primary注解，没什么问题。

3.这3个java文件里，还用到了3个@EnableJpaRepositories注解，样例如下：

    //第一个 
@EnableJpaRepositories(
        entityManagerFactoryRef = "entityManagerFactoryPrimary",  //设置用到的factory
        transactionManagerRef = "transactionManagerPrimary",
        basePackages = {"com.sinosoft.repository"}) //设置Repository所在位置

-------------------------

    //第二个 
@EnableJpaRepositories(
        entityManagerFactoryRef = "entityManagerFactorySecondary",  //设置用到的factory
        transactionManagerRef = "transactionManagerSecondary",
        basePackages = {"com.sinosoft.repositorysharding"}) //设置Repository所在位置

-------------------------

    //第3个 
@EnableJpaRepositories(
        entityManagerFactoryRef = "entityManagerFactoryDB2",  //设置用到的factory
        transactionManagerRef = "transactionManagerDB2",
        basePackages = {"com.sinosoft.repositoryDB2"}) //设置Repository所在位置

看起来也没有什么问题。

4.搜索@EnableJpaRepositories，这时发现了问题，项目里居然还有第4个写着这个的java文件，内容如下：

@Configuration
@EnableJpaRepositories("com.sinosoft.repository")
@EnableJpaAuditing(auditorAwareRef = "springSecurityAuditorAware")
@EnableTransactionManagement
public class DatabaseConfiguration {

    private final Logger log = LoggerFactory.getLogger(DatabaseConfiguration.class);
}

这个文件里的@EnableJpaRepositories注解里，没有配置entityManagerFactoryRef ；

当只需要连接1个数据库时，那整个项目可以只配置1个@EnableJpaRepositories并且不用配置entityManagerFactoryRef ，框架会用默认的；

但是项目中需要连接多个数据库、配置了多个@EnableJpaRepositories时，还不写entityManagerFactoryRef 的话，就会有问题了。

5.看来是打包项目时，如果先编译其它3个配置文件，由于配置了entityManagerFactoryRef ，所以没有问题，后编译这1个配置文件，由于配置了@Primary注解，也可以正常编译与启动；

但是如果先编译这1个配置文件的话，由于没有配置entityManagerFactoryRef ，就会报错Consider defining a bean named 'entityManagerFactory' in your configuration.了。

三、解决方法

找了半天，感觉打包后项目有时能启动、有时启动报错找不到entityManagerFactory，就是这个DatabaseConfiguration.java类导致的，因为它配置了@EnableJpaRepositories，但是没有配置entityManagerFactoryRef 。

分析了下，这个类也没有什么用，是之前项目只用1个数据库的时候写的；后来项目需要用多个数据库了、这个类也没有被删除或修改、就这样留下来了。

因此，把这个类全部注释掉，后续打包就不会出现有时报错找不到entityManagerFactory的问题了。

//@Configuration
//@EnableJpaRepositories("com.sinosoft.repository")
//@EnableJpaAuditing(auditorAwareRef = "springSecurityAuditorAware")
//@EnableTransactionManagement
//public class DatabaseConfiguration {

//    private final Logger log = LoggerFactory.getLogger(DatabaseConfiguration.class);
//}

四、报错原因分析总结

1.项目用默认配置时，单数据库的情况下，一般没有问题；
但是多数据库的情况下，有可能报错：Consider defining a bean named 'entityManagerFactory' in your configuration.

2.此时，需要搜索@EnableJpaRepositories注解，看看是否都配置了entityManagerFactoryRef ，如果有未配置的、需要补上或者删掉整个注解。

3.关于maven打包编译顺序的问题，暂时不清楚怎么配置；
虽然加了@Primary注解，并且maven打包是没有问题的；
只是打包后的war/jar启动时，有时候能成功、有时候会报错找不到entityManagerFactory；
如果可以正确配置maven编译顺序的话，应该也可以；如果不行、就还是按照第2步、检查下自己的项目。