ibatis操作 模板基类设计 实现所有的,增,删,改,查,分页

上一篇介绍了:hibernate 模板基类设计

这一次介绍一下 ibatis 模板基类设计 实现公共方法，减少开发工作量
代码更整洁清淅

EntityDAO 类代码如下:

/**
 * (#)EntityDAO.java 1.0 2008-6-7 上午09:25:37
 *
 */
package com.keyi.util.dao;


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


public interface EntityDAO<T> {

	/**
	 * 根据主键查找对象
	 * 
	 * @param id
	 *            主键值
	 * @return 对象实体
	 */
	T findByPrimarykey(Serializable id);

	/**
	 * 新增对象到数据库
	 * 
	 * @param o
	 *            对象实体
	 */
	void insert(T o);

	/**
	 * 更新对象实体到数据库
	 * 
	 * @param o
	 *            对象实体
	 */
	void update(T o);

	/**
	 * 根据主键删除对象
	 * 
	 * @param id
	 *            主键值
	 */
	void deleteByPrimarykey(Serializable id);

	/**
	 * 更新对象信息
	 * 
	 * @param statementId
	 *            sql语句名称后缀
	 * @param parameters
	 *            sql参数
	 */
	void update(String statementId, Object parameters);

	/**
	 * sql查询单个对象
	 * 
	 * @param statementId
	 *            sql语句名称后缀
	 * @param parameters
	 *            sql参数
	 * @return 查询结果
	 */
	T queryForObject(String statementId, Object parameters);

	/**
	 * sql查询列表
	 * 
	 * @param statementId
	 *            sql语句名称后缀
	 * @param parameters
	 *            sql参数
	 * @return 查询结果
	 */
	List<T> queryForList(String statementId, Object parameters);
}

IbatisEntityDao 类内容如下:

/**
 * (#)IbatisEntityDao.java 1.0 2008-6-7 上午09:24:32
 *
 */
package com.keyi.util.dao;

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

import org.apache.commons.lang.StringUtils;

import com.keyi.util.page.Page;


@SuppressWarnings("unchecked")
public class IbatisEntityDao<T> extends IbatisGenericDao implements
		EntityDAO<T> {

	/**
	 * DAO所管理的Entity类型.
	 */
	protected Class<T> entityClass;

	protected String primaryKeyName;

	/**
	 * 在构造函数中将泛型T.class赋给entityClass.
	 */
	@SuppressWarnings("unchecked")
	public IbatisEntityDao() {
		entityClass = GenericsUtils.getSuperClassGenricType(getClass());
	}

	/**
	 * 根据ID获取对象.
	 */
	public T findByPrimarykey(Serializable id) {
		return get(getEntityClass(), id);
	}

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

	public String getIdName(Class clazz) {
		return "id";
	}

	/**
	 * 分页查询.
	 */
	public Page pagedQuery(Map parameterObject, int start, int limit) {
		return pagedQuery(getEntityClass(), parameterObject, start, limit);
	}

	/**
	 * 分页查询.
	 */
	public Page pagedQuery(Map parameterObject, int start, int limit,
			String countSqlId, String pageQuerySqlId) {
		if (StringUtils.isNotBlank(pageQuerySqlId))
			return pagedQuery(getEntityClass(), parameterObject, start, limit,
					countSqlId, pageQuerySqlId);
		else {
			return pagedQuery(getEntityClass(), parameterObject, start, limit);
		}
	}

	/**
	 * 根据ID移除对象.
	 */
	public void deleteByPrimarykey(Serializable id) {
		removeById(getEntityClass(), id);
	}

	/**
	 * 保存对象. 为了实现IEntityDao 我在内部使用了insert和upate 2个方法.
	 */
	public void insert(T o) {
		super._insert(o);
	}

	public void setPrimaryKeyName(String primaryKeyName) {
		this.primaryKeyName = primaryKeyName;
	}

	public List<T> queryForList(String statementId, Object parameters) {
		return super.queryForList(getEntityClass(), statementId, parameters);

	}

	public T queryForObject(String statementId, Object parameters) {
		return super.queryForObject(getEntityClass(), statementId, parameters);
	}

	public void update(String statementId, Object parameters) {
		super.update(getEntityClass(), statementId, parameters);

	}

	public void update(T o) {
		super._update(o);
	}
}

