Mybatis-Plus使用全解

2019独角兽企业重金招聘Python工程师标准>>>

前言

之前写了《SpringBoot | 第九章：Mybatis-plus的集成和使用》一文，只是简单的使用条件构造器列举了一些通用的CURD操作。本人也想写一篇通用的关于mybatis-plus的使用示例，一方面也让自己更加了解mybatis和mybatis-plus，另一方面，也因为很多新人刚入职公司时，对这块不是很熟悉，会有一些疑惑。所以，总的来说还是作为一份资产，可供人查阅，这样也能减少了很多的沟通成本。

---

所以本章节，就主要来讲解下关于Mybatis-plus的不同场景的用法，目前主要想到的是以下几个知识点，也是很常用的知识点了，后面有补充的会再启章节来记录的。另外，官网的文档已经很详尽了，大家可认真查阅下。

1. 代码生成器
2. 通用的CURD
3. 条件构造器
4. 自定义SQL语句
5. 分页插件、性能分析插件
6. 公共字段自动填充

---

工程准备

这里还是以**user表为例子，数据库为mysql**

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` bigint(20) DEFAULT NULL COMMENT '唯一标示',
  `code` varchar(20) DEFAULT NULL COMMENT '编码',
  `name` varchar(64) DEFAULT NULL COMMENT '名称',
  `status` char(1) DEFAULT '1' COMMENT '状态 1启用 0 停用',
  `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间'
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

关于SpringBoot和Mybatis-plus的集成，这里就不阐述了，这个不是今天的重点。不熟悉的同学，可移步：http://blog.lqdev.cn/2018/07/21/springboot/chapter-nine/进行查看了解。

代码生成器

Mybatis-Plus已经提供了大量的自定义设置，生成的代码完全能够满足各类型的需求，基本覆盖了大部分的配置了。这里贴一个比较完整的代码生成器类，大家可根据实际情况进行修改。

MysqlGenerator.java：

//省略了import
public class MysqlGenerator {

    /**
     * 包名
     */
    private static final String PACKAGE_NAME = "cn.lqdev.learning.mybatisplus.samples";
    /**
     * 模块名称
     */
    private static final String MODULE_NAME = "biz";
    /**
     * 输出文件的路径
     */
    private static final String OUT_PATH = "D:\\develop\\code";
    /**
     * 代码生成者
     */
    private static final String AUTHOR = "oKong";

    /**
     * JDBC相关配置
     */
    private static final String DRIVER = "com.mysql.jdbc.Driver";
    private static final String URL = "jdbc:mysql://127.0.0.1:3306/learning?useUnicode=true&characterEncoding=UTF-8";
    private static final String USER_NAME = "root";
    private static final String PASSWORD = "bs";

    /**
     * <p>
     * MySQL 生成演示
     * </p>
     */
    public static void main(String[] args) {
        // 自定义需要填充的字段
        List<TableFill> tableFillList = new ArrayList<TableFill>();
        //如 每张表都有一个创建时间、修改时间
        //而且这基本上就是通用的了，新增时，创建时间和修改时间同时修改
        //修改时，修改时间会修改，
        //虽然像Mysql数据库有自动更新几只，但像ORACLE的数据库就没有了，
        //使用公共字段填充功能，就可以实现，自动按场景更新了。
        //如下是配置
        TableFill createField = new TableFill("gmt_create", FieldFill.INSERT); 
        TableFill modifiedField = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE); 
        tableFillList.add(createField);
        tableFillList.add(modifiedField);
        
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator().setGlobalConfig(
                // 全局配置
                new GlobalConfig().setOutputDir(OUT_PATH)// 输出目录
                        .setFileOverride(true)// 是否覆盖文件
                        .setActiveRecord(true)// 开启 activeRecord 模式
                        .setEnableCache(false)// XML 二级缓存
                        .setBaseResultMap(false)// XML ResultMap
                        .setBaseColumnList(true)// XML columList
                        .setAuthor(AUTHOR)
                        // 自定义文件命名，注意 %s 会自动填充表实体属性！
                        .setXmlName("%sMapper").setMapperName("%sDao")
        // .setServiceName("MP%sService")
        // .setServiceImplName("%sServiceDiy")
        // .setControllerName("%sAction")
        ).setDataSource(
                // 数据源配置
                new DataSourceConfig().setDbType(DbType.MYSQL)// 数据库类型
                        .setTypeConvert(new MySqlTypeConvert() {
                            // 自定义数据库表字段类型转换【可选】
                            @Override
                            public DbColumnType processTypeConvert(String fieldType) {
                                System.out.println("转换类型：" + fieldType);
                                // if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
                                // return DbColumnType.BOOLEAN;
                                // }
                                return super.processTypeConvert(fieldType);
                            }
                        }).setDriverName(DRIVER).setUsername(USER_NAME).setPassword(PASSWORD).setUrl(URL))
                .setStrategy(