研究一下springside的核心部分源代码

 这两天,有一些时间,研究一下springside的源代码,结果感觉不错,于是对自己做过一些代码做了一些优化与重构.
分页的代码如下:
(说明:这里的代码是我参考了springside的源代码后作了一些比较小的改动,这里没有给出完整的例子,只是讨论一下核心的代码)
这里想说的代码主要是泛型DAO层的应用与分页的写法.

分页,采用了hibernate的一些API来分页,这里同时采用了两种分页方式,CriteriaPage分页方式,适用于多表单时查询后分页用的,而第二种方式是采用Hql语句查询后分页的.代码如下:

CriteriaPage.java文件:

package org.mmc.commons;

import java.util.ArrayList;
import java.util.List;

import org.hibernate.Criteria;
import org.hibernate.criterion.CriteriaSpecification;
import org.hibernate.criterion.Projection;
import org.hibernate.criterion.Projections;
import org.hibernate.impl.CriteriaImpl;
import org.hibernate.impl.CriteriaImpl.OrderEntry;
import org.mmc.utils.BeanUtils;

/**
 * 使用Hql查询的的分页查询类.
 * 支持执行Count查询取得总记录条数
 * 本类参考了springside项目的分页设计
 */
public class CriteriaPage {

    /**
     * 得到一个PageInstance实例,.
     */
    public static Page getPageInstance(Criteria criteria, int pageNo, int pageSize) {

            return CriteriaPage.getPageInstanceByCount(criteria, pageNo, pageSize);
    }

    /**
     * 以查询Count的形式获取totalCount的函数
     */
    protected static Page getPageInstanceByCount(Criteria criteria, int pageNo, int pageSize) {
        CriteriaImpl impl = (CriteriaImpl) criteria;

        //先把Projection和OrderBy条件取出来,清空两者来执行Count操作
        Projection projection = impl.getProjection();
        List orderEntries;
        try {
            orderEntries = (List) BeanUtils.getPrivateProperty(impl, "orderEntries");
            BeanUtils.setPrivateProperty(impl, "orderEntries", new ArrayList());
        }
        catch (Exception e) {
            throw new InternalError(" Runtime Exception impossibility throw ");
        }

        //执行查询
        int totalCount = (Integer) criteria.setProjection(Projections.rowCount()).uniqueResult();

        //将之前的Projection和OrderBy条件重新设回去
        criteria.setProjection(projection);
        if (projection == null) {
            criteria.setResultTransformer(CriteriaSpecification.ROOT_ENTITY);
        }

        try {
            BeanUtils.setPrivateProperty(impl, "orderEntries", orderEntries);
        } catch (Exception e) {
            throw new InternalError(" Runtime Exception impossibility throw ");
        }

        return getPageResult(criteria, totalCount, pageNo, pageSize);
    }

    /**
     * 取得totalCount后，根据pageNo和PageSize, 执行criteria的分页查询，取得Page变量
     */
    private static Page getPageResult(Criteria criteria, int totalCount, int pageNo, int pageSize) {
        if (totalCount < 1) return new Page();

        int startIndex = Page.getStartOfPage(pageNo, pageSize);
        List list = criteria.setFirstResult(startIndex).setMaxResults(pageSize).list();

        return new Page(startIndex, totalCount, pageSize, list);
    }

}

HqlPage.java文件的代码

Page.java文件的源代码如下:

package org.mmc.commons;

import java.util.ArrayList;

/**
 * 分页对象. 包含数据及分页信息.
 *
 * @author lighter 天马行空
 */
public class Page implements java.io.Serializable {
 /**
  * 当前页第一条数据的位置,从0开始
  */
 private int start;

 /**
  * 每页的记录数
  */
 private int pageSize = Constants.DEFAULT_PAGE_SIZE;

 /**
  * 当前页中存放的记录
  */
 private Object data;

 /**
  * 总记录数
  */
 private int totalCount;

 /**
  * 构造方法，只构造空页
  */
 public Page() {
  this(0, 0, Constants.DEFAULT_PAGE_SIZE, new ArrayList());
 }

 /**
  * 默认构造方法
  *
  * @param start
  *            本页数据在数据库中的起始位置
  * @param totalSize
  *            数据库中总记录条数
  * @param pageSize
  *            本页容量
  * @param data
  *            本页包含的数据
  */
 public Page(int start, int totalSize, int pageSize, Object data) {
  this.pageSize = pageSize;
  this.start = start;
  this.totalCount = totalSize;
  this.data = data;
 }

 /**
  * 取数据库中包含的总记录数
  */
 public int getTotalCount() {
  return this.totalCount;
 }

