MybatisGenerator及PageHelper的使用

MybatisGenerator及PageHelper的使用

序言

本文主要介绍，在SpringBoot下MybatisGenerator和PageHelper如何使用。在日常Mybatis的使用过程中，我们需要自行创建实体类、编写Mapper接口以及创建Mapper接口的映射文件，然后实现相关对数据库的操作。

MybatisGenerator的作用：

• 自动生成实体类、Mapper接口和映射文件
• 自动帮助我们实现了基本的crud操作

PageHelper的作用：

• 简化数据分页查询

MybatisGenerator的使用

1.创建一个SpringBoot项目，并引入相关依赖

<!--SpringBoot通用依赖模块-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.junit.vintage</groupId>
            <artifactId>junit-vintage-engine</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!--Mybatis分页插件-->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper-spring-boot-starter</artifactId>
    <version>1.2.10</version>
</dependency>
<!-- MyBatis 生成器 -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.3.3</version>
</dependency>
<!--Mysql数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

2.在resource根目录下添加generator.properties文件，用来存放连接数据库的相关信息

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=root

3.在resource根目录下添加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="generator.properties"/>
    <context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 为模型生成序列化方法-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 为生成的Java模型创建一个toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!--可以自定义生成model的代码注释，type要自行更换-->
        <commentGenerator type="com.lh.springboot_mybatis.mbg.CommentGenerator">
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        <!--配置数据库连接-->
        <jdbcConnection driverClass="${jdbc.driverClass}"
                        connectionURL="${jdbc.connectionURL}"
                        userId="${jdbc.userId}"
                        password="${jdbc.password}">
            <!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>
        <!--指定生成model的路径-->
        <javaModelGenerator targetPackage="com.lh.springboot_mybatis.mbg.model" targetProject=".\src\main\java"/>
        <!--指定生成mapper.xml的路径-->
        <sqlMapGenerator targetPackage="com.lh.mbg.mapper" targetProject=".\src\main\resources"/>
        <!--指定生成mapper接口的的路径-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.lh.springboot_mybatis.mbg.mapper"
                             targetProject=".\src\main\java"/>
        <!--生成全部表tableName设为%-->
        <table tableName="pms_brand">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

4.对application.yml文件进行配置，数据库信息以及映射文件的位置

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: root

mybatis:
  mapper-locations:
    - classpath:mapper/*.xml	#自定义的映射文件地址
    - classpath*:com/btn/behavior/mbg/mapper/*.xml	#MybatisGenerator生成的映射文件地址

注：需要在resources文件夹下新建两个用来存放映射文件的文件夹，如图：

5.程序启动类上添加MapperScan注解，可添加多个地址

@MapperScan({"com.lh.springboot_mybatis.mbg.mapper"})

6.创建自定义注释生成器，映射文件中的注释

public class CommentGenerator extends DefaultCommentGenerator {
    private boolean addRemarkComments = false;
    /**
     * 设置用户配置的参数
     */
    @Override
    public void addConfigurationProperties(Properties properties) {
        super.addConfigurationProperties(properties);
        this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
    }
    /**
     * 给字段添加注释
     */
    @Override
    public void addFieldComment(Field field, IntrospectedTable introspectedTable,
                                IntrospectedColumn introspectedColumn) {
        String remarks = introspectedColumn.getRemarks();
        //根据参数和备注信息判断是否添加备注信息
        if (addRemarkComments && StringUtility.stringHasValue(remarks)) {
            addFieldJavaDoc(field, remarks);
        }
    }
    /**
     * 给model的字段添加注释
     */
    private void addFieldJavaDoc(Field field, String remarks) {
        //文档注释开始
        field.addJavaDocLine("/**");
        //获取数据库字段的备注信息
        String[] remarkLines = remarks.split(System.getProperty("line.separator"));
        for (String remarkLine : remarkLines) {
            field.addJavaDocLine(" * " + remarkLine);
        }
        addJavadocTag(field, false);
        field.addJavaDocLine(" */");
    }

}

7.编写MybatisGenerrator的启动类

public class Generator {
    public static void main(String[] args) throws Exception{
        //MBG 执行过程中的警告信息
        List<String> warnings = new ArrayList<String>();
        //当生成的代码重复时，覆盖原代码
        boolean overwrite = true;
        //读取我们的 MBG 配置文件
        InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(is);
        is.close();

        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        //创建 MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }

    }
}

