通用分页（分页代码的封装）

本期的数据库使用的是mysql，那么该如何实现分页效果呢？

---

目录

功能特点

PageBean类的代码编写

封装分页功能

流程图

DBUtil

封装前的分页代码

重构-提取公用部分（分页代码的封装）

---

功能特点：

为了提高查询性能及节约网络流量，每次只查询指定的记录数，而不是全部，在数据量比较大时很有用

 当点击下一页或指定页面的数据时，将带着所有的查询条件，再次执行查询

PageBean类的代码编写：

首先编写分页信息实体（PageBean类）

该类用于存储和传递分页参数，主要内容如下：

页码：从页面传递过来

每页行数，从页面传递过来

总记录数，从数据库中统计得到

是否分页，如果为false，则查询所有记录

查询参数，点击上一页或者下一页时需要及携带用户输入的所有查询参数

另外提供上页，下页，总页数等计算

 

public class PageBean {	
	// 页码	 
	private int page = 1;
 
	//每页显示的记录数
	private int rows = 10;
 
	// 总记录数
	private int total = 0;
 
	//是否分页
	private boolean pagination = true;
	
	// 记录查询的url，以便于点击分页时再次使用
	private String url;
	
	//存放请求参数，用于生成隐藏域中的元素
	private Map parameterMap;
	
	/**
	 * 根据传入的Request初始化分页对象
	 * @param request
	 */
	public void setRequest(HttpServletRequest request) {
		
		if(!StringUtils.isNullOrEmpty(request.getParameter("page"))) {
			this.page = Integer.valueOf(request.getParameter("page"));
		}
		if(!StringUtils.isNullOrEmpty(request.getParameter("rows"))) {
			this.rows = Integer.valueOf(request.getParameter("rows"));
		}
		if(!StringUtils.isNullOrEmpty(request.getParameter("pagination"))) {
			this.pagination = Boolean.valueOf(request.getParameter("pagination"));
		}
		
		this.url = request.getRequestURI();
		this.parameterMap = request.getParameterMap();
		
		request.setAttribute("pageBean", this);
	}
 
	public int getPage() {
		return page;
	}
	public void setPage(int page) {
		this.page = page;
	}
	public int getRows() {
		return rows;
	}
	public void setRows(int rows) {
		this.rows = rows;
	}
 
	public int getTotal() {
		return total;
	}
	public void setTotal(int total) {
		this.total = total;
	}
	public boolean isPagination() {
		return pagination;
	}
	public void setPagination(boolean pagination) {
		this.pagination = pagination;
	}	
	public String getUrl() {
		return url;
	}
	public void setUrl(String url) {
		this.url = url;
	}
	public Map getParameterMap() {
		return parameterMap;
	}
	public void setParameterMap(Map parameterMap) {
		this.parameterMap = parameterMap;
	}
 
	//计算起始页码
	public int getStartIndex() {
		return (this.page - 1) * this.rows;
	}	
	//获取总页数
	public int getTotalPage() {
		if (this.getTotal() % this.rows == 0) {
			return this.getTotal() / this.rows;
		} else {
			return this.getTotal() / this.rows + 1;//102%10=2,增加一页放
		}
	}
	//上一页
	public int getPreviousPage() {
		return this.page - 1 > 0 ? this.page - 1 : 1;
	}
	//下一页
	public int getNextPage() {
		return this.page + 1 > getTotalPage() ? getTotalPage() : this.page + 1;
	}
}

封装分页功能：

流程图

tip：在编写后台代码之前，可以先画一个流程图，来理清分页功能的业务逻辑。

1.查询满足条件的总记录数

2.查询满足条件的当前页的数据

3.上两个步骤的查询条件要一致

 

DBUtil

1.为简化数据库操作，新建一个DBUtil工具类

public class DBUtil {
	private static String DRIVER_NAME = "com.mysql.jdbc.Driver";
	private static String DB_URL = "jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false";
	private static String DB_USER = "root";
	private static String DB_PASSWORD = "123456";
 
	private DBUtil() {
	}
 
	static {
		try {
			Class.forName(DRIVER_NAME);
 
		} catch (ClassNotFoundException e) {
			e.printStackTrace();
		}
	}
 
	public static Connection getConection() throws SQLException {
		Connection connection = DriverManager.getConnection(DB_URL, DB_USER, DB_PASSWORD);
		return connection;
	}
 
