PageHelper和Mybatis Generator的入门使用

Mybatis Generator 可以根据数据库中的对应的表（具体根据哪张表需要在generationConfig.xml文件中配置，配置信息可以查看上方连接）生成对应的实体类，dao接口以及单表查询接口对应的mapper.xml文件（也可以选择用注解的方式生成）。

PageHelper 是一个分页插件，可以很方便的进行分页查询。

项目结构： https://github.com/abel533/MyBatis-Spring-Boot（参考文件地址）

1、Maven核心依赖

<!--mybatis-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.1</version>
</dependency>
<!--mapper-->
<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>1.2.4</version>
</dependency>
<!--pagehelper-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.2.3</version>
</dependency>

2、application.yml配置

spring:
  datasource:
    password: 123456
    username: root
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    driver-class-name: com.mysql.cj.jdbc.Driver

mybatis:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.zhikan.pagehelperdemo.entity

mapper:
  mappers:
    - com.zhikan.pagehelperdemo.mapper
  not-empty: false
  identity: MYSQL

pagehelper:
  dialect: mysql
  reasonable: true
  support-methods-arguments: true
  params: countsql

3、generatorConfig.xml配置（根据文件进行配置）

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <properties resource="application-dev.properties"/>

    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="tk.mybatis.springboot.util.MyMapper"/>
        </plugin>

        <jdbcConnection driverClass="${spring.datasource.driver-class-name}"
                        connectionURL="${spring.datasource.url}"
                        userId="${spring.datasource.username}"
                        password="${spring.datasource.password}">
        </jdbcConnection>

        <javaModelGenerator targetPackage="tk.mybatis.springboot.model" targetProject="src/main/java"/>

        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>

        <javaClientGenerator targetPackage="tk.mybatis.springboot.mapper" targetProject="src/main/java"
                             type="XMLMAPPER"/>

        <table tableName="country">
            <!--mysql 配置-->
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
            <!--oracle 配置-->
            <!--<generatedKey column="id" sqlStatement="select SEQ_{1}.nextval from dual" identity="false" type="pre"/>-->
        </table>
    </context>
</generatorConfiguration>

4、生成对应的实体类、DAO和mapper.xml文件

在IDEA中打开终端：

• set MAVEN_OPTS="-Dfile.encoding=UTF-8"（每次执行下面命令时，先执行该命令，否则生成的实体类的中文注释乱码）

• set MAVEN_OPTS="-Dfile.encoding=UTF-8"（执行该命令，对应目录下生成文件）

5、分页插件的使用

在导入相应的maven依赖后，可以使用PageHelper.startPage（pageNum，pageSize）方法来设置页数和页数大小，然后通过DAO层获取查询结果，最后结果使用PageInfo进行封装，最后返回给前端。

    @Override
    public ApiResult<PageInfo<UserManagerVO>> search(UserManagerSearchDTO dto) {
        List<UserManagerVO> list = null;
        PageHelper.startPage(dto.getPageNumber(),dto.getPageSize());
        list = userManagerMapper.queryBySearchValue(dto);
        PageInfo<UserManagerVO> userManagerVOPageInfo = new PageInfo<>(list);
        return ApiResult.success(userManagerVOPageInfo);
    }

6、PageHelper方法分页的原理：

    - PageHelper方法使用了静态的ThreadLocal参数，分页参数和线程是绑定的 。内部流程ThreadLocal中设置了分页参数（pageNum，pageSize），之后在查询执行的时候，获取当线程中的分页参数，执行查询的时候通过拦截器在sql语句中添加分页参数，之后实现分页查询，查询结束后在 finally 语句中清除ThreadLocal中的查询参数

    详细时序图

    - 注意：只要你可以保证在PageHelper方法调用后紧跟 MyBatis 查询方法，这就是安全的。因为PageHelper在finally代码段中自动清除了ThreadLocal存储的对象。如果代码进入Executor前发生异常，就会导致线程不可用，这属于认为bug（例如接口方法和xml文件的方法不匹配，导致找不mappedStatement时），这种情况由于线程不可用，也不会导致ThreadLocal参数被错误使用。

    - 但是下面这种写法存在问题：

PageHelper.StartPage(1, 10);
List<Country> list;
if (param1 != null){
    list = countryMapper.selectIf(param1);
} else {
    list = new ArrayList<Country>();
}

        这种情况下，当param1 == null 时，会导致PageHelper产生一个分页，但是这个分页并没有被消费，这个参数就会一直保留在这个线程上。当这个线程再次被使用时，可能会导致本来不分页的操作查出来分页的结果。应该使用下面这种写法保证线程安全。

List<Country> list;
if (param1 != null){
    PageHelper.StartPage(1, 10);
    list = countryMapper.selectIf(param1);
} else {
    list = new ArrayList<Country>();
}