8.运行Generator的主方法，即可自动生成实体类、Mapper接口以及映射文件

PageHelper的使用

1.原理介绍

1.controller接收分页数据请求后将pageNum和pageSize（第几页和数据页大小）
传递给service处理
2.在service中使用PageHelper工具开启分页，查询数据
3.此时获取的数据不仅仅包含返回数据内容还包含分页的信息（如：当前页，总页数等）
4.因此需要新建类对分页信息和返回数据进行处理，并包装成一个整体返回给用户

2.新建通用分页处理类

1.要对分页信息和返回数据进行处理和包装，由于返回数据类型不明故用泛型
2.该类既是处理类又是信息封装后的对象传递给用户

public class CommonPage<T> {
    private Integer pageNum;//当前页
    private Integer pageSize;//当前页的信息数
    private Integer totalPage;//总页数
    private long total;//总信息数
    private List<T> list;//查询的结果数据

    //处理分页信息，重新包装
    public static <T> CommonPage restPage(List<T> list){
        CommonPage<T> result = new CommonPage<>();
        PageInfo<T> pageInfo = new PageInfo<>(list);
        result.setPageNum(pageInfo.getPageNum());
        result.setPageSize(pageInfo.getPageSize());
        result.setTotalPage(pageInfo.getPages());
        result.setTotal(pageInfo.getTotal());
        result.setList(pageInfo.getList());
        return result;
    }

    @Override
    public String toString() {
        return "CommonPage{" +
                "pageNum=" + pageNum +
                ", pageSize=" + pageSize +
                ", totalPage=" + totalPage +
                ", total=" + total +
                ", list=" + list +
                '}';
    }

    public Integer getPageSize() {
        return pageSize;
    }

    public void setPageSize(Integer pageSize) {
        this.pageSize = pageSize;
    }

    public Integer getTotalPage() {
        return totalPage;
    }

    public void setTotalPage(Integer totalPage) {
        this.totalPage = totalPage;
    }

    public long getTotal() {
        return total;
    }

    public void setTotal(long total) {
        this.total = total;
    }

    public List<T> getList() {
        return list;
    }

    public void setList(List<T> list) {
        this.list = list;
    }

    public Integer getPageNum() {

        return pageNum;
    }

    public void setPageNum(Integer pageNum) {
        this.pageNum = pageNum;
    }
}

3.controller层

依然将通用返回类作为返回值，只是需要封装的数据为通用分页类

@RequestMapping("/list")
@ResponseBody
public CommonResult getPageBrandList(@RequestParam(defaultValue = "1") int pageNum,
                                     @RequestParam(defaultValue = "3") int pageSize){
    return CommonResult.success(pmsBrandService.listPageBrand(pageNum,pageSize));
}

4.service层的方法

public CommonPage listPageBrand(int pageNum,int pageSize) {
    //开启分页查询
    PageHelper.startPage(pageNum,pageSize);
    //分页查询的结果
    //此时查询出来的list不是单纯的数据，里面包含分页的信息，如：总页数，总条数等
    //因此需要用CommonPage.restPage方法进行处理，取出所需信息，重新包装
    List<PmsBrand> list=pmsBrandMapper.selectByExample(new PmsBrandExample());
    return CommonPage.restPage(list);
}

5.查询结果

{
    "code": 200,
    "message": "操作成功",
    "data": {
        "pageNum": 1,
        "pageSize": 2,
        "totalPage": 6,
        "total": 11,
        "list": [
            {
                "id": 1,
                "name": "万和",
                "firstLetter": "W",
                "sort": 0,
                "factoryStatus": 1,
                "showStatus": 1,
                "productCount": 100,
                "productCommentCount": 100,
                "logo": "http://macro-oss.oss-cn-shenzhen.aliyuncs.com/mall/images/20180607/timg(5).jpg",
                "bigPic": "",
                "brandStory": null
            },
            {
                "id": 2,
                "name": "三星",
                "firstLetter": "S",
                "sort": 100,
                "factoryStatus": 1,
                "showStatus": 1,
                "productCount": 100,
                "productCommentCount": 100,
                "logo": "http://macro-oss.oss-cn-shenzhen.aliyuncs.com/mall/images/20180607/timg (1).jpg",
                "bigPic": null,
                "brandStory": null
            }
        ]
    }
}