mybatis-plus使用心得，内附demo案例源码

概述，前言

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。简化JDBC操作。

需要一定基础：mybatis、spring、springmvc。

同类型工具：JPA、tk-mapper、mybatis-plus

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，支持简单的CRUD操作
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
• 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

入门

mybatis-plus

使用第三方组件：

1、导入对应依赖

2、研究依赖如何配置

3、研究代码如何编写

4、扩展其他功能使用

步骤：

1、创建数据库

2、创建数据表

包含字段：version-乐观锁，deleted-逻辑删除，gmt_create-创建时间，gmt_modified-修改时间

3、配置spring：

spring.datasource.url: jdbc:mysql://localhost:3306/testmybatisplus?useUnicode=true&characterEncoding=utf-8&userSSL=true&serverTimezone=UTC&tinyInt1isBit=false
# userSSL=true  是否使用安全连接
# useUnicode=true&characterEncoding=utf-8  设置字符集编码 以上是基本配置
# serverTimezone=GMT%2B8（东八区） 时区配置，mysql8 特性
# tinyInt1isBit=false  JAVA数据类型 和 MYSQL的数据类型转换 
# tinyInt(1) 只用来代表Boolean含义的字段，且0代表False，1代表True。如果要存储多个数值，则定义为tinyInt(N), N>1。例如 tinyInt(2)

4、代码编写，注意点：在程序启动类中用@MapperScan("com.example.mptest")扫描mapper包下的所有接口

pojo/user:

package com.example.mptest.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;

}

mapper/UserMapper:

package com.example.mptest.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.mptest.pojo.User;
import org.springframework.stereotype.Repository;

//在对应的mapper上实现继承BaseMapper
@Repository //代表持久层
public interface UserMapper extends BaseMapper<User> {
    //所有CRUD完成
}

//主程序入口（启动类）
package com.example.mptest;

import org.mybatis.spring.annotation.MapperScan;
import org.mybatis.spring.annotation.MapperScans;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@MapperScan("com.example.mptest") //扫描我们的mapper文件夹
@SpringBootApplication
public class MpTestApplication {

    public static void main(String[] args) {
        SpringApplication.run(MpTestApplication.class, args);
    }

}

//test入口
package com.example.mptest;

import com.example.mptest.mapper.UserMapper;
import com.example.mptest.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class MpTestApplicationTests {

    //继承BaseMapper，所有的方法来自父类，我们也可以编写自己的扩展方法
    @Autowired //挂载
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        //参数是wrapper，条件构造器，我们先不用：null
        //查询全部用户
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

结果查询…

配置日志

因为所有的sql在run时不可见，我们希望知道是如何执行的，所以我们必须要看日志

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl  #Default console output ..Sout..

...
Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@5cb042da] was not registered for synchronization because synchronization is not active
2021-10-09 20:21:23.920  INFO 21424 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2021-10-09 20:21:24.936  INFO 21424 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
JDBC Connection [HikariProxyConnection@1462182153 wrapping com.mysql.cj.jdbc.ConnectionImpl@59696551] will not be managed by Spring
==>  Preparing: SELECT id,name,age,email FROM user
==> Parameters: 
<==    Columns: id, name, age, email
<==        Row: 1, Jone, 18, test1@baomidou.com
<==        Row: 2, Jack, 20, test2@baomidou.com
<==        Row: 3, Tom, 28, test3@baomidou.com
<==        Row: 4, Sandy, 21, test4@baomidou.com
<==        Row: 5, Billie, 24, test5@baomidou.com
<==      Total: 5
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@5cb042da]
...
Process finished with exit code 0

CRUD拓展

insert 插入

//测试
 @Test
    public void testInsert(){
        User user = new User();
//        user.setId(6);
        user.setName("Naughty1");
        user.setAge(23);
        user.setEmail("11111.qq.com");

        int result = userMapper.insert(user);
        System.out.println(result);
        System.out.println(user);
    }

