Spring Boot整合mybatis-plus-generator代码生成器

mybatis-plus-generator是什么

mybatis-plus-generator是一款代码生成工具，它能帮助我们快速生成数据库表对应的实体类、Mapper等Java文件，大大提升我们的开发效率

mybatis-plus-generator生成代码示例

• 创建一个Spring Boot项目

我这里使用的Spring Boot版本是2.3.6.RELEASE，您自己可以调整相应的版本

• 引入maven依赖

<dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.2</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.2</version>
        </dependency>
        <!--  生成代码时用到了模板引擎  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-freemarker</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

• 创建一张示例表

CREATE TABLE `t_user`  (
   `id` int NOT NULL AUTO_INCREMENT COMMENT '主键',
   `account_number` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '账号',
   `pwd` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '密码',
   `nickname` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '昵称',
   `gender` varchar(16) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '性别：男-male；女-female',
   `avatar` varchar(256) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '头像',
   `phone` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '手机号',
   `email` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '邮箱',
   `state` tinyint NOT NULL DEFAULT 1 COMMENT '用户状态：1-启用',
   `flag` tinyint NOT NULL DEFAULT 1 COMMENT '删除标记：0-删除；1-正常',
   `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
   `update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
   PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 9 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci COMMENT = '用户表' ROW_FORMAT = Dynamic;

• 编写代码生成工具类

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.Collections;

public class CodeGenerateTest {
    // 数据库连接，请改成自己的数据库
    public static final String DATABASE_URL = "jdbc:mysql://localhost:3306/user_center?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC&useSSL=false";
    // 数据库用户名，请改成自己的数据库用户名
    public static final String USERNAME = "root";
    // 数据库密码，请改成自己的数据库密码
    public static final String PASSWORD = "root";
    // java文件生成目录
    public static final String JAVA_OUTPUT_PATH = "D:\\generator\\code-generator";
    // Mapper的xml文件生成目录
    public static final String MAPPER_XML_OUTPUT_PATH = "D:\\generator\\code-generator\\mapper";

    public static void main(String[] args) {
        FastAutoGenerator.create(DATABASE_URL, USERNAME, PASSWORD)
                .globalConfig(builder -> {
                    builder.author("xiaolin") // 设置作者
                            //.enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir(JAVA_OUTPUT_PATH); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.xiaolin.code") // 设置父包名
                            .moduleName("user") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.xml, MAPPER_XML_OUTPUT_PATH)); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.addInclude("t_user") // 设置需要生成的表名
                            .addTablePrefix("t_", "c_")  // 移除表前缀 t_
                            .entityBuilder().enableLombok() // 开启 lombok注解
                            .serviceBuilder().formatServiceFileName("%sService"); // 除去 Service 接口前缀 I; // 设置过滤表前缀
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();
    }

}

• 参考来源
  • Mybatis-Plus官网