Spring DAO(4)：Spring 集成 Hibernate

Spring 集成 Hibernate

Spring 对于大量的 ORM 框架 进行了集成支持，提供了更加方便的基础设施搭建，统一的异常封装，统一的的事务管理，同时允许混用多个 ORM 框架；

Spring 支持 Hibernate 的最低版本为 Hibernate 3.6，提供了Spring 风格的更加简便的配置方式，同时提供了 HibernateTemplate 模板类，用于降低 Hibernate 的使用难度；

以下示例代码地址：https://gitee.com/assad/springframework-test-dao-hibernate

一个简单的示例

示例代码模块:

site/assad/domain/User(领域对象)

site/assad/dao/UserDao（DAO对象）

site/assad/servcie/UserServcie（Service对象）

site/assad/applicationContext.xml（spring 配置文件）

配置文件  applicationContext.xml （这里使用Spring风格的配置方式，可以不使用Hibernate的配置文件）

 

<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans"

       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"

       xmlns:context="http://www.springframework.org/schema/context" xmlns:tx="http://www.springframework.org/schema/tx"

       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">

​

    <!--扫描bena-->

    <context:component-scan base-package="site.assad.dao" />

    <context:component-scan base-package="site.assad.service" />

​

    <!--配置属性占位符空间-->

    <context:property-placeholder location="classpath:site/assad/jdbc.properties" />

    <!--配置数据源-->

    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"

          p:driverClassName="${jdbc.driverClassName}"

          p:url="${jdbc.url}"

          p:username="${jdbc.username}"

          p:password="${jdbc.password}" />

​

    <!--配置 Hibernate 的 SessionFactory -->

    <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean"

        p:dataSource-ref="dataSource" >

        <!--自动扫描标记注解的 Hibernate 实体类-->

        <property name="packagesToScan" value="site.assad.domain" />

        <!--指定 Hibernate 配置的属性 -->

        <property name="hibernateProperties">

            <props>

                <prop key="hibernate.dialect">org.hibernate.dialect.MySQL5Dialect</prop>

                <prop key="hibernate.show_sql">true</prop>

            </props>

        </property>

    </bean>

​

    <!--配置 HibernateTempalte 模板类-->

    <bean id="hibernateTemplate" class="org.springframework.orm.hibernate5.HibernateTemplate"

          p:sessionFactory-ref="sessionFactory" />

​

    <!--配置事务管理器-->

    <bean id="transactionManager" class="org.springframework.orm.hibernate5.HibernateTransactionManager"

          p:sessionFactory-ref="sessionFactory" />

    <!--自动扫描注解声明式事务管理切面-->

    <tx:annotation-driven proxy-target-class="true" transaction-manager="transactionManager" />

​

</beans>

领域对象 User，使用注解的方式配置 Hibernate 实体类

 

package site.assad.domain;

@Entity

@Table(name="users")

public class User implements Serializable{

    @Id

    @GeneratedValue(strategy=GenerationType.IDENTITY)

    @Column(name="user_id")

    private int id;

    @Column(name="user_name")

    private String name;

​

    @Column(name="user_password")

    private String password;

​

    @Column(name="create_date")

    @Temporal(TemporalType.DATE)

    private Date createDate;

​

    @Column(name="user_icon")

    private String icon;

​

    //省略 getter 、 setter

}

示例的 UserDao 

 

package site.assad.dao;

​

@Repository

public class UserDao {

​

    @Autowired

    private HibernateTemplate hibernateTemplate ;

​

    //演示insert操作

    public void addUser(User user){

        hibernateTemplate.save(user);

    }

​

    //演示update操作

    public void updateUser(User user){

        hibernateTemplate.update(user);

    }

​

    //演示delete操作

    public void deleteUser(User user){

        hibernateTemplate.delete(user);

    }

​

    //演示查询操作

    public long getUserNum(){

        final String hql = "select count(u.id) from User u ";

        return (Long)hibernateTemplate.iterate(hql).next();

         //or: return ((List<Integer>)hibernateTemplate.find(hql)).get(0);

    }

​

    public User findUserByName(final String username){

        final String hql = "select u from User u where u.name = ?";

        List<User> result = (List<User>) hibernateTemplate.find(hql,username);

        return (User)result.get(0);

    }

​

    public List<User> findUserByIcon(final String icon) {

        final String hql = "select u from User u where u.icon = ?";

        return (List<User>) hibernateTemplate.find(hql, icon);

    }

​

}

​

之后在 Service  对象中自动注入该 Dao 对象，并对其进行调用

 

package site.assad.service;