 /**
  * 取总页数
  */
 public int getTotalPageCount() {
  if (totalCount % pageSize == 0)
   return totalCount / pageSize;
  else
   return totalCount / pageSize + 1;
 }

 /**
  * 取每页数据容量
  */
 public int getPageSize() {
  return pageSize;
 }

 /**
  * 当前页中的记录
  */
 public Object getResult() {
  return data;
 }

 /**
  * 取当前页码,页码从1开始
  */
 public int getCurrentPageNo() {
  return (start / pageSize) + 1;
 }

 /**
  * 是否有下一页
  */
 public boolean hasNextPage() {
  return (this.getCurrentPageNo() < this.getTotalPageCount() - 1);
 }

 /**
  * 是否有上一页
  */
 public boolean hasPreviousPage() {
  return (this.getCurrentPageNo() > 1);
 }

 /**
  * 获取任一页第一条数据的位置，每页条数使用默认值
  * 关键字设为pretected
  */
 protected static int getStartOfPage(int pageNo) {
  return getStartOfPage(pageNo, Constants.DEFAULT_PAGE_SIZE);
 }

 /**
  * 获取任一页第一条数据的位置,startIndex从0开始
  * 关键字设为pretected
  */
 protected static int getStartOfPage(int pageNo, int pageSize) {
  return (pageNo - 1) * pageSize;
 }
}

分页的改造已经完成,现在重构一下DAO层的写法,利用了spring对hibernate支持的一些的API.

DAO层:
AbstractHibernateDao.java的源代码

package org.mmc.dao;

import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.Criteria;
import org.hibernate.criterion.MatchMode;
import org.hibernate.criterion.Order;
import org.hibernate.criterion.Projections;
import org.hibernate.criterion.Restrictions;
import org.springframework.orm.ObjectRetrievalFailureException;
import org.springframework.orm.hibernate3.support.HibernateDaoSupport;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.mmc.utils.GenericsUtils;

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

/**
 * 纯Hibernate Entity DAO基类.
 * 通过泛型，子类无需扩展任何函数即拥有完整的CRUD操作.
 *
 */
abstract public class AbstractHibernateDao extends HibernateDaoSupport {

    protected Log logger = LogFactory.getLog(getClass());

    /**
     * Dao所管理的Entity类型.
     */
    protected Class entityClass;

    /**
     * 取得entityClass的函数.
     * JDK1.4不支持泛型的子类可以抛开Class entityClass,重新实现此函数达到相同效果。
     */
    protected Class getEntityClass() {
        return entityClass;
    }

    /**
     * 在构造函数中将泛型T.class赋给entityClass
     */
    public AbstractHibernateDao() {
        entityClass = GenericsUtils.getGenericClass(getClass());
    }

    public T get(Serializable id) {
        T o = (T) getHibernateTemplate().get(getEntityClass(), id);
        if (o == null)
            throw new ObjectRetrievalFailureException(getEntityClass(), id);
        return o;
    }

    public List getAll() {
        return getHibernateTemplate().loadAll(getEntityClass());
    }

    public void save(Object o) {
        getHibernateTemplate().saveOrUpdate(o);
    }

    public void removeById(Serializable id) {
        remove(get(id));
    }

    public void remove(Object o) {
        getHibernateTemplate().delete(o);
    }

    public List find(String hsql, Object... values) {
        if (values.length == 0)
            return getHibernateTemplate().find(hsql);
        else
            return getHibernateTemplate().find(hsql, values);
    }

    /**
     * 根据属性名和属性值查询对象.
     *
     * @return 符合条件的唯一对象
     */
    public T findUniqueBy(String name, Object value) {
        Criteria criteria = getSession().createCriteria(getEntityClass());
        criteria.add(Restrictions.eq(name, value));
        return (T) criteria.uniqueResult();
    }

    /**
     * 根据属性名和属性值查询对象.
     *
     * @return 符合条件的对象列表
     */
    public List findBy(String name, Object value) {
        Assert.hasText(name);
        Criteria criteria = getSession().createCriteria(getEntityClass());
        criteria.add(Restrictions.eq(name, value));
        return criteria.list();
    }

    /**
     * 根据属性名和属性值以Like AnyWhere方式查询对象.
     */
    public List findByLike(String name, String value) {
        Assert.hasText(name);
        Criteria criteria = getSession().createCriteria(getEntityClass());
        criteria.add(Restrictions.like(name, value, MatchMode.ANYWHERE));
        return criteria.list();
    }

    /**
     * 根据Map中过滤条件进行查询.
     *
     * @param filter        过滤条件.
     * @param criteriaSetup 将Map中条件转换为criteria的call back类
     */
    public List findBy(Map filter, CriteriaSetup criteriaSetup) {
        Criteria criteria = getEntityCriteria();
        if (!CollectionUtils.isEmpty(filter)) {
            criteriaSetup.setup(criteria, filter);
        }
        return criteria.list();
    }

