Java tutorial
/** * Copyright (c) 2005-2009 springside.org.cn * * Licensed under the Apache License, Version 2.0 (the "License"); * * $Id: SimpleHibernateDao.java 1005 2010-03-25 15:50:00Z calvinxiu $ */ package net.umpay.mailbill.hql.orm.hibernate; import java.io.Serializable; import java.util.List; import java.util.Map; import net.umpay.mailbill.hql.dao.BaseDao; import net.umpay.mailbill.util.reflect.ReflectionUtils; import org.hibernate.Criteria; import org.hibernate.Hibernate; import org.hibernate.Query; import org.hibernate.SQLQuery; import org.hibernate.Session; import org.hibernate.SessionFactory; import org.hibernate.criterion.CriteriaSpecification; import org.hibernate.criterion.Criterion; import org.hibernate.criterion.Order; 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; /** * ?HibernateAPIDAO. * * ?Service,?DAO?. * ?Spring2.5Petlinc?,?HibernateTemplate,HibernateAPI. * * @param <T> DAO? * @param <PK> * * @author calvin */ @SuppressWarnings("unchecked") public abstract class SimpleHibernateDao<T, PK extends Serializable> implements BaseDao<T, PK> { 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, ServiceSimpleHibernateDao. * 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; } /** * @AutowiredSessionFactory, SesionFactoryOverride. */ @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?idtransient. */ 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> getAll(String orderBy, boolean isAsc) { Criteria c = createCriteria(); if (isAsc) { c.addOrder(Order.asc(orderBy)); } else { c.addOrder(Order.desc(orderBy)); } return c.list(); } /** * ,??. */ 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, ?> values) { return createQuery(hql, values).list(); } /** * SQL. * * @param values ????,?. */ public <X> List<X> findSQL(final String sql, final Object... values) { SQLQuery q = createSQLQuery(sql, values); String className = entityClass.getSimpleName(); if (!className.equals("Object") && !className.equals("Object[]")) { q.addEntity(entityClass); } return q.list(); } /** * SQL. * * @param values ???,??. */ public <X> List<X> findSQL(final String sql, final Map<String, ?> values) { SQLQuery q = createSQLQuery(sql, values); String className = entityClass.getSimpleName(); if (!className.equals("Object") && !className.equals("Object[]")) { q.addEntity(entityClass); } return q.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(); } public <X> X findUniqueSql(final String sql, final Object... values) { return (X) createSQLQuery(sql, values).uniqueResult(); } public <X> X findUniqueSql(final String sql, final Map<String, ?> values) { return (X) createSQLQuery(sql, 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, ?> values) { return createQuery(hql, values).executeUpdate(); } /** * SQL?/?. */ public int batchSQLExecute(final String sql, final Object... values) { return createSQLQuery(sql, values).executeUpdate(); } /** * SQL?/?. * @return . */ public int batchSQLExecute(final String sql, final Map<String, ?> values) { return createSQLQuery(sql, 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[i]); } } return query; } /** * ?HQL?Query. * * @param values ???,??. */ public Query createQuery(final String queryString, final Map<String, ?> values) { Assert.hasText(queryString, "queryString?"); Query query = getSession().createQuery(queryString); if (values != null) { //query.setProperties(values); for (Map.Entry<String, ?> entry : values.entrySet()) { query.setParameter(entry.getKey(), entry.getValue()); } } return query; } public SQLQuery createSQLQuery(final String queryString, final Object... values) { Assert.hasText(queryString, "queryString?"); SQLQuery query = getSession().createSQLQuery(queryString); if (values != null) { for (int i = 0; i < values.length; i++) { query.setParameter(i, values[i]); } } return query; } public SQLQuery createSQLQuery(final String queryString, final Map<String, ?> values) { Assert.hasText(queryString, "queryString?"); SQLQuery query = getSession().createSQLQuery(queryString); if (values != null) { for (Map.Entry<String, ?> entry : values.entrySet()) { query.setParameter(entry.getKey(), entry.getValue()); } } return query; } /** * Criteria. * * @param criterions ???Criterion. */ public List<T> find(final Criterion... criterions) { return createCriteria(criterions).list(); } /** * Criteria. * * @param criterions ???Criterion. */ public List<Serializable> findSerial(final Criterion... criterions) { return createCriteria(criterions).list(); } /** * Criteria. * * @param criteria */ public List<T> find(final Criteria criteria) { return criteria.list(); } /** * Criteria. * * @param criterions ???Criterion. */ public T findUnique(final Criterion... criterions) { return (T) createCriteria(criterions).uniqueResult(); } /** * Criteria.?? * * @param criterions ???Criterion. */ public T findUniqueByCache(final Criterion... criterions) { return (T) createCriteria(criterions).setCacheable(true).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())?UserDescription. */ public void initEntity(T entity) { Hibernate.initialize(entity); } /** * @see #initEntity(Object) */ public void initEntity(List<T> entityList) { for (T entity : entityList) { Hibernate.initialize(entity); } } /** * Flush?Session. */ public void flush() { getSession().flush(); } /** * Querydistinct transformer. */ public Query distinct(Query query) { query.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY); return query; } /** * Criteriadistinct transformer. */ public Criteria distinct(Criteria criteria) { criteria.setResultTransformer(CriteriaSpecification.DISTINCT_ROOT_ENTITY); return criteria; } /** * ???. */ public String getIdName() { ClassMetadata meta = getSessionFactory().getClassMetadata(entityClass); return meta.getIdentifierPropertyName(); } }