Spring+Mybatis+SpringMVC后台与前台分页展示实例（附工程）（转）

Posted 2020-06-22 沧海一滴

   林炳文Evankaka原创作品。转载请注明出处http://blog.csdn.net/evankaka

       摘要：本文实现了一个后台由Spring+Mybatis+SpringMVC组成，分页采用PageHelper，前台展示使用bootstrap-paginator来显示效果的分页实例。整个项目由maven构成。这里主要讲了分页的实例，框架怎么搭建就不再说明，主要是在这里的基础上来增加分页功能的。注意，此文是在这个基础 Spring+Mybatis+SpringMVC+Maven+MySql搭建实例 之上来做分页的，建议文中看不懂的配置可以看看这里。

整个工程下载

最后的结果如下：

环境：jdk1.6

         Tomcat 7.0

         Eclipse luna/windows 7    

一、后台PageHelper使用

PageHelper:https://github.com/pagehelper/Mybatis-PageHelper

1、引入jar包

 

[html] view plain copy

 

1. <!-- 添加分布插件的包pagehelper -->  
2. <dependency>  
3.     <groupId>com.github.pagehelper</groupId>  
4.     <artifactId>pagehelper</artifactId>  
5.     <version>4.0.0</version>  
6. </dependency>  

2.mybatis-config.xml中添加插件

 

 

[html] view plain copy

 

1. <plugins>  
2.     <!-- com.github.pagehelper为PageHelper类所在包名 -->  
3.     <plugin interceptor="com.github.pagehelper.PageHelper">  
4.         <property name="dialect" value="mysql"/>  
5.         <!-- 该参数默认为false -->  
6.         <!-- 设置为true时，会将RowBounds第一个参数offset当成pageNum页码使用 -->  
7.         <!-- 和startPage中的pageNum效果一样-->  
8.         <property name="offsetAsPageNum" value="true"/>  
9.         <!-- 该参数默认为false -->  
10.         <!-- 设置为true时，使用RowBounds分页会进行count查询 -->  
11.         <property name="rowBoundsWithCount" value="true"/>  
12.         <!-- 设置为true时，如果pageSize=0或者RowBounds.limit = 0就会查询出全部的结果 -->  
13.         <!-- （相当于没有执行分页查询，但是返回结果仍然是Page类型）-->  
14.         <property name="pageSizeZero" value="true"/>  
15.         <!-- 3.3.0版本可用 - 分页参数合理化，默认false禁用 -->  
16.         <!-- 启用合理化时，如果pageNum<1会查询第一页，如果pageNum>pages会查询最后一页 -->  
17.         <!-- 禁用合理化时，如果pageNum<1或pageNum>pages会返回空数据 -->  
18.         <property name="reasonable" value="false"/>  
19.         <!-- 3.5.0版本可用 - 为了支持startPage(Object params)方法 -->  
20.         <!-- 增加了一个`params`参数来配置参数映射，用于从Map或ServletRequest中取值 -->  
21.         <!-- 可以配置pageNum,pageSize,count,pageSizeZero,reasonable,不配置映射的用默认值 -->  
22.         <!-- 不理解该含义的前提下，不要随便复制该配置 -->  
23.         <property name="params" value="pageNum=start;pageSize=limit;"/>  
24.     </plugin>  
25. </plugins>  

这样子就引入进来了，接下来就是来开始分页功能的实现

 

3、mapper文件中添加如下一个方法：

 

[html] view plain copy

 

1. <select id="selectUserByUserName" parameterType="java.lang.String" resultMap="BaseResultMap">  
2.     SELECT *  
3.     FROM t_user  
4.     WHERE 1 = 1  
5.     <if test="userName != null and userName !=‘‘">  
6.         AND USER_NAME = #{userName,jdbcType=VARCHAR}  
7.     </if>  
8.     ORDER BY USER_ID  
9. </select>  

注意，这里的返回其实是一个list

[html] view plain copy

 

1. <!--设置domain类和数据库中表的字段一一对应，注意数据库字段和domain类中的字段名称不致，此处一定要！ -->  
2. <resultMap id="BaseResultMap" type="com.lin.domain.User">  
3.     <id column="USER_ID" property="userId" jdbcType="INTEGER" />  
4.     <result column="USER_NAME" property="userName" jdbcType="CHAR" />  
5.     <result column="USER_PASSWORD" property="userPassword" jdbcType="CHAR" />  
6.     <result column="USER_EMAIL" property="userEmail" jdbcType="CHAR" />  
7. </resultMap>  

4、然后就是dao类

 

 

[html] view plain copy

 

1. /**  
2.  *   
3.  * @author linbingwen  
4.  * @since  2015年10月22日   
5.  * @param userName  
6.  * @return  
7.  */  
8. List<User> selectUserByUserName(@Param("userName") String userName);  

