大话分页（补充）——Threadlocal封装offSet和pageSize简化分页工具类

经过前两篇文章（大话分页一、大话分页二）的介绍，我认为我想介绍的东西已经介绍完了，不过想精益求精的童鞋可以继续看本篇文章。

在第一篇文章中介绍了一个分页的工具类（具体请看大话分页一），从实现功能上来说，它没有任何问题，不过就OO思想来说，这个类是有一点问题的：实现分页，我们是要用到offSet和pageSize两个参数，也就是说他们是必须的。可是我们每当使用到分页的时候，除了穿业务逻辑所需的参数，还需要传递这两个参数。这样，方法未免有些太过冗长，有没有一种方法，可以让它自动传递这两个参数，开发人员不用手动去管它呢？它就是threadlocal。

下面SystemContext这个类里面就用Threadlocal封装了offSet和pageSize两个参数，并依次定义了他们的get、set和remove方法。

package com.lzq;

/**
 * 使用threadLocal简化API
 * 由于封装的分页类AbstractPageManager，中的方法参数offSet和pageSize必要但是每个方法都必须写
 * 所以使用threadLocal简化
 * @author lzq
 *
 */
public class SystemContext {
	//定义两个threadLocal变量：offSet和pageSize
	private static ThreadLocal<Integer> offSet = new ThreadLocal<Integer>();
	private static ThreadLocal<Integer> pageSize = new ThreadLocal<Integer>();
	/*
	 * offset ：get、set、remove
	 */
	public static int getOffSet() {
		Integer os =offSet.get();
		if (os == null) {
			return 0;
		}
		return os;
	}
	public static void setOffSet(int offSetValue) {
		offSet.set(offSetValue);
	}
	public static void removeOffSet(){
		offSet.remove();
	}
	/*
	 * pageSize ：get、set、remove
	 */
	public static int getPageSize() {
		Integer ps = pageSize.get();
		if (ps == null) {
			return 0;
		}
		return ps;
	}
	public static void setPageSize(int pageSizeValue) {
		pageSize.set(pageSizeValue);
	}
	public static void removePageSize(){
		pageSize.remove();
	}
}

PageFilter，用于获取前台传过来的offset的值以及设置pageSize的值。

package com.lzq.web;

import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import com.lzq.SystemContext;

/**
 * 分页Filter，用于获取offSet和pageSize的值
 * @author lzq
 *
 */
public class PageFilter implements Filter {
	@Override
	public void destroy() {}

	@Override
	public void doFilter(ServletRequest request, ServletResponse response,
			FilterChain chain) throws IOException, ServletException {

		HttpServletRequest httpRequest=(HttpServletRequest)request;

		SystemContext.setOffSet(getOffSet(httpRequest));
		SystemContext.setPageSize(getPageSize());

		try {
			chain.doFilter(request, response);
		}
		//使用完Threadlocal，将其删除。使用finally确保一定将其删除
		finally{
			SystemContext.removeOffSet();
			SystemContext.removePageSize();
		}
	}
	/**
	 * 获得pager.offset参数的值
	 * @param request
	 * @return
	 */
	protected int getOffSet(HttpServletRequest request) {
		int offSet = 0;
		try {
			String pageOff = request.getParameter("pager.offset");
			if (pageOff != null) {
				offSet =Integer.parseInt(pageOff);
			}
		} catch (NumberFormatException e) {
			e.printStackTrace();
		}
		return offSet;
	}
	/**
	 * 设置默认每页大小
	 * @return
	 */
	protected int getPageSize() {
		return 4;
	}
	@Override
	public void init(FilterConfig arg0) throws ServletException {}
}

在web.xml配置文件中对filter进行配置：

  <filter>
  	<filter-name>PageFilter</filter-name>
  	<filter-class>com.lzq.web.PageFilter</filter-class>
  </filter>
  <filter-mapping>
  	<filter-name>PageFilter</filter-name>
  	<url-pattern>/*</url-pattern>
  </filter-mapping>

在工具类AbstractPageManager中，另外增加下面几个重载的工具API方法，以达到减少参数的目的。

package com.lzq.manager.impl;

import org.hibernate.Query;
import org.springframework.orm.hibernate3.support.HibernateDaoSupport;

import com.lzq.PageModel;
import com.lzq.SystemContext;
import com.lzq.manager.SystemException;
/**
 * 简化的分页API
 * @author lzq
 *
 */
public class AbstractPageManager extends HibernateDaoSupport {

	/**
	 * 通过调用这些工具方法，简化API
	 * @param hql
	 * @return
	 */
	public PageModel searchPaginate(String hql){
		return searchPaginate(hql,null,SystemContext.getOffSet(),SystemContext.getPageSize());
	}
	public PageModel searchPaginate(String hql, Object param){
		return searchPaginate(hql,new Object[]{param},SystemContext.getOffSet(),SystemContext.getPageSize());
	}
	public PageModel searchPaginate(String hql, int offSet, int pageSize){
		return searchPaginate(hql,null,offSet,pageSize);
	}
	public PageModel searchPaginate(String hql, Object param, int offSet, int pageSize){
		return searchPaginate(hql,new Object[]{param},offSet,pageSize);
	}
}

测试调用的方法：

/**
	 * 测试方法
	 *
	 * @param parentId
	 * @return
	 */
	@Override
	public PageModel findOrgList(int id) {

PageModel pageModel = null;

                String txtSQL =  "from Organization o where o.parent.id= ?";

                pageModel = searchPaginate(txtSQL, id);
		return pageModel;
	 }

至此，就更有点面向对象的意思了。编程中感觉别扭的时候，就该停下来想一想是不是自己太将就了。真正的程序员该干的活不是ctrl C 和 ctrl V，而是那些有思考的代码。