​

@Service

@Transactional

public class UserService {

    @Autowired

    private UserDao userDao;

​

    //检查某个名称的user是否存在

    public boolean checkUser(final String username){

        return userDao.findUserByName(username) != null;

    }

    //删除指定icon的user

    public void deleteUserWithIcon(final String icon){

        List<User> userList = userDao.findUserByIcon(icon);

        for(User user : userList)

            userDao.deleteUser(user);

    }

}

---

配置文件

在使用 Hibernate 的第一步是编写 Hibernate 配置文件，在 Spring 集成 Hibernate 时候，可以直接在 Spring 配置文件中引用 Hibernate 配置文件；

Spring 配置文件 applicationContext.xml 中引用  hibernate.cfg.xml 的方式如下：

 

 <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean"

        p:configLocation ="classpath:hibernate.cfg.xml" />

Spring 还提供了一种更加简便的方式，直接 Spring 配置文件中对 Hibernate 进行配置，以摒弃掉 hiberate.cfg.xml 文件，

这种配置方式的示例代码如下：

1）针对 Hibernate 使用注解配置 POJO：

 

<?xml version="1.0" encoding="UTF-8"?>

<beans ... >

​

    <!--扫描bena-->

    <context:component-scan base-package="site.assad.dao" />

    <context:component-scan base-package="site.assad.service" />

​

    <!--配置属性占位符空间-->

    <context:property-placeholder location="classpath:site/assad/jdbc.properties" />

    <!--配置数据源-->

    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"

          p:driverClassName="${jdbc.driverClassName}"

          p:url="${jdbc.url}"

          p:username="${jdbc.username}"

          p:password="${jdbc.password}" />

​

    <!--配置 Hibernate 的 SessionFactory -->

    <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean"

        p:dataSource-ref="dataSource" >

        <!--自动扫描标记注解的 Hibernate 实体类-->

        <property name="packagesToScan" value="site.assad.domain" />

        <!--指定 Hibernate 配置的属性 -->

        <property name="hibernateProperties">

            <props>

                <prop key="hibernate.dialect">org.hibernate.dialect.MySQL5Dialect</prop>

                <prop key="hibernate.show_sql">true</prop>

            </props>

        </property>

    </bean>

​

    <!--配置 HibernateTempalte 模板类-->

    <bean id="hibernateTemplate" class="org.springframework.orm.hibernate5.HibernateTemplate"

          p:sessionFactory-ref="sessionFactory" />

​

    <!--配置事务管理器-->

    <bean id="transactionManager" class="org.springframework.orm.hibernate5.HibernateTransactionManager"

          p:sessionFactory-ref="sessionFactory" />

    <!--自动扫描注解声明式事务管理切面-->

    <tx:annotation-driven proxy-target-class="true" transaction-manager="transactionManager" />

​

</beans>

2）针对 Hibernate 使用xml文件配置 POJO：   

 

<beans ...>

    <!--配置属性占位符空间-->

    ....

    <!--配置数据源-->

    ....

    <!--配置 Hibernate 的 SessionFactory -->

    <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean"

          p:dataSource-ref="dataSource" >

        <!--指定 Hibernate 实体类的映射文件-->

        <property name="mappingLocations">

            <list>

                <value>classpath*:/site/assad/domain/User.hbm.xml</value>

                <value>classpath*:/site/assad/domain/Game.hbm.xml</value>

            </list>

        </property>

        <!--指定 Hibernate 配置的属性 -->

       .....

    </bean>

   ......

</beans>

---

使用HibernateTemplate 模板类

虽然可以通过创建SessionFactory，调用其成员方法的方式来实现 Hibernate POJO 的操作，但是 Spring 提供了相应的模板类 HibernateTemplate 用于简化 Hibernate SessionFactory 的操作；

使用该模板时候需要先在 Spring 配置文件中进行配置：

 

<!--配置 HibernateTempalte 模板类-->

    <bean id="hibernateTemplate" class="org.springframework.orm.hibernate5.HibernateTemplate"

          p:sessionFactory-ref="sessionFactory" />  <!--配置关联的 SessionFactory bean-->

在Dao中使用该模板类的一个使用示例如下：

 

package site.assad.dao;

@Repository

public class UserDao {

    @Autowired  //自动注入 HibernateTemplate

    private HibernateTemplate hibernateTemplate ;

​

    //演示insert操作

    public void addUser(User user){

        hibernateTemplate.save(user);

    }

    //演示update操作

    public void updateUser(User user){

        hibernateTemplate.update(user);

    }

    //演示delete操作