这里一定的记得加@Param("userName")

 

接下来就可以在service层中添加分页查询的的接口了

5、接口类

 

[html] view plain copy

 

1. /**  
2.  *   
3.  * @author linbingwen  
4.  * @since  2015年10月23日   
5.  * @param userName 查询条件，可为空  
6.  * @param pageNo 查询条件，可为空，默认取1  
7.  * @param pageSize 查询条件，可为空，默认取10  
8.  * @return  
9.  */  
10. PagedResult<User> queryByPage(String userName,Integer pageNo,Integer pageSize);  

6、实现类

 

 

[html] view plain copy

 

1. public PagedResult<User> queryByPage(String userName,Integer pageNo,Integer pageSize ) {  
2.     pageNo = pageNo == null?1:pageNo;  
3.     pageSize = pageSize == null?10:pageSize;  
4.     PageHelper.startPage(pageNo,pageSize);  //startPage是告诉拦截器说我要开始分页了。分页参数是这两个。  
5.     return BeanUtil.toPagedResult(userDao.selectUserByUserName(userName));  
6. }  

这里就可以直接在返回里头使用了PageHelper，这里userDao.selectUserByUserName(userName)的返回是一个list

 

其中，PagedResult是我自己封装的一个分页结果类

 

[java] view plain copy

 

1. package com.lin.util;  
2.   
3. import java.util.List;  
4.   
5. import com.lin.dto.BaseEntity;  
6.   
7. /** 
8.  * 功能概要： 
9.  *  
10.  * @author linbingwen 
11.  * @since  2015年10月23日  
12.  */  
13. public class PagedResult<T> extends BaseEntity {  
14.       
15.     /*serialVersionUID*/  
16.     private static final long serialVersionUID = 1L;  
17.   
18.     private List<T> dataList;//数据  
19.       
20.     private long pageNo;//当前页  
21.       
22.     private long pageSize;//条数  
23.       
24.     private long total;//总条数  
25.       
26.     private long pages;//总页面数目  
27.   
28.     public List<T> getDataList() {  
29.         return dataList;  
30.     }  
31.   
32.     public void setDataList(List<T> dataList) {  
33.         this.dataList = dataList;  
34.     }  
35.   
36.     public long getPageNo() {  
37.         return pageNo;  
38.     }  
39.   
40.     public void setPageNo(long pageNo) {  
41.         this.pageNo = pageNo;  
42.     }  
43.   
44.     public long getPageSize() {  
45.         return pageSize;  
46.     }  
47.   
48.     public void setPageSize(long pageSize) {  
49.         this.pageSize = pageSize;  
50.     }  
51.   
52.     public long getTotal() {  
53.         return total;  
54.     }  
55.   
56.     public void setTotal(long total) {  
57.         this.total = total;  
58.     }  
59.   
60.     public long getPages() {  
61.         return pages;  
62.     }  
63.   
64.     public void setPages(long pages) {  
65.         this.pages = pages;  
66.     }  
67.       
68. }  

这是它的基类

 

 

[html] view plain copy

 

1. package com.lin.dto;  
2.   
3. import java.io.Serializable;  
4. import java.lang.reflect.Method;  
5. import java.lang.reflect.Modifier;  
6. import java.util.ArrayList;  
7. import java.util.HashMap;  
8. import java.util.List;  
9. import java.util.Map;  
10.   
11. /**  
12.  *   
13.  * <b>类说明：</b>bean基类  
14.  *   
15.  * <p>  
16.  * <b>详细描述：</b>  
17.  *   
18.  * @author costin_law   
19.  * @since 2014-5-5  
20.  */  
21. public abstract class BaseEntity implements Serializable{  
22.     private static final long serialVersionUID = 1L;  
23.       
24.     private static Map<Class<?>,PropertyInfo[]> class2Props = new HashMap<Class<?>,PropertyInfo[]>(128);  
25.       
26.     @Override  
27.     public String toString() {  
28.         PropertyInfo[] props = class2Props.get(this.getClass());  
29.         if( props == null ){  
30.             props = getProps(this.getClass());  
31.         }  
32.           
33.         StringBuilder   builder = new StringBuilder(1024);  
34.         boolean isFirst = true;  
35.         for (int i = 0, n = props.length; i < n; i++) {  
36.             try {  
37.                 PropertyInfo propInfo = props[i];                 
38.                   
39.                 Object value = propInfo.getMethod.invoke(this, new Object[0]);  
40.                 if (isFirst)  
41.                     isFirst = false;  
42.                 else  
43.                     builder.append(",");  
44.                 builder.append(propInfo.propName);  
45.                 builder.append(":");  
46.                 if (value instanceof String)  
47.                     builder.append("\"");  
48.                 builder.append(value);  
49.                 if (value instanceof String)  
50.                     builder.append("\"");                 
51.             } catch (Exception e) {  
52.                 // ignore  
53.             }  
54.         }  
55.         return "{" + builder.toString() + "}";  
56.     }  
57.   
58.     private static PropertyInfo[] getProps(Class<? extends BaseEntity> clazz) {  
59.         PropertyInfo[] props;  
60.         Method[] allMethods = clazz.getMethods();   
61.         List<PropertyInfo> propList = new ArrayList<PropertyInfo>();  
62.           
63.         for (int i = 0, n = allMethods.length; i < n; i++) {  
64.             try {  
65.                 Method method = allMethods[i];  
66.                 if ((method.getModifiers() & Modifier.PUBLIC) == 1  
67.                         && method.getDeclaringClass() != Object.class  
68.                         && (method.getParameterTypes() == null || method  
69.                                 .getParameterTypes().length == 0)) {  
70.                     String methodName = method.getName();  
71.                     if (methodName.startsWith("get") || methodName.startsWith("is") ) {  
72.                         PropertyInfo propInfo = new PropertyInfo();                                       
73.                         propInfo.getMethod = method;  
74.                         if (methodName.startsWith("get")) {  
75.                             propInfo.propName = methodName.substring(3, 4).toLowerCase()  
76.                                     + methodName.substring(4);  
77.                         } else if (methodName.startsWith("is")) {  
78.                             propInfo.propName = methodName.substring(2, 3).toLowerCase()  
79.                                     + methodName.substring(3);  
80.                         }                 
81.                         propList.add(propInfo);  
82.                     }  
83.                 }                     
84.             }catch(Exception e){                      
85.             }  
86.         }  
87.           
88.         props =  new PropertyInfo[propList.size()];  
89.         propList.toArray(props);  
90.         class2Props.put(clazz, props);  
91.         return props;  
92.     }  
93.       
94.     static class PropertyInfo{  
95.         Method getMethod;  
96.         String propName;          
97.     }  
98.   
99. }  

BeanUtil是一个将PageHelper返回的list转成pageResult的工具

[html] view plain copy

 

1. package com.lin.util;  
2.   
3. import java.util.List;  
4.   
5. import com.github.pagehelper.Page;  
6. import com.lin.util.PagedResult;  
7.   
8. /**  
9.  * 功能概要：  
10.  *   
11.  * @author linbingwen  
12.  * @since  2015年10月22日   
13.  */  
14.   
15.   
16. public class BeanUtil {  
17.   
18.     public static <T> PagedResult<T> toPagedResult(List<T> datas) {  
19.         PagedResult<T> result = new PagedResult<T>();  
20.         if (datas instanceof Page) {  
21.             Page page = (Page) datas;  
22.             result.setPageNo(page.getPageNum());  
23.             result.setPageSize(page.getPageSize());  
24.             result.setDataList(page.getResult());  
25.             result.setTotal(page.getTotal());  
26.             result.setPages(page.getPages());  
27.         }  
28.         else {  
29.             result.setPageNo(1);  
30.             result.setPageSize(datas.size());  
31.             result.setDataList(datas);  
32.             result.setTotal(datas.size());  
33.         }  
34.   
35.         return result;  
36.     }  
37.   
38. }  

7、这样就好了，可以跑单元测试了

 

 

[java] view plain copy

 

1. /** 
2.  * 分页测试 
3.  * @author linbingwen 
4.  * @since  2015年10月22日 
5.  */  
6. @Test  
7. public void queryByPage(){  
8.      PagedResult<User>  pagedResult = userService.queryByPage(null,1,10);//null表示查全部    
9.      logger.debug("查找结果" + pagedResult);  
10. }  

输出结果：

 

看不清的话看下面

查找结果{total:46,dataList:Page{pageNum=1, pageSize=10, startRow=0, endRow=10, total=46, pages=5, reasonable=false,

 pageSizeZero=true},pageNo:1,pageSize:10,pages:5}

其中的dataList中存放的就是数据

打个断点看下就知道了：

 

 

二、前台展示分页结果

         前台展示主要使用了bootstrap-paginator，这里的原理其实就是将上面查出来的结果，转换成json数据传给前台，然后前台再根据条数和分页数目、总目生成表格，同时每次点击对应的按钮都发送一个ajax请求到后台查询应对的数据，前台每次发送到后台都会包含分页数目、查询条件

1、Controller层的基类

这个基类主要实现了将数据转成json

引用到的jar包如下：

 

[html] view plain copy

 

