分享

SpringSide 泛型 DAO 接口封装

 CevenCheng 2012-04-29
其中的第135行方法: 
Java代码 
/**  
*  获取全部对象.  
*/  
public List<T> getAll() {   
    return find();   
}  

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


因为我想参考白衣写一个自己的DAO基类,可是我实在是不知道这个 find() 方法是从哪里来的,希望路过的大侠们告知! 
---------------------------------------------------------------------------- 
DAO代码如下: 
Java代码 
/**  
* Copyright (c) 2005-2009 springside.org.cn  
*  
* Licensed under the Apache License, Version 2.0 (the "License");  
*   
* $Id: SimpleHibernateDao.java 493 2009-09-19 04:49:28Z calvinxiu $  
*/  
package org.springside.modules.orm.hibernate;   
  
import java.io.Serializable;   
import java.util.ArrayList;   
import java.util.LinkedHashSet;   
import java.util.List;   
import java.util.Map;   
import java.util.Set;   
  
import org.hibernate.Criteria;   
import org.hibernate.Hibernate;   
import org.hibernate.Query;   
import org.hibernate.Session;   
import org.hibernate.SessionFactory;   
import org.hibernate.criterion.CriteriaSpecification;   
import org.hibernate.criterion.Criterion;   
import org.hibernate.criterion.Restrictions;   

import org.hibernate.metadata.ClassMetadata;   
import org.slf4j.Logger;   
import org.slf4j.LoggerFactory;   
import org.springframework.beans.factory.annotation.Autowired;   
import org.springframework.util.Assert;   
import org.springside.modules.utils.ReflectionUtils;   
  