自动生成全局唯一ID：1446816845700030465(Long)；

Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4a34e9f] was not registered for synchronization because synchronization is not active
2021-10-09 20:36:31.235  INFO 15736 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2021-10-09 20:36:32.233  INFO 15736 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
JDBC Connection [HikariProxyConnection@100048427 wrapping com.mysql.cj.jdbc.ConnectionImpl@984169e] will not be managed by Spring
==>  Preparing: INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
==> Parameters: 1446816845700030465(Long), Naughty1(String), 23(Integer), 11111.qq.com(String)
<==    Updates: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4a34e9f]
1
User(id=1446816845700030465, name=Naughty1, age=23, email=11111.qq.com)

主键生成策略

分布式系统唯一id生成方案

雪花算法：

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。雪花算法支持的TPS可以达到419万左右（2^22*1000）。

雪花算法在工程实现上有单机版本和分布式版本。单机版本如下，分布式版本可以参看美团leaf算法：https://github.com/Meituan-Dianping/Leaf

@TableId(type= IdType.ID_WORKER) #默认全球唯一id

@TableId(type= IdType.AUTO) #主键自增，数据库字段一定需要自增

其余源码解释：

public enum IdType {
    AUTO(0), //数据库id自增
    NONE(1),  //未设置主键
    INPUT(2),  //手动输入  一旦手动输入必须自己写id
    ASSIGN_ID(3), 	//
    ASSIGN_UUID(4),
    /** @deprecated */
    @Deprecated
    ID_WORKER(3),  //默认的全局唯一id
    /** @deprecated */
    @Deprecated
    ID_WORKER_STR(3),  //ID_WORKER字符串表示法
    /** @deprecated */
    @Deprecated
    UUID(4);  //全局唯一id uuid

    private final int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

update 更新

//测试更新
    @Test
    public void testUpdate(){
        User user = new User();
        user.setId(6L);
        user.setName("zhangsan");
        user.setAge(18);
        //参数是一个对象
        //通过条件自动拼接sql
        int updateById = userMapper.updateById(user);
        System.out.println(updateById);
    }

自动填充

创建时间，修改时间，一般都是自动化完成的，我们不希望手动修改。所有数据库表：gmt_create，gmt_modified几乎所有的表都要配置上，而且需要自动化。

方法一：数据库级别

1、创建数据库create_time、update_time字段

2、设置默认值：CURRENT_TIMESTAMP；设置update_time：根据当前时间进行更新

3、测试：更新数据，数据更新后中会根据当前时间记录在update_time中。

方法二：代码级别

1、清除数据库中自动化设置，恢复初始状态

2、实体类字段属性上增加注解：

//字段填充
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

3、编写处理器来处理注解。handler

package com.example.mptest.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

@Slf4j
@Component //(必写) --一定不要忘记将处理器加到IOC容器中 IOC容器：具有依赖注入功能的容器
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start install fill ....");
        //setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);

    }
}

4、测试插入、更新，验证成功

乐观锁

另外一种，悲观锁。了解：原子引用

定义：

乐观锁：总是认为不会出现问题，无论如何都不去上锁。如果出现了问题，再次更新值测试。version,new version

悲观锁：总是认为会产生出现问题，无论如何都去上锁。再去操作。

乐观锁机制：

OptimisticLockerInnerInterceptor

当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

测试乐观锁插件：

1、给数据库添加字段version。

2、实体类添加对应字段、注解：

@Version //乐观锁version注解
private Integer version;

3、注册组件。config

package com.example.mptest.config;

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

@MapperScan("com.example.mptest") //扫描我们的mapper文件夹 放置扫描类中操作
@EnableTransactionManagement //自动管理事务注解 默认开启
@Configuration //springboot声明配置类
public class MybatisPlusConfig {

    @Bean  //新版
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return interceptor;
    }
}

4、测试

//测试乐观锁：success
    @Test
    public void testOptimisticLocker(){
        //1、查询用户信息
        User user = userMapper.selectById(1L);
        //2、修改用户信息
        user.setName("aaaa");
        user.setEmail("AAA.qq.com");
        //3、执行
        userMapper.updateById(user);

    }
    //fail
    @Test //多线程下
    public void testOptimisticLocker2(){
        //线程1
        User user = userMapper.selectById(1L);
        user.setName("aaaa");
        user.setEmail("AAA.qq.com");

        //模拟另一个线程插队操作
        User user2 = userMapper.selectById(1L);
        user2.setName("bbb");
        user2.setEmail("AAA.qq.com");


        userMapper.updateById(user2);
        //自旋锁来多次尝试提交  JUC操作
        userMapper.updateById(user);//如果没有乐观锁将会覆盖插队线程的值---此操作执行不成功

    }

