887 字

4 分钟

MyBatisPlus入门

2020-04-14

Java

/

快速入门#

时效注记（2026 更新）：本文基于 MyBatis-Plus 3.3.1（2020）。核心的 CRUD、条件构造器、分页、逻辑删除等用法至今有效，但代码生成器部分已完全重写——文中的 AutoGenerator + GlobalConfig / StrategyConfig 这套 setter API 在 3.5.1 之后已被移除，现在改用 FastAutoGenerator 链式调用。另有两处：IdType.ID_WORKER 自 3.3.0 起弃用（改用 IdType.ASSIGN_ID）；setSwagger2() 已移除。具体见下方代码生成器一节的说明。

使用第三方组件：

1、导入对应的依赖
2、研究依赖如何配置
3、代码如何编写
4、提高扩展技术能力

步骤：

1、创建数据库，2、创建数据表，3、编写项目，初始化项目，4、导入依赖,注意不要同时导入Mybatis和MyBatis-plus
引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、lombok、h2 依赖：

1
<!-- lombok -->
2
<dependency>
3
  <groupId>org.projectlombok</groupId>
4
  <artifactId>lombok</artifactId>
5
  <optional>true</optional>
6
</dependency>
7
<!-- 数据库驱动 -->
8
<dependency>
9
  <groupId>mysql</groupId>
10
  <artifactId>mysql-connector-java</artifactId>
11
</dependency>
12
<!-- mybatisPlus 并不是官方的 -->
13
<dependency>
14
  <groupId>com.baomidou</groupId>
15
  <artifactId>mybatis-plus-boot-starter</artifactId>
16
  <version>3.3.1</version>
17
</dependency>

Mysql 5和8驱动不同5：com.mysql.jdbc.Driver;
8：com.mysql.cj.jdbc.Driver、需要增加时区的配置（驱动8兼容mysql 5版本）

1
# mysql 8
2
spring.datasource.username=root
3
spring.datasource.password=123456
4
spring.datasource.url=jdbc:mysql://localhost:3306/数据库?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
5
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

主键生成策略#

分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法#

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。

代码自动生成器#

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

1
<dependency>
2
  <groupId>com.baomidou</groupId>
3
  <artifactId>mybatis-plus-generator</artifactId>
4
  <version>3.3.1</version>
5
</dependency>

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

1
<dependency>
2
  <groupId>org.apache.velocity</groupId>
3
  <artifactId>velocity-engine-core</artifactId>
4
  <version>2.2</version>
5
</dependency>

1
package com.xkcoding.helloworld;
2
import com.baomidou.mybatisplus.annotation.DbType;
3
import com.baomidou.mybatisplus.annotation.FieldFill;
4
import com.baomidou.mybatisplus.annotation.IdType;
5
import com.baomidou.mybatisplus.generator.AutoGenerator;
6
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
7
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
8
import com.baomidou.mybatisplus.generator.config.PackageConfig;
9
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
10
import com.baomidou.mybatisplus.generator.config.po.TableFill;
11
import com.baomidou.mybatisplus.generator.config.rules.DateType;
12
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
13

14
import java.util.ArrayList;
15

16

17
// 代码自动生成器
18
public class AutoGeneratorCode {
19
    public static void main(String[] args) {
20
        AutoGenerator mpg = new AutoGenerator();
21
        // 配置策略
22
        //1、全局策略
23
        GlobalConfig gc = new GlobalConfig();
24
        String projectPath = System.getProperty("user.dir");
25
        gc.setOutputDir(projectPath+"/src/main/java"); // 设置生成地址
26
        gc.setAuthor("Amadeus");  // 设置作者
27
        gc.setOpen(false); //文件创建好是否打开文件管理器
28
        gc.setFileOverride(false); // 是否覆盖文件
29
        gc.setServiceName("%sService"); //去Service的I 前缀
30
        gc.setIdType(IdType.ID_WORKER);
31
        gc.setDateType(DateType.ONLY_DATE);
32
        gc.setSwagger2(true);
33
        mpg.setGlobalConfig(gc);
34
        // 设置数据源
35
        DataSourceConfig dsc = new DataSourceConfig();
36
        dsc.setUrl("jdbc:mysql://localhost:3306/muxin-dev?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
37
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
38
        dsc.setUsername("root");
39
        dsc.setPassword("密码");
40
        dsc.setDbType(DbType.MYSQL); // 数据库类型
41
        mpg.setDataSource(dsc);
42
        // 包的配置  生成哪些包
43
        PackageConfig pc = new PackageConfig();
44
        pc.setModuleName("blog"); // 模块名
45
        pc.setParent("com.xkcoding.helloworld"); // 生成在哪个包下
46
        pc.setEntity("entity"); // 生成实体 models
47
        pc.setMapper("mapper");
48
        pc.setService("service");
49
        pc.setController("controller");
50
        mpg.setPackageInfo(pc);
51
        // 策略配置
52
        StrategyConfig strategy = new StrategyConfig();
53
        strategy.setInclude("user"); // 设置要映射的表名，可以写多个
54
         strategy.setTablePrefix(new String[] { "user_" });// 此处可以修改为表的前缀
55
        strategy.setNaming(NamingStrategy.underline_to_camel);
56
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
57
        strategy.setEntityLombokModel(true); // 自动lombok
58
        strategy.setLogicDeleteFieldName("deleted"); // 设置逻辑删除
59
        // 自动填充配置
60
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
61
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
62
        ArrayList<TableFill> tableFills = new ArrayList<>();
63
        tableFills.add(gmtCreate);
64
        tableFills.add(gmtModified);
65
        strategy.setTableFillList(tableFills);
66
        // 乐观锁
67
        strategy.setVersionFieldName("version");
68
        strategy.setRestControllerStyle(true);
69
        strategy.setControllerMappingHyphenStyle(true); // localhost:8080/hello_id_2
70
        mpg.setStrategy(strategy);
71
        mpg.execute(); // 执行
72
    }
73
}

上面这套 API 在 MyBatis-Plus 3.5.1 之后已被移除，新版改用 FastAutoGenerator 链式配置，等价写法大致是：
1
FastAutoGenerator.create(URL, USERNAME, PASSWORD)
2
    .globalConfig(builder -> builder
3
        .author("Amadeus")
4
        .outputDir(System.getProperty("user.dir") + "/src/main/java")
5
        .disableOpenDir())
6
    .packageConfig(builder -> builder
7
        .parent("com.xkcoding.helloworld")
8
        .moduleName("blog"))
9
    .strategyConfig(builder -> builder
10
        .addInclude("user")
11
        .addTablePrefix("user_")
12
        .entityBuilder().enableLombok().logicDeleteColumnName("deleted")
13
        .controllerBuilder().enableRestStyle().enableHyphenStyle())
14
    .templateEngine(new VelocityTemplateEngine())
15
    .execute();
另外文中 gc.setIdType(IdType.ID_WORKER) 里的 ID_WORKER 自 3.3.0 起弃用，应改为 IdType.ASSIGN_ID（同样是雪花算法）；gc.setSwagger2(true) 已移除，新版用 .enableSwagger()。

依赖坐标也变了：MySQL 8.0.31 起官方驱动从 mysql:mysql-connector-java 迁到了 com.mysql:mysql-connector-j，旧坐标已不再更新。

MyBatisPlus入门

https://gilgameshzzz.github.io/posts/mybatispluslearning/

作者

Amadeus

发布于

2020-04-14

许可协议