hibernate泛型Dao,讓持久層簡潔起來

【前言】hibernate作爲持久層ORM技術,它對JDBC進行非常輕量級對象封裝,使得我們可以隨心所欲的使用面向對象的思想來操作數據庫。同時,作爲後臺開發的支撐,的確扮演了一個舉足輕重的角色,那麼我們在項目中如何靈活應用hibernate,也會給項目維護以及項目開發帶來便利,下面我將展示我們項目中是如何來對hibernate進行應用和操作。
【目錄】 
            -----1.自定義異常
            -----2.泛型Dao搭建(SimpleHibernateDao)
            -----3.hibernate與spring整合

【內容】

              一、自定義異常(BussienssException),相信大家對java異常處理機制還是比較熟悉,我們在業務層定義異常,那麼可以對Jdbc中出現的如SqlException,DataAccessException進行統一處理,這樣做的好處是,便於我們向前臺發送異常消息,記錄異常信息日誌,控制事務回滾,下面就講BussienssException羅列出來,其實很簡單:

/**
 * @author fisher
 * @description 自定義業務異常
 */

public class ServiceException extends RuntimeException {

        /**
         * 
         */
        private static final long serialVersionUID = 1L;

        public ServiceException() {
   super();
        }

        public ServiceException(String message) {
                super(message);
        }

        public ServiceException(Throwable cause) {
    super(cause);
        }

        public ServiceException(String message, Throwable cause) {
   super(message, cause);
        }
}
二:hibernate泛型Dao(SimpleHibernateDao),封裝了原生hibernateAPI操作,實現了對不同Pojo對象進行操作,解決了常用的Crud,代碼註釋寫得很詳細,我就不囉嗦了,具體看代碼:

/**
 * 封裝Hibernate原生API的DAO泛型基類.
 * 
 * 可在Service層直接使用, 也可以擴展泛型DAO子類使用, 見兩個構造函數的註釋. 參考Spring2.5自帶的Petlinc例子,
 * 取消了HibernateTemplate, 直接使用Hibernate原生API.
 * 
 * @param <T>
 *            DAO操作的對象類型
 * @param <PK>
 *            主鍵類型
 * 
 * @author
 */
@SuppressWarnings("unchecked")
public class SimpleHibernateDao<T, PK extends Serializable> {

    protected Logger logger = LoggerFactory.getLogger(getClass());

    protected SessionFactory sessionFactory;

     protected Class<T> entityClass;

        /**
         * 用於Dao層子類使用的構造函數. 通過子類的泛型定義取得對象類型Class. eg. public class UserDao extends
         * SimpleHibernateDao<User, Long>
         */
        public SimpleHibernateDao() {
      this.entityClass = ReflectionUtils.getSuperClassGenricType(getClass());
        }

        /**
         * 用於用於省略Dao層, 在Service層直接使用通用SimpleHibernateDao的構造函數. 在構造函數中定義對象類型Class.
         * eg. SimpleHibernateDao<User, Long> userDao = new SimpleHibernateDao<User,
         * Long>(sessionFactory, User.class);
         */
        public SimpleHibernateDao(final SessionFactory sessionFactory,
     final Class<T> entityClass) {
      this.sessionFactory = sessionFactory;
       this.entityClass = entityClass;
        }

        /**
         * 取得sessionFactory.
         */
        public SessionFactory getSessionFactory() {
      return sessionFactory;
        }

        /**
         * 採用@Autowired按類型注入SessionFactory, 當有多個SesionFactory的時候在子類重載本函數.
         */
        @Autowired
        public void setSessionFactory(final SessionFactory sessionFactory) {
   this.sessionFactory = sessionFactory;
        }

        /**
         * 取得當前Session.
         */
        public Session getSession() {
   return sessionFactory.getCurrentSession();
        }

        /**
         * 保存新增或修改的對象.
         */
        public void save(final T entity) {;
   getSession().saveOrUpdate(entity);
   logger.debug("save entity: {}", entity);
        }

        /**
         * 刪除對象.
         * 
         * @param entity
         *            對象必須是session中的對象或含id屬性的transient對象.
         */
        public void delete(final T entity) {
     getSession().delete(entity);
      logger.debug("delete entity: {}", entity);
        }

        /**
         * 按id刪除對象.
         */
        public void delete(final PK id) {
     delete(get(id));
     logger.debug("delete entity {},id is {}", entityClass.getSimpleName(),
                                id);
        }

        /**
         * 按id獲取對象.
         */
        public T get(final PK id) {
    return (T) getSession().load(entityClass, id);
        }

        /**
         * 按id列表獲取對象列表.
         */
        public List<T> get(final Collection<PK> ids) {
    return find(Restrictions.in(getIdName(), ids));
        }

        /**
         * 獲取全部對象.
         */
        public List<T> getAll() {
   return find();
        }

        /**
         * 獲取全部對象, 支持按屬性行序.
         */
        public List<T> getAll(String orderByProperty, boolean isAsc) {
    Criteria c = createCriteria();
    if (isAsc) {
      c.addOrder(Order.asc(orderByProperty));
     } else {
    c.addOrder(Order.desc(orderByProperty));
                }
      return c.list();
        }