    /**
     * 函数作用同{@link #findBy(Map,CriteriaSetup)}
     * 如果不需要分页,子类可直接重载此函数.
     */
    public List findBy(Map filter) {
        return findBy(filter, getDefaultCriteriaSetup());
    }

    protected CriteriaSetup getDefaultCriteriaSetup() {
        return new CriteriaSetup() {
            public void setup(Criteria criteria, Map filter) {
                if (filter != null && !filter.isEmpty()) {
                    Set keys = filter.keySet();
                    for (Object key : keys) {
                        String value = (String) filter.get(key);
                        if (StringUtils.isNotBlank(value))
                            criteria.add(Restrictions.eq((String) key, value));
                    }
                }
            }
        };
    }

    /**
     * 取得Entity的Criteria.
     */
    protected Criteria getEntityCriteria() {
        return getSession().createCriteria(getEntityClass());
    }

    /**
     * 构造Criteria的排序条件默认函数.可供其他查询函数调用
     *
     * @param criteria Criteria实例.
     * @param sortMap  排序条件.
     * @param entity   entity对象,用于使用反射来获取某些属性信息
     */
    protected void sortCriteria(Criteria criteria, Map sortMap, Object entity) {
        if (!sortMap.isEmpty()) {
            for (Object o : sortMap.keySet()) {
                String fieldName = o.toString();
                String orderType = sortMap.get(fieldName).toString();

                //处理嵌套属性如category.name,modify_user.id,暂时只处理一级嵌套
                if (fieldName.indexOf('.') != -1) {
                    String alias = StringUtils.substringBefore(fieldName, ".");
                    String aliasType = alias;
                    try {
                        aliasType = PropertyUtils.getProperty(entity, alias).getClass().getSimpleName();
                    } catch (Exception e) {
                        logger.error("Get property" + alias + " error");
                    }
                    criteria.createAlias(aliasType, alias);
                }

                if ("asc".equalsIgnoreCase(orderType)) {
                    criteria.addOrder(Order.asc(fieldName));
                } else {
                    criteria.addOrder(Order.desc(fieldName));
                }
            }
        }
    }

    /**
     * 判断对象某列的值在数据库中不存在重复
     *
     * @param names 在POJO里相对应的属性名,列组合时以逗号分割

     *              如"name,loginid,password"
     */
    public boolean isNotUnique(Object entity, String names) {
        Assert.hasText(names);
        Criteria criteria = getSession().createCriteria(entity.getClass()).setProjection(Projections.rowCount());
        String[] nameList = names.split(",");
        try {
            for (String name : nameList) {
                criteria.add(Restrictions.eq(name, PropertyUtils.getProperty(entity, name)));
            }

            String keyName = getSessionFactory().getClassMetadata(entity.getClass()).getIdentifierPropertyName();
            if (keyName != null) {
                Object id = PropertyUtils.getProperty(entity, keyName);
                //如果是update,排除自身
                if (id != null)
                    criteria.add(Restrictions.not(Restrictions.eq(keyName, id)));
            }
        }
        catch (Exception e) {
            logger.error(e.getMessage());
            return false;
        }
        return ((Integer) criteria.uniqueResult()) > 0;
    }
}

上面只是简单的说了一下的springside项目源代码的一些优雅的地方,如果有需要的要求的话,我会贴出完整的一个简单例子的demo的,包括分页的与泛型DAO的应用.

评论

5 楼 xugq035 2009-08-17  

请问一下如果通过hql查询，如果语句中包含distinct怎么办？
String countQueryString = " select count (*) " + removeSelect(removeOrders(hql));
这样查询出来的总数好像不正确

4 楼 fudehai001 2009-02-21  

贴出完整的一个简单例子的demo  --盼望中，辛苦了

3 楼 huobao89 2008-10-10  

想问一下 如果 用 startIndex做，在页面用pager-taglib 做分页，怎么传参数给
export="pageOffset,pageNumber" 
谢谢

2 楼 junzhonxiaozi 2007-04-05  

谢谢分享，我正需要这方面的例子学习学习
可以贴出让大家分享么！
邮箱(交流学习)：[e-mail]

1 楼 j2292003 2006-12-26  

如果page分页的Criteria 含有group by 等,你是如何解决的?
先把Projection和OrderBy条件取出来,清空两者来执行Count操作 ,这意味着取出Projection时,取出了group by等条件,这样执行的结果不一样,本人也遇到了这个问题,暂时没有想到好的解决方法,判交流:[e-mail]