Mybatis分頁插件 - 示例

Mybatis極其(最)簡(好)單(用)的一個分頁插件

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

這裏說最好用，絕對不是吹的，不過有好多人都不理解爲何要用這個插件，本身手寫分頁sql不是挺好嗎......

因此我特意寫這樣一個例子來說爲何最好用。

假設咱們已經寫好了Mapper的接口和xml，以下：

 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);

 }

 <?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層調用代碼。

不須要分頁時候的代碼：

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

增長分頁功能以後的代碼：

 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

而後過程代碼中，先調用了

 PageHelper.startPage(pageNumber,pageSize);

startPage是告訴攔截器說我要開始分頁了。分頁參數是這兩個。

而後調用原來的Mybatis代碼：

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

這裏沒有接收返回值，會不會以爲奇怪？實際上PageHelper已經自動接收了返回值。經過下面的代碼能夠取出返回值：

 PageHelper.endPage();

同時endPage告訴攔截器說我結束分頁了，不須要你了。