多线程下，插队线程的值不会被覆盖。

查询操作

//按照id批量查询
@Test
public void testSelectByBatchId() {
    final List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}
//条件查询 map操作
@Test
public void testSelectByBatchIds(){
    final HashMap<String, Object> map = new HashMap<>();
    map.put("name", "Naughty1");
    map.put("age","23");
    final List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

1、原始limit分页查询

2、pagerHelper第三方分页插件

3、mp内置分页插件

使用方法

1、配置拦截器组件

 // 分页查询最新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusPaginationInnerInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }

2、测试

//测试分页查询
@Test
public void testSelectPage(){
    //参数1：当前页，参数2：页面大小
    final Page<User> page = new Page<>(2,5);
    userMapper.selectPage(page,null);
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());//获取数据总数
}

删除操作

1、根据ID删除操作

//删除操作
@Test
public void testDeleteById() {
    userMapper.deleteById(8);
}

2、批量删除

//批量删除操作
@Test
public void testDeleteBatchId() {
    userMapper.deleteBatchIds(Arrays.asList(6, 7));
}

3、通过map删除

//通过map删除
@Test
public void testDeleteMap() {
    final HashMap<String, Object> map = new HashMap<>();
    map.put("name","Naughty");
    userMapper.deleteByMap(map);
}

逻辑删除

物理删除：从数据库中删除

逻辑删除：在数据库中没有被移除，而是通过变量让他失效。deleted=0 =>1

例：管理员可以查看被删除记录。防止数据丢失，类似回收站

1、增加deleted字段

2、增加实体类

@TableLogic     //逻辑删除
private Integer deleted;

3、配置yml

 global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

4、测试—配置后一切删除走的是更新操作（逻辑删除）

//删除操作
    @Test
    public void testDeleteById() {
        userMapper.deleteById(8);
    }

    //批量删除操作
    @Test
    public void testDeleteBatchId() {
        userMapper.deleteBatchIds(Arrays.asList(6, 7));
    }

    //通过map删除
    @Test
    public void testDeleteMap() {
        final HashMap<String, Object> map = new HashMap<>();
        map.put("name","Naughty2");
        userMapper.deleteByMap(map);
    }

    //测试逻辑删除
    @Test
    public void testLogicDelete(){
        userMapper.deleteById(1446816845700030473L);
    }

配置逻辑删除后，被逻辑删除的的数据，使用查询无法查到。

性能分析插件

在开发中，可能会遇到一些慢sql，在测试时可用druid…作用：用于输出每条SQL语句及其执行时间

MP也提供性能分析插件，如果超过这个时间就停止运行。

1、导入

依赖：

<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.0</version>
</dependency>

新增spy.properties配置文件：

#3.2.1以上使用
modulelist=com.baomidou.mybatisplus.extension.p6spy.MybatisPlusLogFactory,com.p6spy.engine.outage.P6OutageFactory
#3.2.1以下使用或者不配置
#modulelist=com.p6spy.engine.logging.P6LogFactory,com.p6spy.engine.outage.P6OutageFactory
# 自定义日志打印
logMessageFormat=com.baomidou.mybatisplus.extension.p6spy.P6SpyLogger
#日志输出到控制台
appender=com.baomidou.mybatisplus.extension.p6spy.StdoutLogger
# 使用日志系统记录 sql
#appender=com.p6spy.engine.spy.appender.Slf4JLogger
# 设置 p6spy driver 代理
deregisterdrivers=true
# 取消JDBC URL前缀
useprefix=true
# 配置记录 Log 例外,可去掉的结果集有error,info,batch,debug,statement,commit,rollback,result,resultset.
excludecategories=info,debug,result,commit,resultset
# 日期格式
dateformat=yyyy-MM-dd HH:mm:ss
# 实际驱动可多个
#driverlist=org.h2.Driver
# 是否开启慢SQL记录
outagedetection=true
# 慢SQL记录标准 2 秒
outagedetectioninterval=2