        /**
         * 按屬性查找對象列表, 默認匹配方式爲Like.
         */
        public List<T> findByProperty(final String propertyName, final Object value) {
      Assert.hasText(propertyName, "propertyName不能爲空");
      Criterion criterion = Restrictions.like(propertyName, (String) value,
        MatchMode.ANYWHERE);
      return find(criterion);
        }

        /**
         * 按屬性查找唯一對象, 默認匹配方式爲Like.
         */
        public T findUniqueByProperty(final String propertyName, final Object value) {
         Assert.hasText(propertyName, "propertyName不能爲空");
        Criterion criterion = Restrictions.like(propertyName, (String) value,
         MatchMode.ANYWHERE);
       return (T) createCriteria(criterion).uniqueResult();
        }

        /**
         * 按HQL查詢對象列表.
         * 
         * @param <X>
         * 
         * @param values
         *            數量可變的參數,按順序綁定.
         */
        public <X> List<X> find(final String hql, final Object... values) {
      return createQuery(hql, values).list();
        }

        /**
         * 按HQL查詢對象列表.
         * 
         * @param values
         *            命名參數,按名稱綁定.
         */
        public <X> List<X> find(final String hql, final Map<String, ?> values) {
      return createQuery(hql, values).list();
        }

        /**
         * 按HQL查詢唯一對象.
         * 
         * @param values
         *            數量可變的參數,按順序綁定.
         */
        public <X> X findUnique(final String hql, final Object... values) {
      return (X) createQuery(hql, values).uniqueResult();
        }

        /**
         * 按HQL查詢唯一對象.
         * 
         * @param values
         *            命名參數,按名稱綁定.
         */
        public <X> X findUnique(final String hql, final Map<String, ?> values) {
     return (X) createQuery(hql, values).uniqueResult();
        }

        /**
         * 執行HQL進行批量修改/刪除操作.
         * 
         * @param values
         *            數量可變的參數,按順序綁定.
         * @return 更新記錄數.
         */
        public int batchExecute(final String hql, final Object... values) {
     return createQuery(hql, values).executeUpdate();
        }

        /**
         * 執行HQL進行批量修改/刪除操作.
         * 
         * @param values
         *            命名參數,按名稱綁定.
         * @return 更新記錄數.
         */
        public int batchExecute(final String hql, final Map<String, ?> values) {
      return createQuery(hql, values).executeUpdate();
        }

        /**
         * 根據查詢HQL與參數列表創建Query對象. 與find()函數可進行更加靈活的操作.
         * 
         * @param values
         *            數量可變的參數,按順序綁定.
         */
        public Query createQuery(final String queryString, final Object... values) {
        Assert.hasText(queryString, "queryString不能爲空");
      Query query = getSession().createQuery(queryString);
                if (values != null) {
         for (int i = 0; i < values.length; i++) {
         query.setParameter(i, values[i]);
                        }
                }
   return query;
        }

        /**
         * 根據查詢HQL與參數列表創建Query對象. 與find()函數可進行更加靈活的操作.
         * 
         * @param values
         *            命名參數,按名稱綁定.
         */
        public Query createQuery(final String queryString,
                        final Map<String, ?> values) {

                Query query = getSession().createQuery(queryString);
                if (values != null) {
                        query.setProperties(values);
                }
                return query;
        }

        /**
         * 按Criteria查詢對象列表.
         * 
         * @param criterions
         *            數量可變的Criterion.
         */
        public List<T> find(final Criterion... criterions) {
                return createCriteria(criterions).list();
        }

        /**
         * 按Criteria查詢唯一對象.
         * 
         * @param criterions
         *            數量可變的Criterion.
         */
        public T findUnique(final Criterion... criterions) {
                return (T) createCriteria(criterions).uniqueResult();
        }

        /**
         * 根據Criterion條件創建Criteria. 與find()函數可進行更加靈活的操作.
         * 
         * @param criterions
         *            數量可變的Criterion.
         */
        public Criteria createCriteria(final Criterion... criterions) {
                Criteria criteria = getSession().createCriteria(entityClass);
                for (Criterion c : criterions) {
                        criteria.add(c);
                }
                return criteria;
        }

        /**
         * 初始化對象. 使用load()方法得到的僅是對象Proxy, 在傳到View層前需要進行初始化. 如果傳入entity,
         * 則只初始化entity的直接屬性,但不會初始化延遲加載的關聯集合和屬性. 如需初始化關聯屬性,需執行:
         * Hibernate.initialize(user.getRoles()),初始化User的直接屬性和關聯集合.
         * Hibernate.initialize
         * (user.getDescription()),初始化User的直接屬性和延遲加載的Description屬性.
         */
        public void initProxyObject(Object proxy) {
                Hibernate.initialize(proxy);
        }

        /**
         * Flush當前Session.
         */
        public void flush() {
                getSession().flush();
        }