IbatisGenericDao 类内容如下:

/**
 * (#)IbatisGenericDao.java 1.0 2008-6-7 上午09:20:13
 *
 */
package com.keyi.util.dao;

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

import org.springframework.orm.ibatis.support.SqlMapClientDaoSupport;
import org.springframework.util.Assert;

import com.keyi.util.page.Page;


@SuppressWarnings("unchecked")
public class IbatisGenericDao extends SqlMapClientDaoSupport {

	public static final String POSTFIX_INSERT = ".insert";

	public static final String POSTFIX_UPDATE = ".update";

	public static final String POSTFIX_DELETE = ".delete";

	public static final String POSTFIX_DELETE_PRIAMARYKEY = ".deleteByPrimaryKey";

	public static final String POSTFIX_SELECT = ".select";

	public static final String POSTFIX_GETALL = ".getAll";

	public static final String POSTFIX_SELECTMAP = ".selectByMap";

	public static final String POSTFIX_SELECTSQL = ".selectBySql";

	public static final String POSTFIX_COUNT = ".count";

	public static final String POSTFIX_QUERY = ".query";

	/**
	 * 根据ID获取对象
	 */
	public <T> T get(Class<T> entityClass, Serializable id) {

		T o = (T) getSqlMapClientTemplate().queryForObject(
				getStatementId(entityClass, IbatisGenericDao.POSTFIX_SELECT),
				id);
		return o;
	}

	/**
	 * 新增对象
	 */
	public void _insert(Object o) {
		getSqlMapClientTemplate().insert(
				getStatementId(o.getClass(), IbatisGenericDao.POSTFIX_INSERT),
				o);
	}

	/**
	 * 保存对象
	 */
	public void _update(Object o) {
		getSqlMapClientTemplate().update(
				getStatementId(o.getClass(), IbatisGenericDao.POSTFIX_UPDATE),
				o);
	}

	/**
	 * 根据ID删除对象
	 */
	public <T> void removeById(Class<T> entityClass, Serializable id) {
		getSqlMapClientTemplate().delete(
				getStatementId(entityClass,
						IbatisGenericDao.POSTFIX_DELETE_PRIAMARYKEY), id);
	}

	/**
	 * 分页查询函数，使用PaginatedList.
	 * 
	 * @param start
     *@param limit @return 含17117717记录数和当前页数据的Page对象.
	 */
	public Page pagedQuery(Class entityClass, Map parameterObject, int start,
			int limit) {

		Assert.isTrue(start >= 0, "pageNo should start from 0");

		// 计算总数 
		Integer totalCount = (Integer) getSqlMapClientTemplate()
				.queryForObject(
						getStatementId(entityClass,
								IbatisGenericDao.POSTFIX_COUNT),
						parameterObject);

		// 如果没有数据则返回Empty Page
		Assert.notNull(totalCount, "totalCount Error");

		if (totalCount.intValue() == 0) {
			return new Page();
		}

		List list;
		int totalPageCount = 0;
		int startIndex = 0;

		// 如果pageSize小于0,则返回所有数捄1177,等同于getAll
		if (limit > 0) {

			// 计算页数
			totalPageCount = (totalCount / limit);
			totalPageCount += ((totalCount % limit) > 0) ? 1 : 0;

			// 计算skip数量
			if (totalCount > start) {
				startIndex = start;
			} else {
				startIndex = (totalPageCount - 1) * limit;
			}

			if (parameterObject == null)
				parameterObject = new HashMap();

			parameterObject.put("startIndex", startIndex);
			parameterObject.put("endIndex", limit);

			list = getSqlMapClientTemplate()
					.queryForList(
							getStatementId(entityClass,
									IbatisGenericDao.POSTFIX_QUERY),
							parameterObject);

		} else {
			list = getSqlMapClientTemplate()
					.queryForList(
							getStatementId(entityClass,
									IbatisGenericDao.POSTFIX_QUERY),
							parameterObject);
		}
		return new Page(startIndex, totalCount, limit, list);
	}