    public void deleteUser(User user){

        hibernateTemplate.delete(user);

    }

    //演示查询操作

    public long getUserNum(){

        final String hql = "select count(u.id) from User u ";

        return (Long)hibernateTemplate.iterate(hql).next();

    }

​

    public User findUserByName(final String username){

        final String hql = "select u from User u where u.name = ?";

        List<User> result = (List<User>) hibernateTemplate.find(hql,username);

        return (User)result.get(0);

    }

​

    public List<User> findUserByIcon(final String icon) {

        final String hql = "select u from User u where u.icon = ?";

        return (List<User>) hibernateTemplate.find(hql, icon);

    }

}

HibernateTemplate 常用的 API

Serializable save(Object entity)	保存 POJO 实体对象，同 void persist(Object entity) ；
void update(Object entity)	更新实体对象；
void delete(Object entity)	删除实体对象；
void saveOrUpdate(Object entity)	保存或更新实体对象；
List<T> find(String queryString)	根据 HQL 查询实体，结果以 List 形式返回，有多个重载版本： find(String queryString，Object arg) find(String queryString，Object[] args)
Iterator iterate(String queryString)	同上，不过结果以 Iterator 的方式返回，特别适合单值查询时使用；

完整的API参见相关JavaDoc；

此外 HibernateTemplate 还提供了以下回调接口，可以在该接口中编写 Hibernate 风格的调用代码：

List executeFind(HibernateCallback<?> action)

一般用于执行数据查询操作

这些回调接口示例使用如下：

 

//使用 executeFind 重写 UserDao#findUserByName()

    public User findUserByNameV2(final String username){

        User user = hibernateTemplate.execute(new HibernateCallback<User>() {

            @Override

            public User doInHibernate(Session session) throws HibernateException {

                //Hibenate 风格的 POJO 操作代码

                String hql = "select u from User u where u.name = :userName";

                List<User> resultList = session.createQuery(hql)

                        .setParameter("userName",username)

                        .list();

                return resultList.get(0);

            }

        });

        return user;

    }

---

事务处理

Hibernate 本身已经具有一套事务管理体系和相关的支持类，在 Spring 可以使用自的事务管理器支持 Hibernate 的事务管理，使用方式类似于在 Spring JDBC 使用事务管理，事务管理器的配置如下：

 

 <!--配置 Hibernate 的 SessionFactory -->

 <bean id="sessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean"... >..</bean>

​

<!--配置事务管理器-->

<bean id="transactionManager" class="org.springframework.orm.hibernate5.HibernateTransactionManager"

          p:sessionFactory-ref="sessionFactory" />  <!--配置事务管理器的SessionFactory-->

​

<!--自动扫描注解声明式事务管理切面-->

<tx:annotation-driven proxy-target-class="true" transaction-manager="transactionManager" />

​

使用 Hibernate 事件监听器

Hibernate 本身具有一个功能完善的事件体系，Hibernate 在 org.hiebrnate.event 包中定义了事件和对应的事件监听器的接口，并在 org.hibernate.event.def 中提供了事件监听器接口的默认实现；

Spring 本身就提供了一个 Hibernate 事件监听器 IdTransferringMergeEventListener ，以下是见该事件监听器注册到 Hibernate 中的配置方式：

 

<bean id="sessionFactory"  class="org.springframework.orm.hibernate5.LocalSessionFactoryBean"

          p:dataSource-ref="dataSource">

    ...

    <!--配置 hibernate 事件监听器-->

    <property name="eventListener">

        <map>

            <entry key="merge"> <!--配置监听器类别和实现类-->

                <bean class="org.springframwork.orm.hibnerate5.support.IdTransferringMergeEventListener"/>

            </entry>

        </map>

    </property>

</bean>

使用原生的 Hibernate API

Hibernate 3.0 中引入了 SessionFactory#getCurrentSession() 方法用于获取当前线程绑定的 Session，这一特性使得 Hibernate 自身具备获取和事务线程绑定的 Session 对象的功能，这其实和 HibenateTemplate 中使用和事务绑定的 Session 是相同的；

Spring 可以使用通过获取注入的 SessionFactory 来使用原生的 Hibernate API 编写 DAO，它也可以和 Spring 事务管理器一起工作；

 

@Repository

public class UserDao {

    @Autowired  //自动注入 SessionFactory

    private SessionFactory sessionFactory;

     public void addUser(User user){

        sessionFactory.getCurrentSession().save(user);

    }

    //演示update操作

    public void updateUser(User user){

         sessionFactory.getCurrentSession().update(user);

    }

​

}