	public static void closeDB(ResultSet rs, Statement ps, Connection con) {
		try {
			if (rs != null && !rs.isClosed()) {
				rs.close();
			}
			if (ps != null && !ps.isClosed()) {
				ps.close();
			}
			if (con != null && !con.isClosed()) {
				con.close();
			}
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}
 
	public static void closeDB(ResultSet rs, Statement ps) {
		try {
			if (rs != null && !rs.isClosed()) {
				rs.close();
			}
			if (ps != null && !ps.isClosed()) {
				ps.close();
			}
		} catch (SQLException e) {
			e.printStackTrace();
		}
	}
}

2.学生实体类（根据数据库中字段创建）

public class Student {
	private Integer sid;	
	private String sname;	
	private Double score;	
	private String clazz;
	public Integer getSid() {
		return sid;
	}
	public void setSid(Integer sid) {
		this.sid = sid;
	}
	public String getSname() {
		return sname;
	}
	public void setSname(String sname) {
		this.sname = sname;
	}
	public Double getScore() {
		return score;
	}
	public void setScore(Double score) {
		this.score = score;
	}
	public String getClazz() {
		return clazz;
	}
	public void setClazz(String clazz) {
		this.clazz = clazz;
	}
	@Override
	public String toString() {
		return "Student [sid=" + sid + ", sname=" + sname + ", score=" + score + ", clazz=" + clazz + "]";
	}
}

封装前的分页代码

3.实体将学生数据分页的代码（未封装）

public class StudentDao {
    public List getStudents(String sname, PageBean pageBean) {
		String sql = "select * from t_student t ";
		if (!Objects.isNull(sname) && sname.length() > 0) {
			sql += " where t.sname like ?";
		}
		List students = new ArrayList<>();
		Connection con = null;
		PreparedStatement ps = null;
		ResultSet rs = null;		
		/*
		 * 如果不需要分页，则直接查询查询，并返回查询结果。
		 */
		if (pageBean == null || !pageBean.isPagination()) {
			//3. 
			try {
				con = DBUtil.getConection();
				ps = con.prepareStatement(sql);			
				//设置查询参数
				if(sname != null) {
					ps.setObject(1, sname+"%");
				}				
				rs = ps.executeQuery();				
				//1. 差异化部分
				while(rs.next()) {
					Student stu = new Student();
					stu.setSid(rs.getInt("sid"));
					stu.setSname(rs.getString("sname"));
					stu.setAge(rs.getInt("age"));
					stu.setRemark(rs.getString("remark"));
					students.add(stu);
				}
			} catch (Exception e) {
				e.printStackTrace();
				//2.
			} finally  {
				DBUtil.closeDB(rs, ps, con);
			}			
		return students;			
		} else {			
			/*
			 * 如果需要分页，则分两步操作：
			 * 1. 查询总记录数
			 * 2. 查询当前页记录
			 */			
			//1. 生成统计总记录数的SQL， 查询总记录数
			try {
				String countSql = "select count(*) from (" + sql + ") tmp";
				con = DBUtil.getConection();			
				ps = con.prepareStatement(countSql);			
				//设置查询参数
				if(sname != null) {
					ps.setObject(1, sname+"%");
				}			
				rs = ps.executeQuery();			
				while(rs.next()) {
					pageBean.setTotal(rs.getInt(1));
				}
				/*
				 * 如果统计的总记录数为0，则表示没有符合条件的记录，直接返回一个空结果集即可。
				 */
				if(pageBean.getTotal() == 0) {
					return students;
				}				
			} catch (Exception e) {
				e.printStackTrace();
			} finally {
				DBUtil.closeDB(rs, ps);
			}			
			/*
			 * 生成分页sql，查询当前页的数据
			 */
			try {
				String pagingSql = sql + " limit " + pageBean.getStartRow() + ", " + pageBean.getRows();
				ps = con.prepareStatement(pagingSql);
				
				//设置查询参数
				if(sname != null) {
					ps.setObject(1, sname+"%");
				}
				rs = ps.executeQuery();			
		    	//差异化
				while(rs.next()) {
					Student stu = new Student();
					stu.setSid(rs.getInt("sid"));
					stu.setSname(rs.getString("sname"));
					stu.setAge(rs.getInt("age"));
					stu.setRemark(rs.getString("remark"));
					students.add(stu);
				}
			} catch (Exception  e) {
				e.printStackTrace();
			} finally {
				DBUtil.closeDB(rs, ps, con);
			}
			    return students;
		}
	}	
    //测试
	public static void main(String[] args) {
		StudentDao dao = new StudentDao();
		List students = dao.getStudents("张", new PageBean());		
		students.forEach(s -> System.out.println(s));
	}
}

通过观察上述学生数据分页功能的代码实现，可以从中提取不会改变的代码逻辑，封装成一个分页功能类，这样在各种不同数据对象需要分页时直接调用BaseDao类即可

重构-提取公用部分（分页代码的封装）

为了进行公共方法的抽取，需要找出上面实习中的可通用部分，和差异化部分

• 只要是分页，就会统计总记录数，而总记录数的统计是在业务sql外封装了一个select count(*)是有规律可循的，可以通用
• 只要是分页，则封装分页sql也是有规律可循的（在业务sql后加limit子句即可），可以通用
• 因为每个查询对应的业务实体（即模型）不同，所以ORM映射部分不能通用

公用方法封装思路

• 将可通用的部分封装到模板中

• 差异化部分（即不可通用部分），可以定义一个处理接口，以便于通过参数传入个性化的实现部分

具体实现：

通用分页查询模板类BaseDao（已封装）

public final class BaseDao {
	
	private BaseDao() {}
	
	//回调函数接口
	public static interface ICovent {
		List convent(ResultSet rs) throws SQLException;
	}
	
	public static  List query(String sql, 
			Object[] params, 
			PageBean pageBean,
			ICovent covent
			) {
		
		List students = new ArrayList<>();
		
		Connection con = null;
		PreparedStatement ps = null;
		ResultSet rs = null;
		
		if(pageBean == null || !pageBean.isPagination()) {
			try {
				con = DBUtil.getConection();
				ps = con.prepareStatement(sql);
				
				//设置查询参数
				int i = 1;
				for(Object param: params) {
					ps.setObject(i, param);
					i++;
				}			
				rs = ps.executeQuery();
				//通过使用者传入的回调函数，执行转换
				students = covent.convent(rs);				
			} catch (SQLException e) {
				e.printStackTrace();
			} finally {
				DBUtil.closeDB(rs, ps, con);
			}
		} else {
			//需要分页的情况
			String countSql = "select COUNT(*) from (" + sql + ") tmp";
			try {
				con = DBUtil.getConection();
				ps = con.prepareStatement(countSql);
				//设置查询参数
				int i = 1;
				for(Object param: params) {
					ps.setObject(i, param);
					i++;
				}
				
				rs = ps.executeQuery();
				if(rs.next()) {
					Integer total = rs.getInt(1);
					pageBean.setTotal(total);
				}
				
				//判断总记录数是否大于0，如果大于零表示有记录，需求查询当前记录
				//如果没有就直接返回
				if(pageBean.getTotal() <= 0) {
					return students;
				}
				
				//查询当前业的数据
				String pagingSql = sql + " limit " + pageBean.getStartIndex() + ", " + pageBean.getRows();
				ps = con.prepareStatement(pagingSql);
				//设置查询参数
				int j = 1;
				for(Object param: params) {
					ps.setObject(i, param);
					j++;
				}
				rs = ps.executeQuery();			
				//变化部分
				students = covent.convent(rs);				
			} catch (SQLException e) {
				e.printStackTrace();
			}  finally {
				DBUtil.closeDB(rs, ps, con);
			}
		}	
		return students;
	}
}

调用测试：

public class StudentDao {
	public List<Student> getStudents(String sname, PageBean pageBean) {
		//构造sql语句    变化部分
		String sql = "select * from t_student t ";
		List<Object> param = new ArrayList<>();
		if (!Objects.isNull(sname) && sname.length() > 0) {
			sql += " where t.sname like ?";
			param.add(sname);
		}
		List<Student> list = BaseDao.query(sql, param.toArray(), pageBean, new ICovent<Student>() {
			@Override
			public List<Student> convent(ResultSet rs) throws SQLException {
				List<Student> students = new ArrayList<>();
				while(rs.next()) {
					Student stu = new Student();
					stu.setSid(rs.getInt("sid"));
					stu.setSname(rs.getString("sname"));
					stu.setClazz(rs.getString("class"));
					students.add(stu);
				}
				return students;
			}
		});
		return list;
	}
	
	public static void main(String[] args) {
		StudentDao dao = new StudentDao();
		List<Student> students = dao.getStudents(null, new PageBean());
		students.forEach(t-> System.out.println(t));
	}
}

 

---

 感谢收看~