1. <!-- 添加json的依赖包 -->  
2.         <dependency>  
3.             <groupId>net.sf.json-lib</groupId>  
4.             <artifactId>json-lib</artifactId>  
5.             <version>2.3</version>  
6.             <classifier>jdk15</classifier>  
7.         </dependency>  
8.   
9.         <dependency>  
10.             <groupId>org.springframework.data</groupId>  
11.             <artifactId>spring-data-commons</artifactId>  
12.             <version>1.6.1.RELEASE</version>  
13.         </dependency>  
14.   
15.         <dependency>  
16.             <groupId>org.springframework.data</groupId>  
17.             <artifactId>spring-data-jpa</artifactId>  
18.             <version>1.4.1.RELEASE</version>  
19.         </dependency>  
20.   
21.         <dependency>  
22.             <groupId>com.alibaba</groupId>  
23.             <artifactId>fastjson</artifactId>  
24.             <version>1.1.34</version>  
25.         </dependency>  

基类如下:

 

 

[java] view plain copy

 

1. package com.lin.controller;  
2.   
3. import com.lin.common.HttpConstants;  
4. import com.lin.json.JsonDateValueProcessor;  
5.   
6. import net.sf.json.JSONArray;  
7. import net.sf.json.JSONObject;  
8. import net.sf.json.JsonConfig;  
9.   
10. import org.slf4j.Logger;  
11. import org.slf4j.LoggerFactory;  
12.   
13. import java.util.Date;  
14.   
15. /** 
16.  * Controller基类 
17.  */  
18. public class BaseController {  
19.   
20.     protected Logger logger = LoggerFactory.getLogger(this.getClass());  
21.       
22.     protected final static String DATE_FORMATE = "yyyy-MM-dd";  
23.       
24.     /** 
25.      * 返回服务端处理结果 
26.      * @param obj 服务端输出对象 
27.      * @return 输出处理结果给前段JSON格式数据 
28.      * @author YANGHONGXIA 
29.      * @since 2015-01-06 
30.      */  
31.     public String responseResult(Object obj){  
32.         JSONObject jsonObj = null;  
33.         if(obj != null){  
34.             logger.info("后端返回对象：{}", obj);  
35.             JsonConfig jsonConfig = new JsonConfig();   
36.             jsonConfig.registerJsonValueProcessor(Date.class, new JsonDateValueProcessor());  
37.             jsonObj = JSONObject.fromObject(obj, jsonConfig);  
38.             logger.info("后端返回数据：" + jsonObj);  
39.             if(HttpConstants.SERVICE_RESPONSE_SUCCESS_CODE.equals(jsonObj.getString(HttpConstants.SERVICE_RESPONSE_RESULT_FLAG))){  
40.                 jsonObj.element(HttpConstants.RESPONSE_RESULT_FLAG_ISERROR, false);  
41.                 jsonObj.element(HttpConstants.SERVICE_RESPONSE_RESULT_MSG, "");  
42.             }else{  
43.                 jsonObj.element(HttpConstants.RESPONSE_RESULT_FLAG_ISERROR, true);  
44.                 String errMsg = jsonObj.getString(HttpConstants.SERVICE_RESPONSE_RESULT_MSG);  
45.                 jsonObj.element(HttpConstants.SERVICE_RESPONSE_RESULT_MSG, errMsg==null?HttpConstants.SERVICE_RESPONSE_NULL:errMsg);  
46.             }  
47.         }  
48.         logger.info("输出结果：{}", jsonObj.toString());  
49.         return jsonObj.toString();  
50.     }  
51.       
52.     /** 
53.      * 返回成功 
54.      * @param obj 输出对象 
55.      * @return 输出成功的JSON格式数据 
56.      */  
57.     public String responseSuccess(Object obj){  
58.         JSONObject jsonObj = null;  
59.         if(obj != null){  
60.             logger.info("后端返回对象：{}", obj);  
61.             JsonConfig jsonConfig = new JsonConfig();   
62.             jsonConfig.registerJsonValueProcessor(Date.class, new JsonDateValueProcessor());  
63.             jsonObj = JSONObject.fromObject(obj, jsonConfig);  
64.             logger.info("后端返回数据：" + jsonObj);  
65.             jsonObj.element(HttpConstants.RESPONSE_RESULT_FLAG_ISERROR, false);  
66.             jsonObj.element(HttpConstants.SERVICE_RESPONSE_RESULT_MSG, "");  
67.         }  
68.         logger.info("输出结果：{}", jsonObj.toString());  
69.         return jsonObj.toString();  
70.     }  
71.   
72.     /** 
73.      * 返回成功 
74.      * @param obj 输出对象 
75.      * @return 输出成功的JSON格式数据 
76.      */  
77.     public String responseArraySuccess(Obje