为什么所有sessionFactory实例初始化报错？-HCRM博客

一、问题描述

在使用 Spring 整合 Hibernate 时，出现sessionFactory or hibernateTemplate is required 报错。

二、原因分析

1、XML 配置验证问题

（图片来源网络，侵权删除）

未绑定数据源：在传统的 XML 配置文件中，如applicationContext.xml，如果LocalSessionFactoryBean 没有正确绑定数据源，会导致sessionFactory 无法正确初始化，以下配置缺少与数据源的绑定。

<bean id="sessionFactory" class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">
         <property name="hibernateProperties">
             <props>
                 <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
                 <prop key="hibernate.show_sql">true</prop>
             </props>
         </property>
     </bean>




映射资源错误：mappingResources 属性未正确指向映射文件，或者映射文件本身存在问题，也会导致sessionFactory 初始化失败。

方言配置错误：hibernate.dialect 属性的值与实际使用的数据库版本不匹配，可能会引发一些潜在的问题，虽然不一定直接导致该报错，但会影响程序的正常运行。

2、注解驱动配置问题

实体类扫描路径错误：在 Spring Boot 项目中，如果使用注解驱动配置，@EntityScan 注解指定的实体类扫描路径错误，将无法正确扫描到实体类，从而导致sessionFactory 无法正常工作。

未添加事务管理注解：如果没有在配置类上添加@EnableTransactionManagement 注解，Spring 将不会启用声明式事务管理，这可能会导致与sessionFactory 相关的事务操作出现问题。

（图片来源网络，侵权删除）

依赖冲突：不同版本的 Spring Framework、Hibernate Core、MySQL Driver 等组件之间可能存在兼容性问题，导致sessionFactory 创建失败或出现其他异常。

3、代码逻辑错误

获取sessionFactory 的方式错误：在 DAO 层或其他需要使用sessionFactory 的地方，如果获取sessionFactory 的方式不正确，例如没有通过 Spring 容器正确注入，而是直接实例化或使用了错误的对象引用，将会导致sessionFactory 为 null，从而引发后续的操作失败。

三、解决方案

1、XML 配置验证（传统项目适用）

正确绑定数据源：确保LocalSessionFactoryBean 与数据源正确绑定，可以通过以下方式进行配置。

<bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource">
         <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
         <property name="url" value="jdbc:mysql://localhost:3306/test"/>
         <property name="username" value="root"/>
         <property name="password" value="123456"/>
     </bean>
     <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean">
         <property name="dataSource" ref="dataSource"/>
         <property name="hibernateProperties">
             <props>
                 <prop key="hibernate.dialect">org.hibernate.dialect.MySQL5Dialect</prop>
                 <prop key="hibernate.show_sql">true</prop>
             </props>
         </property>
         <property name="mappingResources">
             <list>
                 <value>com/example/User.hbm.xml</value>
             </list>
         </property>
     </bean>
     <bean id="hibernateTemplate" class="org.springframework.orm.hibernate5.HibernateTemplate">
         <property name="sessionFactory" ref="sessionFactory"/>
     </bean>




正确指向映射文件：检查mappingResources 属性所指向的映射文件是否存在且路径正确，确保这些映射文件能够被正确加载。

（图片来源网络，侵权删除）

选择合适的方言配置：根据实际使用的数据库版本，选择正确的hibernate.dialect 值，对于 MySQL 8.0，可以使用org.hibernate.dialect.MySQL8Dialect。

2、注解驱动配置（Spring Boot 项目）

正确指定实体类扫描路径：使用@EntityScan 注解指定正确的实体类扫描路径，确保 Spring Boot 能够正确扫描到所有的实体类。

@Configuration
     @EnableTransactionManagement
     @EntityScan("com.example.model")
     public class HibernateConfig {
     }




添加事务管理注解：在配置类上添加@EnableTransactionManagement 注解，启用声明式事务管理。

解决依赖冲突：检查项目的依赖版本，确保各组件之间的版本兼容，可以参考官方文档或社区的建议，选择稳定且相互兼容的版本组合。

3、代码逻辑错误

正确获取sessionFactory：在需要使用sessionFactory 的地方，确保通过 Spring 容器的正确方式获取，可以在 DAO 类中通过构造函数注入或使用@Autowired 注解等方式获取sessionFactory。

@Repository
     public class UserDaoImpl implements UserDao {
         @Autowired
         private SessionFactory sessionFactory;
         // 其他方法实现...
     }




检查其他相关配置：除了上述常见的原因外，还需要检查其他可能影响sessionFactory 的配置，如数据库连接池的配置、缓存的配置等，确保整个系统的配置正确无误。

四、FAQs

1、Q1：为什么会出现sessionFactory or hibernateTemplate is required 报错？

A1：这个报错通常是由于 Spring 容器未正确初始化sessionFactory 或hibernateTemplate，导致 DAO 层注入失败而引发的，常见的原因包括配置文件中未正确绑定数据源、实体类扫描路径错误、未添加事务管理注解、依赖冲突以及代码逻辑中获取sessionFactory 的方式错误等。

2、Q2：如何确定是哪个配置项导致了sessionFactory 报错？

A2：可以根据报错信息和日志进行排查，首先检查配置文件中的sessionFactory 配置是否正确，包括数据源绑定、映射资源指向、方言配置等，然后查看控制台日志，查找与sessionFactory 相关的错误信息，进一步确定具体的问题所在，如果是依赖冲突导致的报错，可以通过检查依赖版本对照表来找出冲突的组件。