/**  
* 封装Hibernate原生API的DAO泛型基类.  
*   
* 可在Service层直接使用,也可以扩展泛型DAO子类使用.  
* 参考Spring2.5自带的Petlinc例子,取消了HibernateTemplate,直接使用Hibernate原生API.  
*   
* @param <T> DAO操作的对象类型  
* @param <PK> 主键类型  
*   
* @author calvin  
*/  
@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的时候Override本函数.  
     */  
    @Autowired  
    public void setSessionFactory(final SessionFactory sessionFactory) {   
        this.sessionFactory = sessionFactory;   
    }   
  
    /**  
     * 取得当前Session.  
     */  
    public Session getSession() {   
        return sessionFactory.getCurrentSession();   
    }   
  
    /**  
     * 保存新增或修改的对象.  
     */  
    public void save(final T entity) {   
        Assert.notNull(entity, "entity不能为空");   
        getSession().saveOrUpdate(entity);   
        logger.debug("save entity: {}", entity);   
    }   
  
    /**  
     * 删除对象.  
     *   
     * @param entity 对象必须是session中的对象或含id属性的transient对象.  
     */  
    public void delete(final T entity) {   
        Assert.notNull(entity, "entity不能为空");   
        getSession().delete(entity);   
        logger.debug("delete entity: {}", entity);   
    }   
  
    /**  
     * 按id删除对象.  
     */  
    public void delete(final PK id) {   
        Assert.notNull(id, "id不能为空");   
        delete(get(id));   
        logger.debug("delete entity {},id is {}", entityClass.getSimpleName(), id);   
    }   
  
    /**  
     * 按id获取对象.  
     */  
    public T get(final PK id) {   
        Assert.notNull(id, "id不能为空");   
        return (T) getSession().load(entityClass, id);   
    }   
  
    /**  
     *  获取全部对象.  
     */  
    public List<T> getAll() {   
        return find();   
    }   
  
    /**  
     * 按属性查找对象列表,匹配方式为相等.  
     */  
    public List<T> findBy(final String propertyName, final Object value) {   
        Assert.hasText(propertyName, "propertyName不能为空");   
        Criterion criterion = Restrictions.eq(propertyName, value);   
        return find(criterion);   
    }   
  
    /**  
     * 按属性查找唯一对象,匹配方式为相等.  
     */  
    public T findUniqueBy(final String propertyName, final Object value) {   
        Assert.hasText(propertyName, "propertyName不能为空");   
        Criterion criterion = Restrictions.eq(propertyName, value);   
        return (T) createCriteria(criterion).uniqueResult();   
    }   
  
    /**  
     * 按id列表获取对象.  
     */  
    public List<T> findByIds(List<PK> ids) {   
        return find(Restrictions.in(getIdName(), ids));   
    }   
  
    /**  
     * 按HQL查询对象列表.  
     *   
     * @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, Object> 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, Object> values) {   
        return (X) createQuery(hql, values).uniqueResult();   
    }   
  
    /**  
     * 执行HQL进行批量修改/删除操作.  
     */  
    public int batchExecute(final String hql, final Object... values) {   
        return createQuery(hql, values).executeUpdate();   
    }   
  
    /**  
     * 执行HQL进行批量修改/删除操作.  
     * @return 更新记录数.  
     */  
    public int batchExecute(final String hql, final Map<String, Object> values) {   
        return createQuery(hql, values).executeUpdate();   
    }   
  
    /**  
     * 根据查询HQL与参数列表创建Query对象.  
     *   
     * 本类封装的find()函数全部默认返回对象类型为T,当不为T时使用本函数.  
     *   
     * @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);   
            }   
        }   
        return query;   
    }   
  
    /**  
     * 根据查询HQL与参数列表创建Query对象.  
     *   
     * @param values 命名参数,按名称绑定.  
     */  
    public Query createQuery(final String queryString, final Map<String, Object> values) {   
        Assert.hasText(queryString, "queryString不能为空");   
        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()函数全部默认返回对象类型为T,当不为T时使用本函数.  
     *   
     * @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的直接属性,但不会初始化延迟加载的关联集合和属性.  
     * 如需初始化关联属性,可实现新的函数,执行:  
     * Hibernate.initialize(user.getRoles()),初始化User的直接属性和关联集合.  
     * Hibernate.initialize(user.getDescription()),初始化User的直接属性和延迟加载的Description属性.  
     */  
    public void initEntity(T entity) {   
        Hibernate.initialize(entity);   
    }   
  
    /**  
     * @see #initEntity(Object)  
     */  
    public void initEntity(List<T> entityList) {   
        for (T entity : entityList) {   
            Hibernate.initialize(entity);   
        }   
    }   
  
    /**  
     * 为Query添加distinct transformer.  
     */  
    public Query distinct(Query query) {   
        query.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);   
        return query;   
    }   
  
    /**  
     * 为Criteria添加distinct transformer.  
     */  
    public Criteria distinct(Criteria criteria) {   
        criteria.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);   
        return criteria;   
    }   
  
    /**  
     * 通过Set将不唯一的对象列表唯一化.  
     * 主要用于HQL/Criteria预加载关联集合形成重复记录,又不方便使用distinct查询语句时.  
     */  
    public <X> List<X> distinct(List list) {   
        Set<X> set = new LinkedHashSet<X>(list);   
        return new ArrayList<X>(set);   
    }   
  
    /**  
     * 取得对象的主键名.  
     */  
    public String getIdName() {   
        ClassMetadata meta = getSessionFactory().getClassMetadata(entityClass);   
        return meta.getIdentifierPropertyName();   
    }   
}  

/**
* Copyright (c) 2005-2009 springside.org.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");

* $Id: SimpleHibernateDao.java 493 2009-09-19 04:49:28Z calvinxiu $
*/
package org.springside.modules.orm.hibernate;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.hibernate.Criteria;
import org.hibernate.Hibernate;
import org.hibernate.Query;
import org.hibernate.Session;
import org.hibernate.SessionFactory;
import org.hibernate.criterion.CriteriaSpecification;
import org.hibernate.criterion.Criterion;
import org.hibernate.criterion.Restrictions;
import org.hibernate.metadata.ClassMetadata;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.Assert;
import org.springside.modules.utils.ReflectionUtils;