application.yml 配置：

spring:
  datasource:
    driver-class-name: com.p6spy.engine.spy.P6SpyDriver  #com.mysql.cj.jdbc.Driver
    url: jdbc:p6spy:mysql://localhost:3306/testmybatisplus?useUnicode=true&characterEncoding=utf-8&userSSL=true&serverTimezone=UTC&tinyInt1isBit=false
    username: root
    password: 123456

2、测试使用

使用后打印的日志会标红sql，并且显示所用时间，如果使用时间超过outagedetectioninterval设定的秒数，则会报错提示

条件构造器

参数：wrapper，十分重要，使用wrapper可以将复杂查询条件拆分，进而简单化

说明:

• 以下出现的第一个入参boolean condition表示该条件是否加入最后生成的sql中，例如：query.like(StringUtils.isNotBlank(name), Entity::getName, name) .eq(age!=null && age >= 0, Entity::getAge, age)
• 以下代码块内的多个方法均为从上往下补全个别boolean类型的入参,默认为true
• 以下出现的泛型Param均为Wrapper的子类实例(均具有AbstractWrapper的所有方法)
• 以下方法在入参中出现的R为泛型,在普通wrapper中是String,在LambdaWrapper中是函数(例:Entity::getId,Entity为实体类,getId为字段id的getMethod)
• 以下方法入参中的R column均表示数据库字段,当R具体类型为String时则为数据库字段名(字段名是数据库关键字的自己用转义符包裹!)!而不是实体类数据字段名!!!,另当R具体类型为SFunction时项目runtime不支持eclipse自家的编译器!!!
• 以下举例均为使用普通wrapper,入参为Map和List的均以json形式表现!
• 使用中如果入参的Map或者List为空,则不会加入最后生成的sql中!!!
• 有任何疑问就点开源码看,看不懂函数的点击我学习新知识(opens new window)

警告:
不支持以及不赞成在 RPC 调用中把 Wrapper 进行传输

1. wrapper 很重
2. 传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
3. 正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
4. 我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr

AbstractWrapper

说明:
QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类
用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为

例子：

@Autowired //挂载
private UserMapper userMapper;

@Test
void contextLoads() {
    //复杂查询：name不为空，邮箱不为空，年龄大于20岁
    final QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.isNotNull("name")
        .isNotNull("email")
        .ge("age", 20);
    userMapper.selectList(wrapper).forEach(System.out::println);
}

@Test
void contextLoads2() {
    //复杂查询：单条记录查询
    final QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name", "Jack")
        .isNotNull("email");
    final User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}
@Test
void contextLoads3() {
    //复杂查询：年龄20-30岁
    final QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age", 20,30);
    final Integer user = userMapper.selectCount(wrapper);
    System.out.println(user);
}
@Test
void contextLoads4() {
    //模糊查询
    final QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.notLike("name", "b")
        .likeRight("email", "t");
    final List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}
