Mybatis分页插件 - 示例

Mybatis极其(最)简(好)单(用)的一个分页插件

http://blog.csdn.net/isea533/article/details/23831273

这里说最好用，绝对不是吹的，不过有好多人都不理解为什么要用这个插件，自己手写分页sql不是挺好吗......

所以我特地写这样一个例子来讲为什么最好用。

假设我们已经写好了Mapper的接口和xml，如下：

[java] view plain copy print ?

1. public interface SysLoginLogMapper { 
2.     /**
3.      * 根据查询条件查询登录日志
4.      * @param logip
5.      * @param username
6.      * @param loginDate
7.      * @param exitDate
8.      * @return
9.      */ 
10.     List<SysLoginLog> findSysLoginLog(@Param("logip") String logip, 
11.                                       @Param("username") String username, 
12.                                       @Param("loginDate") String loginDate, 
13.                                       @Param("exitDate") String exitDate, 
14.                                       @Param("logerr") String logerr); 
15.  
16. } 

public interface SysLoginLogMapper {
    /**
     * 根据查询条件查询登录日志
     * @param logip
     * @param username
     * @param loginDate
     * @param exitDate
     * @return
     */
    List<SysLoginLog> findSysLoginLog(@Param("logip") String logip,
                                      @Param("username") String username,
                                      @Param("loginDate") String loginDate,
                                      @Param("exitDate") String exitDate,
                                      @Param("logerr") String logerr);

}

[html] view plain copy print ?

1. <?xml version="1.0" encoding="UTF-8" ?> 
2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" > 
3. <mapper namespace="com.easternie.sys.dao.SysLoginLogMapper"> 
4.   <select id="findSysLoginLog" resultType="com.easternie.sys.vo.model.SysLoginLog"> 
5.     select * from sys_login_log a 
6.     <if test="username != null and username != ''"> 
7.       left join sys_user b on a.userid = b.userid 
8.     </if> 
9.     <where> 
10.       <if test="logip!=null and logip != ''"> 
11.         a.logip like '%'||#{logip}||'%' 
12.       </if> 
13.       <if test="username != null and username != ''"> 
14.         and (b.username like '%'||#{username}||'%' or b.realname like '%'||#{username}||'%') 
15.       </if> 
16.       <if test="loginDate!=null and loginDate!=''"> 
17.         and to_date(substr(a.logindate,0,10),'yyyy-MM-dd') = to_date(#{loginDate},'yyyy-MM-dd') 
18.       </if> 
19.       <if test="exitDate!=null and exitDate!=''"> 
20.         and to_date(substr(a.EXITDATE,0,10),'yyyy-MM-dd') = to_date(#{exitDate},'yyyy-MM-dd') 
21.       </if> 
22.       <if test="logerr!=null and logerr!=''"> 
23.         and a.logerr like '%'||#{logerr}||'%' 
24.       </if> 
25.     </where> 
26.     order by logid desc 
27.   </select> 
28. </mapper> 

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.easternie.sys.dao.SysLoginLogMapper">
  <select id="findSysLoginLog" resultType="com.easternie.sys.vo.model.SysLoginLog">
    select * from sys_login_log a
    <if test="username != null and username != ''">
      left join sys_user b on a.userid = b.userid
    </if>
    <where>
      <if test="logip!=null and logip != ''">
        a.logip like '%'||#{logip}||'%'
      </if>
      <if test="username != null and username != ''">
        and (b.username like '%'||#{username}||'%' or b.realname like '%'||#{username}||'%')
      </if>
      <if test="loginDate!=null and loginDate!=''">
        and to_date(substr(a.logindate,0,10),'yyyy-MM-dd') = to_date(#{loginDate},'yyyy-MM-dd')
      </if>
      <if test="exitDate!=null and exitDate!=''">
        and to_date(substr(a.EXITDATE,0,10),'yyyy-MM-dd') = to_date(#{exitDate},'yyyy-MM-dd')
      </if>
      <if test="logerr!=null and logerr!=''">
        and a.logerr like '%'||#{logerr}||'%'
      </if>
    </where>
    order by logid desc
  </select>
</mapper>

虽然是举个简单例子，但是这里的xml并没那么简单。

如果你已经有一些例如上面这些现成的Mybatis方法了，我现在想对这个查询进行分页，我该怎么办呢？

如果是手写SQL，我需要增加两个接口，一个查询count总数，一个改为分页形式的。需要在xml中，复制粘贴，然后改改语句，似乎也不是很难。你是这样做的吗？

如果使用这个插件，我需要做什么呢？？？

对Mybatis已经写好的这些方法来说，我什么都不需要改。

但是Service层可能需要动一下。具体上面这个例子。看下面的Service层调用代码。

不需要分页时候的代码：

[java] view plain copy print ?

1. public List<SysLoginLog> findSysLoginLog(String loginIp, 
2.                                          String username, 
3.                                          String loginDate, 
4.                                          String exitDate, 
5.                                          String logerr) throws BusinessException { 
6.     return sysLoginLogMapper.findSysLoginLog(loginIp, username, loginDate, exitDate, logerr); 
7. } 

public List<SysLoginLog> findSysLoginLog(String loginIp,
                                         String username,
                                         String loginDate,
                                         String exitDate,
                                         String logerr) throws BusinessException {
    return sysLoginLogMapper.findSysLoginLog(loginIp, username, loginDate, exitDate, logerr);
}

增加分页功能之后的代码：

[java] view plain copy print ?

1. public PageHelper.Page<SysLoginLog> findSysLoginLog(String loginIp, 
2.                                          String username, 
3.                                          String loginDate, 
4.                                          String exitDate, 
5.                                          String logerr, 
6.                                          int pageNumber, 
7.                                          int pageSize) throws BusinessException { 
8.     PageHelper.startPage(pageNumber,pageSize); 
9.     sysLoginLogMapper.findSysLoginLog(loginIp, username, loginDate, exitDate, logerr); 
10.     return PageHelper.endPage(); 
11. } 

public PageHelper.Page<SysLoginLog> findSysLoginLog(String loginIp,
                                         String username,
                                         String loginDate,
                                         String exitDate,
                                         String logerr,
                                         int pageNumber,
                                         int pageSize) throws BusinessException {
    PageHelper.startPage(pageNumber,pageSize);
    sysLoginLogMapper.findSysLoginLog(loginIp, username, loginDate, exitDate, logerr);
    return PageHelper.endPage();
}

相比较而言：

返回值从List<SysLoginLog>改成了PageHelper.Page<SysLoginLog>

入参增加了两个，pageNumber和pageSize

然后过程代码中，先调用了

[java] view plain copy print ?

1. PageHelper.startPage(pageNumber,pageSize); 

PageHelper.startPage(pageNumber,pageSize);

startPage是告诉拦截器说我要开始分页了。分页参数是这两个。

然后调用原来的Mybatis代码：

[java] view plain copy print ?

1. sysLoginLogMapper.findSysLoginLog(loginIp, username, loginDate, exitDate, logerr); 

sysLoginLogMapper.findSysLoginLog(loginIp, username, loginDate, exitDate, logerr);

这里没有接收返回值，会不会觉得奇怪？实际上PageHelper已经自动接收了返回值。通过下面的代码可以取出返回值：

[java] view plain copy print ?

1. PageHelper.endPage(); 

PageHelper.endPage();

同时endPage告诉拦截器说我结束分页了，不需要你了。


你觉得这样的代码简单还是手写sql简单呢？

关于PageHelper的其他信息，看这里：Mybatis极其(最)简(好)单(用)的一个分页插件

如果你有更好的解决方法，欢迎分享~~~~~~~~~