        /**
         * 爲Query添加distinct transformer. 預加載關聯對象的HQL會引起主對象重複, 需要進行distinct處理.
         */
        public Query distinct(Query query) {
                query.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);
                return query;
        }

        /**
         * 爲Criteria添加distinct transformer. 預加載關聯對象的HQL會引起主對象重複, 需要進行distinct處理.
         */
        public Criteria distinct(Criteria criteria) {
                criteria.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);
                return criteria;
        }

        /**
         * 取得對象的主鍵名.
         */
        public String getIdName() {
                ClassMetadata meta = getSessionFactory().getClassMetadata(entityClass);
                return meta.getIdentifierPropertyName();
        }

        /**
         * 判斷對象的屬性值在數據庫內是否唯一.
         * 
         * 在修改對象的情景下,如果屬性新修改的值(value)等於屬性原來的值(orgValue)則不作比較.
         */
        public boolean isPropertyUnique(final String propertyName,
                        final Object newValue, final Object oldValue) {
                if (newValue == null || newValue.equals(oldValue)) {
                        return true;
                }
                Object object = findUniqueByProperty(propertyName, newValue);
                return (object == null);
        }
}

三、spring與hibernate整合,關於spring與hibernate的整合問題,我分兩步來談:
              1.配置spring的數據源Datasource,關係配置數據庫連接,相信很多童鞋對它很熟悉,我們要獲取數據庫連接,首先是從連接池中去找,那麼常用的連接池分3種(DBCP,C3P0,Proxool),這裏以mysql與DBCP爲例:

datasource.properties:

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost/test?useUnicode=true&characterEncoding=utf-8
jdbc.username=root
jdbc.password=

 applicationContext.xml

 <!-- 定義屬性文件路徑 -->
        <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
                <property name="locations">
                        <list>
                                <!-- 標準配置,路徑都以項目classpath爲準-->
                                <value>classpath:/datasource.properties</value>
                        </list>
                </property>
        </bean>

        <!-- 數據源配置, 使用應用中的DBCP數據庫連接池 -->
        <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
                <!-- Connection Info -->
                <property name="driverClassName" value="${jdbc.driver}" />
                <property name="url" value="${jdbc.url}" />
                <property name="username" value="${jdbc.username}" />
                <property name="password" value="${jdbc.password}" />

                <!-- Connection Pooling Info -->
                <property name="maxActive" value="${dbcp.maxActive}" />
                <property name="maxIdle" value="${dbcp.maxIdle}" />
                <property name="defaultAutoCommit" value="false" />
                <property name="timeBetweenEvictionRunsMillis" value="3600000"/>
                <property name="minEvictableIdleTimeMillis" value="3600000"/>
        </bean>

 2.配置Sessionfactory、transactionManager,這樣我們就有了對事務的控制、以及可以獲取到hibernate的會話。

              <property name="sessionFactory" ref="sessionFactory"></property>
        </bean>        

<!--####{事務管理器}#### -->
        <bean id="transactionManager"
                class="org.springframework.orm.hibernate3.HibernateTransactionManager">
                <property name="sessionFactory" ref="sessionFactory" />
        </bean>
                
        <!-- ####{事務傳播特性 }#### -->
        <tx:advice id="txAdvice" transaction-manager="transactionManager">
                <tx:attributes>
                        <tx:method name="save*" propagation="REQUIRED" rollback-for="Exception"/>
                        <tx:method name="update*" propagation="REQUIRED" rollback-for="Exception"/>
                        <tx:method name="delete*" propagation="REQUIRED" rollback-for="Exception"/>
                        <tx:method name="get*" propagation="SUPPORTS" read-only="true" />
                        <tx:method name="*" read-only="false" />
                </tx:attributes>
        </tx:advice>
        <!-- ####{配置切入點和通知}#### -->
        <aop:config>
                <aop:pointcut id="allServiceMethod" expression="execution(* com.mis.service..*.*(..))" />
                <aop:advisor pointcut-ref="allServiceMethod" advice-ref="txAdvice" />
                <aop:aspect id="logBean" ref="systemLogAspectService">
                        <aop:before method="beforeCut" pointcut-ref="allServiceMethod"/>
                        <aop:after method="afterCut" pointcut-ref="allServiceMethod"/>                        
                </aop:aspect>
        </aop:config>
【總結】   關於持久層的技術,hibernat它的優勢非常明顯,能讓java程序員很直觀去通過對象去操作數據庫,但是在處理報表或者非常複雜的數據庫查詢的時候也顯得有點棘手,上面的泛型dao只是針對常用操作進行封裝,對於處理特殊情況我建議還是採用原生Sql方式去處理,這篇文章也就差不多了。相信用過hibernate的人都知道如何去編寫hbm映射文件,添加依賴包,這裏我就沒有詳細介紹,也沒有實際例子來實現,還是那句話,我是從項目架構出發,給大家在搭建系統的時候提供思路和參考。        

原文地址:http://ajava.org/thread-153-1-1.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章