Mybatis分页和Spring的集成
Mybatis分页和Spring的集成
miemiedev 发表于5年前
Mybatis分页和Spring的集成
  • 发表于 5年前
  • 阅读 47711
  • 收藏 114
  • 点赞 22
  • 评论 108

移动开发云端新模式探索实践 >>>   

写了一个Mybatis分页控件,在这记录一下使用方式。

在Maven中加入依赖:

<dependencies>
  ...
    <dependency>
        <groupId>com.github.miemiedev</groupId>
        <artifactId>mybatis-paginator</artifactId>
        <version>1.2.17</version>
    </dependency>
 ...
</dependencies>


Mybatis配置文件添加分页插件:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//ibatis.apache.org//DTD Config 3.0//EN"
        "http://ibatis.apache.org/dtd/ibatis-3-config.dtd">
<configuration>
    <plugins>
        <plugin interceptor="com.github.miemiedev.mybatis.paginator.OffsetLimitInterceptor">
            <property name="dialectClass" value="com.github.miemiedev.mybatis.paginator.dialect.OracleDialect"/>
        </plugin>
    </plugins>
</configuration>


创建一个查询,内容可以是任何Mybatis表达式,包括foreach和if等:

<select id="findByCity" resultType="map">
    select * from TEST_USER where city = #{city};
</select>


Dao中的方法或许是这样(用接口也是类似):

public List findByCity(String city, PageBounds pageBounds){

    Map<String, Object> params = new HashMap<String, Object>();
    params.put("city",city);

    return getSqlSession().selectList("db.table.user.findByCity", params, pageBounds);
}


调用方式(分页加多列排序):

int page = 1; //页号
int pageSize = 20; //每页数据条数
String sortString = "age.asc,gender.desc";//如果你想排序的话逗号分隔可以排序多列
PageBounds pageBounds = new PageBounds(page, pageSize , Order.formString(sortString));
List list = findByCity("BeiJing",pageBounds);

//获得结果集条总数
PageList pageList = (PageList)list;
System.out.println("totalCount: " + pageList.getPaginator().getTotalCount());

PageList类是继承于ArrayList的,这样Dao中就不用为了专门分页再多写一个方法。

使用PageBounds这个对象来控制结果的输出,常用的使用方式一般都可以通过构造函数来配置。

new PageBounds();//默认构造函数不提供分页,返回ArrayList
new PageBounds(int limit);//取TOPN操作,返回ArrayList
new PageBounds(Order... order);//只排序不分页,返回ArrayList

new PageBounds(int page, int limit);//默认分页,返回PageList
new PageBounds(int page, int limit, Order... order);//分页加排序,返回PageList
new PageBounds(int page, int limit, List<Order> orders, boolean containsTotalCount);//使用containsTotalCount来决定查不查询totalCount,即返回ArrayList还是PageList


========================================= 

如果用的是Spring MVC的话可以把JSON的配置写成这样:

<mvc:annotation-driven>
    <mvc:message-converters register-defaults="true">
        <bean class="org.springframework.http.converter.StringHttpMessageConverter"> 
            <constructor-arg value="UTF-8" />        
        </bean>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="objectMapper">
                <bean class="com.github.miemiedev.mybatis.paginator.jackson2.PageListJsonMapper" />
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>


那么在Controller就可以这样用了:

@ResponseBody
@RequestMapping(value = "/findByCity.json")
public List findByCity(@RequestParam String city,
                 @RequestParam(required = false,defaultValue = "1") int page,
                 @RequestParam(required = false,defaultValue = "30") int limit,
                 @RequestParam(required = false) String sort,
                 @RequestParam(required = false) String dir) {
    return userService.findByCity(city, new PageBounds(page, limit, Order.create(sort,dir)));
}


然后序列化后的JSON字符串就会变成这样的:

{
    "items":[
        {"NAME":"xiaoma","AGE":30,"GENDER":1,"ID":3,"CITY":"BeiJing"},
        {"NAME":"xiaoli","AGE":30,"SCORE":85,"GENDER":1,"ID":1,"CITY":"BeiJing"},
        {"NAME":"xiaowang","AGE":30,"SCORE":92,"GENDER":0,"ID":2,"CITY":"BeiJing"},
        {"NAME":"xiaoshao","AGE":30,"SCORE":99,"GENDER":0,"ID":4,"CITY":"BeiJing"}
    ],
    "slider": [1, 2, 3, 4, 5, 6, 7],
    "hasPrePage": false,
    "startRow": 1,
    "offset": 0,
    "lastPage": false,
    "prePage": 1,
    "hasNextPage": true,
    "nextPage": 2,
    "endRow": 30,
    "totalCount": 40351,
    "firstPage": true,
    "totalPages": 1346,
    "limit": 30,
    "page": 1
}