/**
* 封装Hibernate原生API的DAO泛型基类.

* 可在Service层直接使用,也可以扩展泛型DAO子类使用.
* 参考Spring2.5自带的Petlinc例子,取消了HibernateTemplate,直接使用Hibernate原生API.

* @param <T> DAO操作的对象类型
* @param <PK> 主键类型

* @author calvin
*/
@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的时候Override本函数.
         */
        @Autowired
        public void setSessionFactory(final SessionFactory sessionFactory) {
                this.sessionFactory = sessionFactory;
        }

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

        /**
         * 保存新增或修改的对象.
         */
        public void save(final T entity) {
                Assert.notNull(entity, "entity不能为空");
                getSession().saveOrUpdate(entity);
                logger.debug("save entity: {}", entity);
        }

        /**
         * 删除对象.
         * 
         * @param entity 对象必须是session中的对象或含id属性的transient对象.
         */
        public void delete(final T entity) {
                Assert.notNull(entity, "entity不能为空");
                getSession().delete(entity);
                logger.debug("delete entity: {}", entity);
        }

        /**
         * 按id删除对象.
         */
        public void delete(final PK id) {
                Assert.notNull(id, "id不能为空");
                delete(get(id));
                logger.debug("delete entity {},id is {}", entityClass.getSimpleName(), id);
        }

        /**
         * 按id获取对象.
         */
        public T get(final PK id) {
                Assert.notNull(id, "id不能为空");
                return (T) getSession().load(entityClass, id);
        }

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

        /**
         * 按属性查找对象列表,匹配方式为相等.
         */
        public List<T> findBy(final String propertyName, final Object value) {
                Assert.hasText(propertyName, "propertyName不能为空");
                Criterion criterion = Restrictions.eq(propertyName, value);
                return find(criterion);
        }

        /**
         * 按属性查找唯一对象,匹配方式为相等.
         */
        public T findUniqueBy(final String propertyName, final Object value) {
                Assert.hasText(propertyName, "propertyName不能为空");
                Criterion criterion = Restrictions.eq(propertyName, value);
                return (T) createCriteria(criterion).uniqueResult();
        }

        /**
         * 按id列表获取对象.
         */
        public List<T> findByIds(List<PK> ids) {
                return find(Restrictions.in(getIdName(), ids));
        }

        /**
         * 按HQL查询对象列表.
         * 
         * @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, Object> 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, Object> values) {
                return (X) createQuery(hql, values).uniqueResult();
        }

        /**
         * 执行HQL进行批量修改/删除操作.
         */
        public int batchExecute(final String hql, final Object... values) {
                return createQuery(hql, values).executeUpdate();
        }

        /**
         * 执行HQL进行批量修改/删除操作.
         * @return 更新记录数.
         */
        public int batchExecute(final String hql, final Map<String, Object> values) {
                return createQuery(hql, values).executeUpdate();
        }

        /**
         * 根据查询HQL与参数列表创建Query对象.
         * 
         * 本类封装的find()函数全部默认返回对象类型为T,当不为T时使用本函数.
         * 
         * @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);
                        }
                }
                return query;
        }

        /**
         * 根据查询HQL与参数列表创建Query对象.
         * 
         * @param values 命名参数,按名称绑定.
         */
        public Query createQuery(final String queryString, final Map<String, Object> values) {
                Assert.hasText(queryString, "queryString不能为空");
                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()函数全部默认返回对象类型为T,当不为T时使用本函数.
         * 
         * @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的直接属性,但不会初始化延迟加载的关联集合和属性.
         * 如需初始化关联属性,可实现新的函数,执行:
         * Hibernate.initialize(user.getRoles()),初始化User的直接属性和关联集合.
         * Hibernate.initialize(user.getDescription()),初始化User的直接属性和延迟加载的Description属性.
         */
        public void initEntity(T entity) {
                Hibernate.initialize(entity);
        }

        /**
         * @see #initEntity(Object)
         */
        public void initEntity(List<T> entityList) {
                for (T entity : entityList) {
                        Hibernate.initialize(entity);
                }
        }

        /**
         * 为Query添加distinct transformer.
         */
        public Query distinct(Query query) {
                query.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);
                return query;
        }

        /**
         * 为Criteria添加distinct transformer.
         */
        public Criteria distinct(Criteria criteria) {
                criteria.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY);
                return criteria;
        }

        /**
         * 通过Set将不唯一的对象列表唯一化.
         * 主要用于HQL/Criteria预加载关联集合形成重复记录,又不方便使用distinct查询语句时.
         */
        public <X> List<X> distinct(List list) {
                Set<X> set = new LinkedHashSet<X>(list);
                return new ArrayList<X>(set);
        }

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

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多