【Mybatis入門から実戦までのチュートリアル】 第8章 Mybatis PageHelper ページングプラグイン

八、Mybatis PageHelper ページング プラグイン

8.1 ページネーション プラグイン jar パッケージのインポート

方法 1: jar パッケージをインポートする

 方法 2: Maven の依存関係を構成する

<!-- PageHelper -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>5.1.10</version>
</dependency>

8.2 ページネーションプラグインの設定

8.2.1 MyBatis グローバル設定ファイルでインターセプタ プラグインを設定する

<!-- 分页插件 -->
<plugins>
    <!--  
		interceptor属性：配置PageHelper插件中的核心拦截器类；
		PageInterceptor拦截器类（类似于JavaWeb阶段的过滤器）：
			该拦截器的作用是在查询SQL执行之前，将编写的SQL语句改造成分页查询语句；
	-->
    <plugin interceptor="com.github.pagehelper.PageInterceptor"></plugin>
</plugins>

8.2.2 プラグイン プロパティの設定

属性名	デフォルト	説明
helper方言		ページング プラグインは、現在のデータベース接続を自動的に検出し、適切なページング メソッドを自動的に選択します. helperDialect プロパティを構成して、ページング プラグインが使用するダイアレクトを指定できます. 構成時には、次の省略値を使用できます: oracle、mysql、mariadb、sqlite、hsqldb、postgresql、db2、sqlserver、informix、h2、sqlserver2012、derby
offsetAsPageNum	間違い	このパラメーターは、R​​owBounds をページング パラメーターとして使用する場合に有効です。このパラメーターを true に設定すると、RowBounds のオフセット パラメーターが pageNum として使用され、ページ番号とページ サイズをページングに使用できます。
rowBoundsWithCount	間違い	このパラメーターは、R​​owBounds をページング パラメーターとして使用する場合に有効です。このパラメーターが true に設定されている場合、RowBounds ページネーションを使用すると、カウント クエリが実行されます。
pageSizeZero	間違い	このパラメーターが true に設定されている場合、pageSize=0 または RowBounds.limit=0 の場合、すべての結果がクエリされます。これは、ページング クエリがない場合と同じですが、返される結果は依然として Page タイプです。
適正	間違い	ページング合理化パラメータ 合理化が有効な場合、pageNum<1 の場合は最初のページを照会し、pageNum>pages の場合は最後のページを照会します 合理化が無効な場合、pageNum<1 または pageNum>pages の場合は空のデータを返します
パラメータ	pageNum=pageNum; pageSize=pageSize; カウント=countSql; 合理的=合理的; pageSizeZero=pageSizeZero	startPage(Object params) メソッドをサポートするために、このパラメーターを追加してパラメーター マッピングを構成し、属性名に従ってオブジェクトから値を取得するために使用されます. pageNum、pageSize、count、pageSizeZero、合理的に構成できます、マッピングを構成しない場合はデフォルト値を使用します
サポートメソッド引数	間違い	Mapper インターフェイス パラメーターを介したページング パラメーターの受け渡しをサポート ページング プラグインは、上記の params で構成されたフィールドに従って、クエリ メソッドのパラメーター値から値を自動的に取得し、適切な値を見つけると自動的にページ付けを行います
autoRuntimeDialect	間違い	true に設定すると、実行時に複数のデータ ソースに従って、対応する方言のページネーションを自動的に識別することができます。
closeConn	真実	ランタイム動的データ ソースが使用されている場合、または helperDialect プロパティがデータベース タイプを自動的に取得するように設定されていない場合、データベース接続が自動的に取得されます。このプロパティは、取得した接続を閉じるかどうかを設定するために使用されます。デフォルトは true で、closed です。 false に設定した後、取得は接続を閉じません。このパラメーターの設定は、選択したデータ ソースによって異なります。

<!-- 分页插件 -->
<plugins>
    <plugin interceptor="com.github.pagehelper.PageInterceptor">
        <!-- 开启合理化分页-->
        <property name="reasonable" value="true"/>
    </plugin>
</plugins>

8.3 プログラムでの使用

8.3.1 エンティティークラス

public class Emp {

    private Integer empno;
    private String ename;
    private String job;
    private Integer mgr;
    private Date hiredate;
    private Double sal;
    private Double comm;
    private Integer deptno;

    public Integer getEmpno() {
        return empno;
    }

    public void setEmpno(Integer empno) {
        this.empno = empno;
    }

    public String getEname() {
        return ename;
    }

    public void setEname(String ename) {
        this.ename = ename;
    }

    public String getJob() {
        return job;
    }

    public void setJob(String job) {
        this.job = job;
    }

    public Integer getMgr() {
        return mgr;
    }

    public void setMgr(Integer mgr) {
        this.mgr = mgr;
    }

    public Date getHiredate() {
        return hiredate;
    }

    public void setHiredate(Date hiredate) {
        this.hiredate = hiredate;
    }

    public Double getSal() {
        return sal;
    }

    public void setSal(Double sal) {
        this.sal = sal;
    }

    public Double getComm() {
        return comm;
    }

    public void setComm(Double comm) {
        this.comm = comm;
    }

    public Integer getDeptno() {
        return deptno;
    }

    public void setDeptno(Integer deptno) {
        this.deptno = deptno;
    }

    @Override
    public String toString() {
        return "Emp{" +
                "empno=" + empno +
                ", ename='" + ename + '\'' +
                ", job='" + job + '\'' +
                ", mgr=" + mgr +
                ", hiredate=" + hiredate +
                ", sal=" + sal +
                ", comm=" + comm +
                ", deptno=" + deptno +
                '}';
    }
}

8.3.2 マッパーインターフェース

public interface EmpMapper {

    List<Emp> selectByPage();
}

8.3.3 マッパーファイル

<?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.newcapec.mapper.EmpMapper">

    <!--使用PageHelper插件实现分页，SQL语句无需编写任何和分页相关的内容-->
    <select id="selectByPage" resultType="com.newcapec.entity.Emp">
        select empno,ename,job,mgr,hiredate,sal,comm,deptno from emp order by empno
    </select>
</mapper>

8.3.4 テスト

public class PageHelperTest {

    @Test
    public void testPageHelper() {
        SqlSession sqlSession = MybatisUtil.getSession();
        EmpMapper empMapper = sqlSession.getMapper(EmpMapper.class);

        //开启分页拦截器，设置分页的基本属性（当前页面数，每页条数）
        PageHelper.startPage(1, 5);
        List<Emp> empList = empMapper.selectByPage();
        for (Emp emp : empList) {
            System.out.println(emp);
        }

        //分页信息对象
        PageInfo<Emp> pageInfo = new PageInfo<>(empList);
        System.out.println("当前页数：" + pageInfo.getPageNum());
        System.out.println("每页条数：" + pageInfo.getPageSize());
        System.out.println("总记录数：" + pageInfo.getTotal());
        System.out.println("总页数：" + pageInfo.getPages());
        System.out.println("上一页：" + pageInfo.getPrePage());
        System.out.println("下一页：" + pageInfo.getNextPage());
        System.out.println("是否有上一页：" + pageInfo.isHasPreviousPage());
        System.out.println("是否有下一页：" + pageInfo.isHasNextPage());
        System.out.println("是否为首页：" + pageInfo.isIsFirstPage());
        System.out.println("是否为末页：" + pageInfo.isIsLastPage());
        System.out.println("存放页码的数据：" + Arrays.toString(pageInfo.getNavigatepageNums()));
        System.out.println("获取当前页数据：" + pageInfo.getList());
        sqlSession.close();
    }
}