=========================================

在SpringMVC中使用JSTL的话可以参考一下步骤(懒人用法)

在Spring配置文件中加入拦截器,或则参考拦截器实现定义自己的拦截器

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**" />
        <bean class="com.github.miemiedev.mybatis.paginator.springmvc.PageListAttrHandlerInterceptor" />
    </mvc:interceptor>
</mvc:interceptors>

然后Controller方法可以这样写

@RequestMapping(value = "/userView.action")
public ModelAndView userView(@RequestParam String city,
                 @RequestParam(required = false,defaultValue = "1") int page,
                 @RequestParam(required = false,defaultValue = "30") int limit,
                 @RequestParam(required = false) String sort,
                 @RequestParam(required = false) String dir) {
    List users = userService.findByCity(city, new PageBounds(page, limit, Order.create(sort,dir)));
    return new ModelAndView("account/user","users", users);
}

JSP中就可以这样用了,拦截器会将PageList分拆添加Paginator属性,默认命名规则为"原属性名称"+"Paginator"

<table>
    <c:forEach items="${users}" var="user">
        <tr>
            <td>${user['ID']}</td>
            <td>${user['NAME']}</td>
            <td>${user['AGE']}</td>
        </tr>
    </c:forEach>
</table>
上一页: ${usersPaginator.prePage} 
当前页: ${usersPaginator.page} 
下一页: ${usersPaginator.nextPage} 
总页数: ${usersPaginator.totalPages} 
总条数: ${usersPaginator.totalCount} 
更多属性参考Paginator类提供的方法

=========================================

如果用如下方法设置pageBounds,当前这个查询就可以用两个线程同时查询list和totalCount

pageBounds.setAsyncTotalCount(true);

如果所有的分页查询都是用异步的方式查询list和totalCount,可以在插件配置加入asyncTotalCount属性

<plugin interceptor="com.github.miemiedev.mybatis.paginator.OffsetLimitInterceptor">
    <property name="dialectClass" value="com.github.miemiedev.mybatis.paginator.dialect.OracleDialect"/>
    <property name="asyncTotalCount" value="true"/>
</plugin>

但是你仍然可以用下面代码强制让这个查询不用异步

pageBounds.setAsyncTotalCount(false);

当然需要注意的是,只要你用到了异步查询,由于里面使用了线程池,所以在使用时就要加入清理监听器,以便在停止服务时关闭线程池。需要在web.xml中加入

<listener>
    <listener-class>com.github.miemiedev.mybatis.paginator.CleanupMybatisPaginatorListener</listener-class>
</listener>


完。

  • 打赏
  • 点赞
  • 收藏
  • 分享
共有 人打赏支持
miemiedev
粉丝 69
博文 2
码字总数 1543
作品 2
评论 (108)
mascothaojun
debug 进去limit的值永远都是2147483647,是什么原因造成的?
miemiedev

引用来自“mascothaojun”的评论

debug 进去limit的值永远都是2147483647,是什么原因造成的?
你设了PageBounds就不可能是这个值了
mascothaojun

引用来自“mascothaojun”的评论

debug 进去limit的值永远都是2147483647,是什么原因造成的?

引用来自“miemiedev”的评论

你设了PageBounds就不可能是这个值了
PageBounds的对象我已经new 出来了.但是还是这样子?
mascothaojun
我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?
miemiedev

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?
你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了
mascothaojun

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?

引用来自“miemiedev”的评论

你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了
那为什么查找的语句,没有加上rownum的筛选呢?是不是我这个表是同义词的问题?
miemiedev

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?

引用来自“miemiedev”的评论

你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了

引用来自“mascothaojun”的评论

那为什么查找的语句,没有加上rownum的筛选呢?是不是我这个表是同义词的问题?
那个PageBounds就是个Bean,你设置了不太可能还会是2147483647的
mascothaojun
是要版本匹配吗?mybatis,mybatis-spring的版本有要求吗?
mascothaojun

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?

引用来自“miemiedev”的评论

你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了

引用来自“mascothaojun”的评论

那为什么查找的语句,没有加上rownum的筛选呢?是不是我这个表是同义词的问题?

引用来自“miemiedev”的评论

