自定义MVC通用分页

思维导图 

一、后台分页：

1、加载驱动包：

根据MySQL的不同，所需加载的驱动包也不同；比如：有MySQL5.7和MySQL8

#oracle9i
#driver=oracle.jdbc.driver.OracleDriver
#url=jdbc:oracle:thin:@localhost:1521:ora9
#user=test
#pwd=test

#sql2005
#driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
#url=jdbc:sqlserver://localhost:1423;DatabaseName=test
#user=sa
#pwd=sa

#sql2000
#driver=com.microsoft.jdbc.sqlserver.SQLServerDriver
#url=jdbc:microsoft:sqlserver://localhost:1433;databaseName=unit6DB
#user=sa
#pwd=888888

#mysql5
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://127.0.0.1:3306/mybatis_ssm?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT&useSSL=true
user=root
pwd=123456

2、简单查询功能

 1、建立数据库连接
2、预定义对象PrepareStatement
3、查询结果集
4、处理结果集

public List<Book> list(Book book) throws Exception{
        List<Book> books=new ArrayList<Book>();
        String sql="select * from t_mvc_book where 1=1";
//        书籍名称
        String bname=book.getBname();
        if(StringUtils.isNotBlank(bname)) {
            sql+=" and bname like '%"+bname+"%'";
        }
        Connection con=DBAccess.getConnection();
        PreparedStatement pst=con.prepareStatement(sql);
        ResultSet rs=pst.executeQuery();
        while(rs.next()) {
            books.add(new Book(rs.getInt("bid"), rs.getString("bname"), rs.getFloat("price")));
        }
        return books;
    }

不足之处：

1、以上三步需要重复（建立数据库连接，2、预定义对象PrepareStatement，查询结果集）；
2、都是要返回数据库表对应的集合，集合中的对象都是不同的
3、都是要处理结果集ResultSet  rs
4、 代码不一样，具体体现在，不同表会有不同的字段，那么实体类对应的属性就会不一样

总结：需要写大量的重复代码，系统中的查询功能越多，重复代码量越大

 解决方案
1、抽取变量部分作为参数：sql、Class对象（book.class,article.class）
2、抽取公共的父类，把重复性的代码剥离出来

3、通用查询功能

3.1、BaseDao父类；把重复性的代码剥离出来与其他子类一起使用

package xly.com.dao;

import java.lang.reflect.Field;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.List;

import xly.com.entity.Book;
import xly.com.util.DBAccess;
import xly.com.util.StringUtils;

/**
 * Dao层（BookDao,UserDao）的父类
 * @author T440s
 *
 * @param <T>
 */
public class BaseDao<T> {
    public List<T> list(String sql,Class<T> clz) throws Exception{
//子类Dao继承BaseDao<T>,子类传递什么类.class,那么其list集合中放的就是什么
        List<T> list=new ArrayList<T>();
        Connection con=DBAccess.getConnection();
        PreparedStatement pst=con.prepareStatement(sql);
        ResultSet rs=pst.executeQuery();
        while(rs.next()) {
//            books.add(new Book(rs.getInt("bid"), rs.getString("bname"), rs.getFloat("price")));
            /**
             * 分析：
             * 1、实例化了一个对象
             * 2、从ResultSet的对象的属性获取值（bid）,赋值给了前面的实例化的对象
             * 3、把已经赋值了的对象，添加到list集合中
             */
//            Book book=new Book();
            T t = clz.newInstance();
//            2、从ResultSet的对象的属性获取值（bid）,赋值给了前面的实例化的对象
//            b.setBid(rs.getInt("bid"));
            Field[] fields = clz.getDeclaredFields();
            for (Field f : fields) {
                f.setAccessible(true);
                f.set(t, rs.getObject(f.getName()));
            }
//            3、把已经赋值了的对象，添加到list集合中
            list.add(t);
            
        }
        return list;
    }

}

 3.2、继承公共父类，代码减少：

public class BookDao extends BaseDao<Book>{
    public List<Book> list2(Book book) throws Exception{
        String sql="select * from t_mvc_book where 1=1";
//        书籍名称
        String bname=book.getBname();
//        书籍名称模糊查询 不死不灭最终是前台jsp页面传递过来的
        if(StringUtils.isNotBlank(bname)) {
            sql+=" and bname like '%"+bname+"%'";
        }
        return super.list(sql, Book.class);
    }
}

public class ActicleDao extends BaseDao<Acticle>{
    public List<Acticle> list(Acticle acticle) throws Exception{
        return super.list("select * from t_jsoup_article", Acticle.class);
    }
}

3.3、 实行代码：

public static void main(String[] args) throws Exception{
        BookDao bd=new BookDao();
        Book book=new Book();
        book.setBname("妖龙古帝");
//        List<Book> list=bd.list(book);
        List<Book> list=bd.list2(book);
        for(Book b:list) {
            System.out.println(b);
        }

 4、分页查询

目标:

想要做一个通用的分页查询，子类去继承父类，自带了分页功能，并且代码量极少；

最终当碰到分页的需求的时候，只要写少量代码。

分页通常有关键的因素：

第page页、显示数目（rows）、符合查询条件的总记录数（total）。

共N页的算法：total%rows==0？total/rows：total/rows+1；

1、MySQL分页

mysql分页是通过limit关键字，分页数据库sql格式：

总记录数查询：

select count(1) from (select * from t_mvc_book where bname like '%圣墟%')t

select * from 表名 limit 起始下标， 展示数目（rows）

原sql查询：sql=select * from t_mvc_book where like '%圣墟%'

分页sql:      pageSql=sql limit (page-1)*rows,rows

总记录数：countSql=select count(1) from (sql) t

2、编码思路 

原来list集合中返回的是符合条件的所有数据，现在需要发挥第page页的数据，那么就意味着sql要加工成pageSql；
需要分页，那么要求符合条件的总记录数，保存到PageBean中

父类分页：

//    通用分页查询
    /**
     * 是否需要分页：
        *无需分页（项目中的下拉框，查询条件教员下拉框）
        *必须分页（项目中列表类需求，订单列表、商品列表、学生列表……）
        * */
    public List<T> executeQuery(String sql,Class<T> clz,PageBean pageBean) throws Exception{
        List<T> list=new ArrayList<T>();
        Connection con=DBAccess.getConnection();
        PreparedStatement pst=con.prepareStatement(sql);
        ResultSet rs=pst.executeQuery();
        if(pageBean !=null&&pageBean.isPagination()) {
//            必须分页（列表需求）
            String countSQL=getCountSQL(sql);
            pst=con.prepareStatement(countSQL);
            rs=pst.executeQuery();
            if(rs.next()) {
            pageBean.setTotal(String.valueOf(rs.getObject(1)));
            }
//            最后才处理返回的结果集
            String pageSQL=getPageSQL(sql,pageBean);//符合条件的某一页数据
            pst=con.prepareStatement(pageSQL);
            rs=pst.executeQuery();
            
            
        }else {
//            不分页（select需求）
            pst=con.prepareStatement(sql);//符合条件的所有数据
            rs=pst.executeQuery();
            
        }
        while(rs.next()) {
            T t = clz.newInstance();
            Field[] fields = clz.getDeclaredFields();
            for (Field f : fields) {
                f.setAccessible(true);
                f.set(t, rs.getObject(f.getName()));
            }
            list.add(t);
            
        }
        return list;
    }
    
    /**
     * 将原生SQL转换成符合条件的总记录数CountSQL
     * @param sql
     * @return
     */
private String getCountSQL(String sql) {
    return "select count(1) from ("+sql+")t";
}

 

/**
 * 原生SQL转换成pageSQL
 * @param sql
 * @param pageBean
 * @return
 */
private String getPageSQL(String sql,PageBean pageBean) {
    // TODO Auto-generated method stub
    return sql +" limit  "+ pageBean.getStartIndex() +","+pageBean.getRows();
}

 调用方法：

public List<Book> list3(Book book,PageBean pageBean) throws Exception{
        String sql="select * from t_mvc_book where 1=1";
//        书籍名称
        String bname=book.getBname();
//        书籍名称模糊查询 不死不灭最终是前台jsp页面传递过来的
        if(StringUtils.isNotBlank(bname)) {
            sql+=" and bname like '%"+bname+"%'";
        }
        return super.executeQuery(sql, Book.class,pageBean);
    } 

执行：

public static void main(String[] args) throws Exception{
        BookDao bd=new BookDao();
        Book book=new Book();
        book.setBname("妖龙古帝");
//        List<Book> list=bd.list(book);
//        List<Book> list=bd.list2(book);
        PageBean pageBean=new PageBean();
//        查第二页的数据，模拟从jsp传递页码2到后台
//        pageBean.setPage(2);
//        项目开发中，下拉框的需求，不分页，模拟jsp传递不分页的信息pageination=false
        pageBean.setPagination(false);
        List<Book> list=bd.list3(book,pageBean);
        for(Book b:list) {
            System.out.println(b);
        }
    } 

二、通用前台分页

分析：

1、前台分页，后一次请求相较于上一次，只不过是页码改变了
         1、1需要保存上一次请求的URL
         1、2需要保存上一次请求的参数  bname、price
         1、3需要保存上一次请求的分页设置  pagination
         1、4需要保存上一次请求的展示条目数
         1、5初始化请求的页码page

PageBean类:

package xly.com.util;

import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

/**
 * 分页工具类
 *
 */
public class PageBean {
    private int page = 1;// 页码

    private int rows = 10;// 页大小

    private int total = 0;// 总记录数

    private boolean pagination = true;// 是否分页
    
    private String url;//保存上一次请求的url
    
    private Map<String, String[]> paraMap=new HashMap<>();//保存上一次请求的数组
    
    /**
     * 初始化pagebean的，保存上一次请求的重要参数
     * @param req
     */
    public void setRequest(HttpServletRequest req) {
//        1、1需要保存上一次请求的URL
        this.setUrl(req.getRequestURI().toString());
//        1、2需要保存上一次请求的参数  bname、price
        this.setParaMap(req.getParameterMap());
//         1、3需要保存上一次请求的分页设置  pagination
        this.setPagination(req.getParameter("pagination"));
//        1、4需要保存上一次请求的展示条目数
        this.setRows(req.getParameter("rows"));
//        1、5初始化请求的页码page
        this.setPage(req.getParameter("page"));
    }

    
    public void setPage(String page) {
        if(StringUtils.isNotBlank(page)) {
            this.setPage(Integer.valueOf(page));
        }
    }


    public void setRows(String rows) {
        if(StringUtils.isNotBlank(rows)) {
            this.setRows(Integer.valueOf(rows));
        }
    }


    public void setPagination(String pagination) {
//        只有前台jsp填写了pagination=false，才代表不分页
        if(StringUtils.isNotBlank(pagination)) {
            this.setPagination(!"false".equals(pagination));
        }
        
    }


    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }


    public Map<String, String[]> getParaMap() {
        return paraMap;
    }


    public void setParaMap(Map<String, String[]> paraMap) {
        this.paraMap = paraMap;
    }


    public PageBean() {
        super();
    }

    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 void setTotal(String total) {
        this.total = Integer.parseInt(total);
    }

    public boolean isPagination() {
        return pagination;
    }

    public void setPagination(boolean pagination) {
        this.pagination = pagination;
    }

    /**
     * 获得起始记录的下标
     * 
     * @return
     */
    public int getStartIndex() {
        return (this.page - 1) * this.rows;
    }
//    最大页
    public int maxPage() {
        return this.total%this.rows==0?this.total/this.rows:this.total/this.rows+1;
        
    }
//    下一页
    public int nextPage() {
//        如果当前页小于最大页，那就下一页为当前页+1，如果不小于，说明当前页就是最大页，那就无需+1
        return this.page<this.maxPage()?this.page+1:this.page;
        
    }
    
//    上一页
    public int previousPage() {
//        如果当前页小于最大页，那就下一页为当前页+1，如果不小于，说明当前页就是最大页，那就无需+1
        return this.page>1?this.page-1:this.page;
        
    }
    
    @Override
    public String toString() {
        return "PageBean [page=" + page + ", rows=" + rows + ", total=" + total + ", pagination=" + pagination + "]";
    }

}

 2、自定义jsp标签（page标签）

     定义pagebean,因为pagebean中包含了分页中所有的元素               （page/rows/pagination/total/nextPage/previousPage/maxPage）

tag文件：

package com.lxy.tag;

import java.io.IOException;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.tagext.BodyTagSupport;

import com.sun.org.apache.xml.internal.serializer.ToHTMLSAXHandler;

import xly.com.util.PageBean;

public class PageTag extends BodyTagSupport{
    private PageBean pageBean;//包含了所有分页相关的元素
    
    
    public PageBean getPageBean() {
        return pageBean;
    }

    public void setPageBean(PageBean pageBean) {
        this.pageBean = pageBean;
    }

    @Override
    public int doStartTag() throws JspException {
//        没有标签体，要输出内容
        JspWriter out=pageContext.getOut();
        try {
            out.print(toHTML());
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return super.doStartTag();
    }

    private String toHTML() {
        StringBuffer sb=new StringBuffer();
//        隐藏的form表单——这个就是上一次请求下次重新发的奥义所在
        sb.append("<form action='"+pageBean.getUrl()+"' id='pageBeanForm' method='post'>");
        sb.append("  <input type='hidden' name='page'>");
        Map<String, String[]> paraMap = pageBean.getParaMap();
        if(paraMap!=null&&paraMap.size()>0) {
            Set<Entry<String, String[]>> entrySet = paraMap.entrySet();
            for (Entry<String, String[]> entry : entrySet) {
//                参数名
                String key=entry.getKey();
//                参数值
                for (String value : entry.getValue()) {
//                    上一次请求的参数，再一次组装成了新的form表单
//                    注意：page参数每次都会提交，我们需要避免
                    if(!"page".equals(key)) {
                    sb.append("    <input type='hidden' name='"+key+"' value='"+value+"'>");
                    }
                    }
                
            }
        }
        sb.append("</form>");
        
//        分页条
        sb.append("<ul class='pagination justify-content-center'>");
        sb.append(" <li class='page-item "+(pageBean.getPage()==1?"disabled":"")+"'><a class='page-link'");
        sb.append("  href='javascript:gotoPage(1)'>首页</a></li>");
        sb.append(" <li class='page-item "+(pageBean.getPage()==1?"disabled":"")+"'><a class='page-link'");
        sb.append(" href='javascript:gotoPage("+pageBean.previousPage()+")'>&lt;</a></li>");//less than 小于号
//        sb.append(" <li class='page-item'><a class='page-link' href='#'>1</a></li>");
//        sb.append(" <li class='page-item'><a class='page-link' href='#'>2</a></li>");
        sb.append(" <li class='page-item active'><a class='page-link' href='#'>"+pageBean.getPage()+"</a></li>");
        sb.append(" <li class='page-item "+(pageBean.getPage()==pageBean.maxPage()?"disabled":"")+"'><a class='page-link' href='javascript:gotoPage("+pageBean.nextPage()+")'>&gt;</a></li>");
        sb.append(" <li class='page-item "+(pageBean.getPage()==pageBean.maxPage()?"disabled":"")+"'><a class='page-link' href='javascript:gotoPage("+pageBean.maxPage()+")'>尾页</a></li>");
        sb.append(" <li class='page-item go-input'><b>到第</b><input class='page-link'");
        sb.append(" type='text' id='skipPage' name='' /><b>页</b></li>");
        sb.append(" <li class='page-item go'><a class='page-link'");
        sb.append(" href='javascript:skipPage()'>确定</a></li>");
        sb.append(" <li class='page-item'><b>共"+pageBean.getTotal()+"条</b></li>");
        sb.append("</ul>");
        
        
//        分页执行的js代码
        sb.append("<script type='text/javascript'>");
        sb.append(" function gotoPage(page) {");
        sb.append("     document.getElementById('pageBeanForm').page.value = page;");
        sb.append("     document.getElementById('pageBeanForm').submit();");
        sb.append(" }");
        sb.append(" function skipPage() {");
        sb.append("     var page = document.getElementById('skipPage').value;");
        sb.append("         if (!page || isNaN(page) || parseInt(page) < 1|| parseInt(page) > "+pageBean.maxPage()+") {");
        sb.append("             alert('请输入1~"+pageBean.maxPage()+"的数字');");
        sb.append("                 return;");
        sb.append("        }");
        sb.append("     gotoPage(page);");
        sb.append("     }");
        sb.append(" </script>");
        return sb.toString();
    }

}

 

tld文件：

   <tag>
    <name>page</name>
    <tag-class>com.lv.tag.PageTag</tag-class>
    <body-content>JSP</body-content>
    <attribute>
        <name>pageBean</name>
        <required>true</required>
        <rtexprvalue>true</rtexprvalue>
    </attribute> 
  </tag>

 

index主界面：

<%@ page language='java' contentType='text/html; charset=UTF-8'
    pageEncoding='UTF-8'%>
    <%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
    <%@ taglib prefix="z" uri="http://jsp.veryedu.cn"%>
<!DOCTYPE html PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN' 'http://www.w3.org/TR/html4/loose.dtd'>
<html>
<head>
<meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>
<link
    href='https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/4.5.0/css/bootstrap.css'
    rel='stylesheet'>
<script
    src='https://cdn.bootcdn.net/ajax/libs/twitter-bootstrap/4.5.0/js/bootstrap.js'></script>
<title>书籍列表</title>
<style type='text/css'>
.page-item input {
    padding: 0;
    width: 40px;
    height: 100%;
    text-align: center;
    margin: 0 6px;
}

.page-item input, .page-item b {
    line-height: 38px;
    float: left;
    font-weight: 400;
}

.page-item.go-input {
    margin: 0 10px;
}
</style>
</head>
<body>
    <form class='form-inline'
        action='${pageContext.request.contextPath }/book/search' method='post'>
        <div class='form-group mb-2'>
            <input type='text' class='form-control-plaintext' name='bname'
                placeholder='请输入书籍名称'>
                <!-- 不分页 -->
            <!--     <input name="rows" value="false" type="hidden"> -->
        </div>
        <button type='submit' class='btn btn-primary mb-2'>查询</button>
    </form>

    <table class='table table-striped bg-success'>
        <thead>
            <tr>
                <th scope='col'>书籍ID</th>
                <th scope='col'>书籍名</th>
                <th scope='col'>价格</th>
            </tr>
        </thead>
        <tbody>
        <c:forEach var="b" items="${books }">
        <tr>
                <td>${b.bid }</td>
                <td>${b.bname }</td>
                <td>${b.price }</td>
            </tr>
        </c:forEach>
            

        </tbody>
    </table>
    <!-- 这一行就相当于前面分页需求前端的几十行了 -->
    <z:page pageBean="${pageBean }"></z:page>
    
</body>
</html>

最终查询：

BookDao bookDao=new BookDao();
        Book book=new Book();
        book.setBname(request.getParameter("bname"));
        PageBean pageBean=new PageBean();
        pageBean.setRequest(request);
        try {
            List<Book> list3 = bookDao.list3(book, pageBean);
            request.setAttribute("books", list3);
            request.setAttribute("pageBean", pageBean);
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        
        request.getRequestDispatcher("/index.jsp").forward(request, response);

查询乱码处理对EncodingFiter进行添加下面代码

@WebFilter("/book/*")