@Test
void contextLoads5() {
    //id在子查询中查出来
    final QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.inSql("id", "select id from user where id<3");

    final List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

@Test
void contextLoads6() {
    //通过id进行排序
    final QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.orderByDesc("id");

    final List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

代码生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

特别说明:

自定义模板有哪些可用参数？Github (opens new window)AbstractTemplateEngine 类中方法 getObjectMap 返回 objectMap 的所有值都可用。

演示效果图：

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class CodeGenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("jobob");
        gc.setOpen(false);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("密码");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.baomidou.ant");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }

}

更多查看代码生成器配置

使用教程

添加依赖

MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：

• 添加 代码生成器 依赖

  <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-generator</artifactId>
      <version>3.4.1</version>
  </dependency>
  

• 添加 模板引擎 依赖，MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。

  Velocity（默认）：

  <dependency>
      <groupId>org.apache.velocity</groupId>
      <artifactId>velocity-engine-core</artifactId>
      <version>latest-velocity-version</version>
  </dependency>
  

  Freemarker：

  <dependency>
      <groupId>org.freemarker</groupId>
      <artifactId>freemarker</artifactId>
      <version>latest-freemarker-version</version>
  </dependency>
  

  Beetl：

  <dependency>
      <groupId>com.ibeetl</groupId>
      <artifactId>beetl</artifactId>
      <version>latest-beetl-version</version>
  </dependency>
  

  注意！如果您选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。

  AutoGenerator generator = new AutoGenerator();
  
  // set freemarker engine
  generator.setTemplateEngine(new FreemarkerTemplateEngine());
  
  // set beetl engine
  generator.setTemplateEngine(new BeetlTemplateEngine());
  
  // set custom engine (reference class is your custom engine class)
  generator.setTemplateEngine(new CustomTemplateEngine());
  
  // other config
  ...
  

编写配置

MyBatis-Plus 的代码生成器提供了大量的自定义参数供用户选择，能够满足绝大部分人的使用需求。

• 配置 GlobalConfig

  GlobalConfig globalConfig = new GlobalConfig();
  globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
  globalConfig.setAuthor("jobob");
  globalConfig.setOpen(false);
  

• 配置 DataSourceConfig

  DataSourceConfig dataSourceConfig = new DataSourceConfig();
  dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
  dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
  dataSourceConfig.setUsername("root");
  dataSourceConfig.setPassword("password");
  

自定义模板引擎

请继承类 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine

自定义代码模板

//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
//注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
TemplateConfig templateConfig = new TemplateConfig()
    .setEntity("templates/entity2.java");

AutoGenerator mpg = new AutoGenerator();
//配置自定义模板
mpg.setTemplate(templateConfig);

自定义属性注入

InjectionConfig injectionConfig = new InjectionConfig() {
    //自定义属性注入:abc
    //在.ftl(或者是.vm)模板中，通过${cfg.abc}获取属性
    @Override
    public void initMap() {
        Map<String, Object> map = new HashMap<>();
        map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
        this.setMap(map);
    }
};
AutoGenerator mpg = new AutoGenerator();
//配置自定义属性注入
mpg.setCfg(injectionConfig);
entity2.java.ftl
自定义属性注入abc=${cfg.abc}

entity2.java.vm
自定义属性注入abc=$!{cfg.abc}

字段其他信息查询注入

new DataSourceConfig().setDbQuery(new MySqlQuery() {

    /**
     * 重写父类预留查询自定义字段<br>
     * 这里查询的 SQL 对应父类 tableFieldsSql 的查询字段，默认不能满足你的需求请重写它<br>
     * 模板中调用：  table.fields 获取所有字段信息，
     * 然后循环字段获取 field.customMap 从 MAP 中获取注入字段如下  NULL 或者 PRIVILEGES
     */
    @Override
    public String[] fieldCustom() {
        return new String[]{"NULL", "PRIVILEGES"};
    }
})

#自定义属性注入)

InjectionConfig injectionConfig = new InjectionConfig() {
    //自定义属性注入:abc
    //在.ftl(或者是.vm)模板中，通过${cfg.abc}获取属性
    @Override
    public void initMap() {
        Map<String, Object> map = new HashMap<>();
        map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
        this.setMap(map);
    }
};
AutoGenerator mpg = new AutoGenerator();
//配置自定义属性注入
mpg.setCfg(injectionConfig);
entity2.java.ftl
自定义属性注入abc=${cfg.abc}

entity2.java.vm
自定义属性注入abc=$!{cfg.abc}

字段其他信息查询注入

[外链图片转存中…(img-AeCxDHC5-1636549871083)]

new DataSourceConfig().setDbQuery(new MySqlQuery() {

    /**
     * 重写父类预留查询自定义字段<br>
     * 这里查询的 SQL 对应父类 tableFieldsSql 的查询字段，默认不能满足你的需求请重写它<br>
     * 模板中调用：  table.fields 获取所有字段信息，
     * 然后循环字段获取 field.customMap 从 MAP 中获取注入字段如下  NULL 或者 PRIVILEGES
     */
    @Override
    public String[] fieldCustom() {
        return new String[]{"NULL", "PRIVILEGES"};
    }
})

demo源码：https://gitee.com/H9X14s4c/mybatis-plus-test1.git