那个PageBounds就是个Bean,你设置了不太可能还会是2147483647的
您好,经过测试后,原来是dubbo的框架是这样的,因为现在我们的项目是分成三层开发的,web是一个工程,然后api工程只放接口暴露给web工程访问,,最后后台逻辑的工程,但是limit在web访问的时候,就出现问题了,值传不过去,所以就出现没法加rownum的原因!
mascothaojun

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?

引用来自“miemiedev”的评论

你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了

引用来自“mascothaojun”的评论

那为什么查找的语句,没有加上rownum的筛选呢?是不是我这个表是同义词的问题?

引用来自“miemiedev”的评论

那个PageBounds就是个Bean,你设置了不太可能还会是2147483647的
原来是dubbo的框架和你写的代码有冲突的问题,因为dubbo是通过反射来查找你当前的 limit的值,但是你的类里面 limit有两个值,构造方法当前的值是已经更改了,但是父类的值没修改,所以反射的时候,可能只拿到父类的值,所以导致rownum没追加成功.
mascothaojun

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?

引用来自“miemiedev”的评论

你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了

引用来自“mascothaojun”的评论

那为什么查找的语句,没有加上rownum的筛选呢?是不是我这个表是同义词的问题?

引用来自“miemiedev”的评论

那个PageBounds就是个Bean,你设置了不太可能还会是2147483647的
http://blog.163.com/jekyll_zhou@126/blog/static/182047382012103033035925/ 我的问题,和这个是同一个问题,所以你这里可能要改造一下,呵呵!希望我提的建议有用!
miemiedev

引用来自“mascothaojun”的评论

我发现Mybatis配置文件添加分页插件,加不加都行的?是不是这个原因?因为系统没读取该配置文件,所以就出现这种问题?

引用来自“miemiedev”的评论

你要是debug能到OffsetLimitInterceptor这个类就说明插件正确配置了

引用来自“mascothaojun”的评论

那为什么查找的语句,没有加上rownum的筛选呢?是不是我这个表是同义词的问题?

引用来自“miemiedev”的评论

那个PageBounds就是个Bean,你设置了不太可能还会是2147483647的

引用来自“mascothaojun”的评论

http://blog.163.com/jekyll_zhou@126/blog/static/182047382012103033035925/ 我的问题,和这个是同一个问题,所以你这里可能要改造一下,呵呵!希望我提的建议有用!
谢谢你的建议
xingeryue

引用来自“miemiedev”的评论

引用来自“唐文韬”的评论

您好,我在PageList pageList = (PageList)list; 强制转换这里报错了,我有点不解,为啥这里来个强转,就能取到Paginator对象? 我debug了下,list就是一个普通的List对象,如何能变出一个Paginator对象?

区别在于containsTotalCount参数是否为true。有时候只想取TopN就可以不查询记录总数了。
您好, 我在用 List users = testlist(pageForm); PageList pageList = (PageList)users; 时 始终报错,类型转换错误,我也检查了很多次,是不是哪里的配置有问题?
huffmans
好使79
zxc旭
楼主,为什么我的
(int page = 1; //页号
    int pageSize = 20; //每页数据条数
    String sortString = "StudentNo.asc";//如果你想排序的话逗号分隔可以排序多列
    PageBounds pageBounds = new PageBounds(page, pageSize , Order.formString(sortString),true);
    //PageBounds pageBounds = new PageBounds(page, pageSize,true);
    PageList pageList = studentSvc.findByCity("",pageBounds);
    Paginator paginator = pageList.getPaginator();)
总页数:paginator 始终是Null呢?
diaosidiaosi
楼主  能将数据库表给我们看下吗?
oaoit
是物理分页吗?
修改性别
HTTP Status 500 - Request processing failed; nested exception is java.lang.ClassCastException: java.util.ArrayList cannot be cast to com.github.miemiedev.mybatis.paginator.domain.PageList
修改性别
HTTP Status 500 - Request processing failed; nested exception is java.lang.ClassCastException: java.util.ArrayList cannot be cast to com.github.miemiedev.mybatis.paginator.domain.PageList数据库是SQLSERVER
jaseeka
你好 我这里引用你的插件后报错了。
接口:
public PageList<User> selectOr(User object, PageBounds page);
错误:
java.lang.ClassCastException: com.idongri.entity.User cannot be cast to java.lang.String
如果把接口参数改成map就可以使用,难道不支持类参数吗?
public PageList<User> selectOr(Map object, PageBounds page);
×
miemiedev
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: