Java tutorial
/** * Copyright (c) 2005-2009 springside.org.cn * * Licensed under the Apache License, Version 2.0 (the "License"); * * $Id: HibernateDao.java 763 2009-12-27 18:36:21Z calvinxiu $ */ package com.thinkmore.framework.orm.hibernate; import java.io.Serializable; import java.util.ArrayList; import java.util.List; import java.util.Map; import javax.annotation.Resource; import org.apache.commons.lang3.StringUtils; import org.hibernate.Criteria; import org.hibernate.Query; import org.hibernate.SessionFactory; import org.hibernate.criterion.CriteriaSpecification; import org.hibernate.criterion.Criterion; import org.hibernate.criterion.Disjunction; import org.hibernate.criterion.MatchMode; import org.hibernate.criterion.Order; import org.hibernate.criterion.Projection; import org.hibernate.criterion.Projections; import org.hibernate.criterion.Restrictions; import org.hibernate.impl.CriteriaImpl; import org.hibernate.transform.ResultTransformer; import org.springframework.jdbc.core.BatchPreparedStatementSetter; import org.springframework.jdbc.core.JdbcTemplate; import org.springframework.jdbc.core.PreparedStatementSetter; import org.springframework.jdbc.core.RowMapper; import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate; import org.springframework.util.Assert; import com.thinkmore.framework.common.log.LogUtil; import com.thinkmore.framework.common.spring.jdbc.DialectUtils; import com.thinkmore.framework.common.spring.jdbc.PageDialect; import com.thinkmore.framework.orm.Page; import com.thinkmore.framework.orm.PropertyFilter; import com.thinkmore.framework.orm.PropertyFilter.MatchType; import com.thinkmore.framework.utils.ReflectionUtil; /** * ?SpringSideHibernat DAO. * * ,?. ?Service,?DAO?,?. * * @param <T> * DAO? * @param <PK> * * * @author calvin */ public class HibernateDao<T, PK extends Serializable> extends SimpleHibernateDao<T, PK> { @Resource protected JdbcTemplate jdbcTemplate; @Resource protected NamedParameterJdbcTemplate namedParameterJdbcTemplate; /** * Dao?. ??Class. eg. public class UserDao extends * HibernateDao<User, Long>{ } */ public HibernateDao() { super(); } /** * ?Dao, ServiceHibernateDao. Class. eg. * HibernateDao<User, Long> userDao = new HibernateDao<User, * Long>(sessionFactory, User.class); */ public HibernateDao(final SessionFactory sessionFactory, final Class<T> entityClass) { super(sessionFactory, entityClass); } // -- --// /** * ?. */ public Page<T> getAll(final Page<T> page) { return findPage(page); } /** * HQL. * * @param page * ?.??orderBy?. * @param hql * hql?. * @param values * ????,?. * * @return , ??. */ @SuppressWarnings({ "rawtypes" }) public Page<T> findPage(final Page<T> page, final String hql, final Object... values) { Assert.notNull(page, "page?"); Query q = createQuery(hql, values); if (page.isAutoCount()) { long totalCount = countHqlResult(hql, values); page.setTotalCount(totalCount); } setPageParameter(q, page); List result = q.list(); page.setResult(result); return page; } /** * HQL. * * @param page * ?. * @param hql * hql?. * @param values * ???,??. * * @return , ??. */ @SuppressWarnings({ "rawtypes" }) public Page<T> findPage(final Page<T> page, final String hql, final Map<String, ?> values) { Assert.notNull(page, "page?"); Query q = createQuery(hql, values); if (page.isAutoCount()) { long totalCount = countHqlResult(hql, values); page.setTotalCount(totalCount); } setPageParameter(q, page); List result = q.list(); page.setResult(result); return page; } /** * Criteria. * * @param page * ?. * @param criterions * ???Criterion. * * @return .??. */ @SuppressWarnings({ "rawtypes" }) public Page<T> findPage(final Page<T> page, final Criterion... criterions) { Assert.notNull(page, "page?"); Criteria c = createCriteria(criterions); if (page.isAutoCount()) { int totalCount = countCriteriaResult(c); page.setTotalCount(totalCount); } setPageParameter(c, page); List result = c.list(); page.setResult(result); return page; } /** * ?Query,. */ protected Query setPageParameter(final Query q, final Page<T> page) { // hibernatefirstResult??0 q.setFirstResult(page.getFirst() - 1); q.setMaxResults(page.getPageSize()); return q; } /** * ?Criteria,. */ protected Criteria setPageParameter(final Criteria c, final Page<T> page) { // hibernatefirstResult??0 c.setFirstResult(page.getFirst() - 1); c.setMaxResults(page.getPageSize()); if (page.isOrderBySetted()) { String[] orderByArray = StringUtils.split(page.getOrderBy(), ','); String[] orderArray = StringUtils.split(page.getOrder(), ','); Assert.isTrue(orderByArray.length == orderArray.length, "???,????"); for (int i = 0; i < orderByArray.length; i++) { if (Page.ASC.equals(orderArray[i])) { c.addOrder(Order.asc(orderByArray[i])); } else { c.addOrder(Order.desc(orderByArray[i])); } } } return c; } /** * countHql. * * ???hql?,??hql?count?. */ protected long countHqlResult(final String hql, final Object... values) { try { Long count = findUnique(getCountSQL(hql), values); return count; } catch (Exception e) { throw new RuntimeException("hql can't be auto count, hql is:" + getCountSQL(hql), e); } } /** * countHql. * * ???hql?,??hql?count?. */ protected long countHqlResult(final String hql, final Map<String, ?> values) { try { Long count = findUnique(getCountSQL(hql), values); return count; } catch (Exception e) { throw new RuntimeException("hql can't be auto count, hql is:" + getCountSQL(hql), e); } } /** * countCriteria. */ @SuppressWarnings({ "unchecked", "rawtypes" }) protected int countCriteriaResult(final Criteria c) { CriteriaImpl impl = (CriteriaImpl) c; // Projection?ResultTransformer?OrderBy??,??Count? Projection projection = impl.getProjection(); ResultTransformer transformer = impl.getResultTransformer(); List<CriteriaImpl.OrderEntry> orderEntries = null; try { orderEntries = (List) ReflectionUtil.getFieldValue(impl, "orderEntries"); ReflectionUtil.setFieldValue(impl, "orderEntries", new ArrayList()); } catch (Exception e) { logger.error("??:{}", e.getMessage()); } // Count int totalCount = (Integer) c.setProjection(Projections.rowCount()).uniqueResult(); // ?Projection,ResultTransformerOrderBy?? c.setProjection(projection); if (projection == null) { c.setResultTransformer(CriteriaSpecification.ROOT_ENTITY); } if (transformer != null) { c.setResultTransformer(transformer); } try { ReflectionUtil.setFieldValue(impl, "orderEntries", orderEntries); } catch (Exception e) { logger.error("??:{}", e.getMessage()); } return totalCount; } // -- ?(PropertyFilter) --// /** * ,????. * * @param matchType * ??,????PropertyFilterMatcheType enum. */ public List<T> findBy(final String propertyName, final Object value, final MatchType matchType) { Criterion criterion = buildPropertyFilterCriterion(propertyName, value, matchType); return find(criterion); } /** * ?. */ public List<T> find(List<PropertyFilter> filters) { Criterion[] criterions = buildPropertyFilterCriterions(filters); return find(criterions); } /** * ?. */ public Page<T> findPage(final Page<T> page, final List<PropertyFilter> filters) { Criterion[] criterions = buildPropertyFilterCriterions(filters); return findPage(page, criterions); } /** * ?Criterion,. */ protected Criterion[] buildPropertyFilterCriterions(final List<PropertyFilter> filters) { List<Criterion> criterionList = new ArrayList<Criterion>(); for (PropertyFilter filter : filters) { if (!filter.isMultiProperty()) { // ??. Criterion criterion = buildPropertyFilterCriterion(filter.getPropertyName(), filter.getPropertyValue(), filter.getMatchType()); criterionList.add(criterion); } else {// ??,or?. Disjunction disjunction = Restrictions.disjunction(); for (String param : filter.getPropertyNames()) { Criterion criterion = buildPropertyFilterCriterion(param, filter.getPropertyValue(), filter.getMatchType()); disjunction.add(criterion); } criterionList.add(disjunction); } } return criterionList.toArray(new Criterion[criterionList.size()]); } /** * ??Criterion,. */ protected Criterion buildPropertyFilterCriterion(final String propertyName, final Object propertyValue, final MatchType matchType) { Assert.hasText(propertyName, "propertyName?"); Criterion criterion = null; try { // ?MatchTypecriterion if (MatchType.EQ.equals(matchType)) { criterion = Restrictions.eq(propertyName, propertyValue); } else if (MatchType.LIKE.equals(matchType)) { criterion = Restrictions.like(propertyName, (String) propertyValue, MatchMode.ANYWHERE); } else if (MatchType.LE.equals(matchType)) { criterion = Restrictions.le(propertyName, propertyValue); } else if (MatchType.LT.equals(matchType)) { criterion = Restrictions.lt(propertyName, propertyValue); } else if (MatchType.GE.equals(matchType)) { criterion = Restrictions.ge(propertyName, propertyValue); } else if (MatchType.GT.equals(matchType)) { criterion = Restrictions.gt(propertyName, propertyValue); } } catch (Exception e) { throw ReflectionUtil.convertReflectionExceptionToUnchecked(e); } return criterion; } /** * ??. * * ,(value)?(orgValue)?. */ public boolean isPropertyUnique(final String propertyName, final Object newValue, final Object oldValue) { if (newValue == null || newValue.equals(oldValue)) { return true; } Object object = findUniqueBy(propertyName, newValue); return (object == null); } /** * ??. * * @param sql * @return */ private boolean vilaQuery(String sql) { if (jdbcTemplate == null) { LogUtil.otherLogger.warn("?jdbcTemplate,Sql:" + sql); throw new IllegalArgumentException("jdbcTemplate is null,please initial it first. "); } else if (StringUtils.isEmpty(sql)) { LogUtil.otherLogger.warn("sql?"); throw new IllegalArgumentException("sql is empty,please initial it first. "); } return true; } private String init(String sql, final Page page, Object... values) { vilaQuery(sql); if (page.isAutoCount()) { page.setTotalCount(jdbcTemplate.queryForObject(getCountSQL(sql), values, Long.class)); } PageDialect md = PageDialect.valueOf(DialectUtils.getDialect(jdbcTemplate.getDataSource())); return md.generatePageSql(sql, page); } /** * sql,?, ??. ??? * * @param sql * @param pageNumber * @param pageSize * @param params??? * @param jdbcTemplate * * @return List<Map<String, Object>> */ @SuppressWarnings("rawtypes") public Page queryByPage(String sql, final Page page, Object... params) { Assert.notNull(page, "page?"); if (page.getJdbcTemplate() != null) { jdbcTemplate = page.getJdbcTemplate(); } String queryPageSql = init(sql, page, params); page.setResult(jdbcTemplate.queryForList(queryPageSql)); return page; } @SuppressWarnings("rawtypes") public List queryList(String sql, Object... params) { return jdbcTemplate.queryForList(sql, params); } @SuppressWarnings("rawtypes") public List queryList(String sql, RowMapper rowMapper, Object... params) { return jdbcTemplate.query(sql, params, rowMapper); } @SuppressWarnings("rawtypes") public Map queryMap(String sql, Object... params) { return jdbcTemplate.queryForMap(sql, params); } @SuppressWarnings("rawtypes") public Map queryMap(String sql, RowMapper rowMapper, Object... params) { return jdbcTemplate.queryForMap(sql, params, rowMapper); } /** * rowMapper * * @param sql * @param rowMapper * @param pageNumber * @param pageSize * @param params * ??? * @return */ @SuppressWarnings({ "unchecked", "rawtypes" }) public Page queryByPage(String sql, RowMapper rowMapper, final Page page, Object... params) { Assert.notNull(page, "page?"); if (page.getJdbcTemplate() != null) { jdbcTemplate = page.getJdbcTemplate(); } String queryPageSql = init(sql, page, params); page.setResult(jdbcTemplate.query(queryPageSql, params, rowMapper)); return page; } public Object queryById(String sql, RowMapper<?> rowMapper, Object... params) { Assert.notNull(sql, "sql?"); return jdbcTemplate.queryForObject(sql, params, rowMapper); } // public String getCountSQL(String sql) { String fromHql = sql; // select??order by???count,?. fromHql = "from " + StringUtils.substringAfter(fromHql, "from"); fromHql = StringUtils.substringBefore(fromHql, "order by"); return "select count(*) as count " + fromHql; } public Integer update(String sql, Object... params) { Assert.notNull(sql, "sql?"); return jdbcTemplate.update(sql, params); } public Integer update(String sql, PreparedStatementSetter psSetter) { Assert.notNull(sql, "sql?"); return jdbcTemplate.update(sql, psSetter); } public int[] updateBatch(String sql, BatchPreparedStatementSetter bpSetter) { Assert.notNull(sql, "sql?"); return jdbcTemplate.batchUpdate(sql, bpSetter); } public int[] updateBatch(String[] sqls) { return jdbcTemplate.batchUpdate(sqls); } public int updateN(String sql, Map map) { return namedParameterJdbcTemplate.update(sql, map); } }