	/**
	 * 分页查询函数，使用PaginatedList.
	 * 
	 * @param start
     *@param limit @return 含17117717记录数和当前页数据的Page对象.
	 */
	public Page pagedQuery(Class entityClass, Map parameterObject, int start,
			int limit, String countSqlId, String pageQuerySqlId) {

		Assert.isTrue(start >= 0, "pageNo should start from 0");

		// 计算总数 
		Integer totalCount = (Integer) getSqlMapClientTemplate()
				.queryForObject(
						getStatementId(entityClass,
								countSqlId),
						parameterObject);

		// 如果没有数据则返回Empty Page
		Assert.notNull(totalCount, "totalCount Error");

		if (totalCount.intValue() == 0) {
			return new Page();
		}

		List list;
		int totalPageCount = 0;
		int startIndex = 0;

		// 如果pageSize小于0,则返回所有数捄1177,等同于getAll
		if (limit > 0) {

			// 计算页数
			totalPageCount = (totalCount / limit);
			totalPageCount += ((totalCount % limit) > 0) ? 1 : 0;

			// 计算skip数量
			if (totalCount >= start) {
				startIndex = start;
			} else {
				startIndex = (totalPageCount - 1) * limit;
			}

			if (parameterObject == null)
				parameterObject = new HashMap();

			parameterObject.put("startIndex", startIndex);
			parameterObject.put("endIndex",  limit);

			list = getSqlMapClientTemplate()
					.queryForList(
							getStatementId(entityClass,
									pageQuerySqlId),
							parameterObject);

		} else {
			list = getSqlMapClientTemplate()
					.queryForList(
							getStatementId(entityClass,
									pageQuerySqlId),
							parameterObject);
		}
		return new Page(startIndex, totalCount, limit, list);
	}

	/**
	 * get statement id in SQL Map file
	 * 
	 * @param entityClass
	 *            entity class
	 * @param suffix
	 *            suffix
	 * @return statement id
	 */
	private String getStatementId(Class entityClass, String suffix) {
		String className = entityClass.getName();
		String shortName = className.replace(entityClass.getPackage().getName()
				+ ".", "");
		return shortName + suffix;
	}

	public <T> List<T> queryForList(Class<T> entityClass, String statementId,
			Object parameters) {
		return getSqlMapClientTemplate().queryForList(
				getStatementId(entityClass, statementId), parameters);
	}

	public <T> T queryForObject(Class<T> entityClass, String statementId,
			Object parameters) {
		return (T) getSqlMapClientTemplate().queryForObject(
				getStatementId(entityClass, statementId), parameters);
	}

	public void update(Class entityClass, String statementId, Object parameters) {
		getSqlMapClientTemplate().update(
				getStatementId(entityClass, statementId), parameters);
	}
}

GenericsUtils 类内容如下:

/**
 * (#)GenericsUtils.java 1.0 2008-6-7 上午09:26:43
 *
 */
package com.keyi.util.dao;

import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

@SuppressWarnings("unchecked")
public class GenericsUtils {
    private static final Log log = LogFactory.getLog(GenericsUtils.class);

    private GenericsUtils() {
    }


    public static Class getSuperClassGenricType(Class clazz) {
        return getSuperClassGenricType(clazz, 0);
    }


    public static Class getSuperClassGenricType(Class clazz, int index) {

        Type genType = clazz.getGenericSuperclass();

        if (!(genType instanceof ParameterizedType)) {
            log.warn(clazz.getSimpleName() + "'s superclass not ParameterizedType");
            return Object.class;
        }

        Type[] params = ((ParameterizedType) genType).getActualTypeArguments();

        if (index >= params.length || index < 0) {
            log.warn("Index: " + index + ", Size of " + clazz.getSimpleName() + "'s Parameterized Type: "
                    + params.length);
            return Object.class;
        }
        if (!(params[index] instanceof Class)) {
            log.warn(clazz.getSimpleName() + " not set the actual class on superclass generic parameter");
            return Object.class;
        }
        return (Class) params[index];
    }


}

具体应用如下：

public interface UserDAO extends EntityDAO<User>{
}

public class IbatisUserDAO extends IbatisEntityDao<User> implements UserDAO {

}

public interface NewsDAO extends EntityDAO<News>{

}
public class IbatisNewsDAO extends IbatisEntityDao<News> implements NewsDAO {

}