【MyBatis-Plus】 代码生成器使用指南——快速上手最好用的代码生成器！

MyBatis-Plus 代码生成器使用指南

• • • 1. 简介
    • 2. 环境准备
    • 3. 项目结构
    • 4. 引入依赖
    • 5. 编写代码生成器配置类
    • 6. 配置解释
    • • 6.1 全局配置
      • 6.2 数据源配置
      • 6.3 包配置
      • 6.4 模板配置
      • 6.5 策略配置
    • 7. 运行代码生成器
    • 8. 生成的代码结构
    • 9. 总结

1. 简介

MyBatis-Plus 是一个 MyBatis 的增强工具，简化了 MyBatis 的开发过程。作为一个 ORM 框架，MyBatis-Plus 提供了很多便捷的功能，其中之一就是代码生成器。代码生成器可以根据数据库表结构自动生成相应的实体类、Mapper 接口、Service 接口及其实现类等，大大提高了开发效率，减少了重复劳动。

本文将详细介绍如何使用 MyBatis-Plus 的代码生成器生成 Java 代码，以便快速开始项目开发。

2. 环境准备

在开始之前，请确保已经安装并配置好了以下环境：

• JDK 1.8 或以上版本
• MySQL 数据库
• IntelliJ IDEA 或 Eclipse 等 IDE
• Maven 或 Gradle 构建工具

3. 项目结构

首先，我们需要创建一个标准的 Maven 项目，目录结构如下：

mybatis-plus-generator
├── src
│   ├── main
│   │   ├── java
│   │   └── resources
├── pom.xml
└── README.md

4. 引入依赖

在 pom.xml 文件中引入 MyBatis-Plus 和代码生成器的依赖：

<dependencies>
    <!-- MyBatis-Plus 依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.1</version>
    </dependency>
    
    <!-- MyBatis-Plus 代码生成器依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.4.1</version>
    </dependency>

    <!-- 数据库连接池 -->
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>3.4.5</version>
    </dependency>

    <!-- MySQL 驱动 -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.21</version>
    </dependency>

    <!-- 模板引擎 -->
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.30</version>
    </dependency>
</dependencies>

5. 编写代码生成器配置类

在 src/main/java 目录下创建一个名为 GeneratorCodeConfig 的类，代码如下：

package com.stu.test;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.Scanner;

/**
 * 自动生成mybatisplus的相关代码
 */
public class GeneratorCodeConfig {

    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.isNotEmpty(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"); // D:\123\ZiRu

        // 代码生成的地址： D:/Stu/src/main/java
        System.out.println(projectPath + "/src/main/java");

        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("bruce"); //作者信息
        gc.setOpen(false);

        //实体属性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 配置自己数据源-----------数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/stu?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false&allowPublicKeyRetrieval=true");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        mpg.setDataSource(dsc);

        // 配置自己包配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.ziru");
        pc.setEntity("bean");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        mpg.setPackageInfo(pc);


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

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

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        //数据库表的前缀
        //strategy.setTablePrefix("tb_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

6. 配置解释

以下是主要配置项的详细解释：

6.1 全局配置

GlobalConfig 类用于配置全局参数：

• setOutputDir：设置代码生成的输出目录。
• setAuthor：设置作者信息。
• setOpen：生成后是否打开输出目录。
• setSwagger2：是否生成 Swagger2 注解。

6.2 数据源配置

DataSourceConfig 类用于配置数据源参数：

• setUrl：数据库连接 URL。
• setDriverName：数据库驱动名称。
• setUsername：数据库用户名。
• setPassword：数据库密码。

6.3 包配置

PackageConfig 类用于配置包名：

• setParent：父包名。
• setEntity：实体类包名。
• setMapper：Mapper 接口包名。
• setService：Service 接口包名。
• setServiceImpl：Service 实现类包名。

6.4 模板配置

TemplateConfig 类用于配置模板路径：

• setXml：设置 XML 文件模板路径。此处设置为 null，表示不生成 XML 文件。

6.5 策略配置

StrategyConfig 类用于配置生成策略：

• setNaming：数据库表映射到实体的命名策略。
• setColumnNaming：数据库表字段映射到实体的命名策略。
• setInclude：需要生成的表名，多个表名用逗号分割。
• setControllerMappingHyphenStyle：是否开启驼峰转连字符。

7. 运行代码生成器

运行 GeneratorCodeConfig 类的 main 方法，根据提示输入表名，代码生成器将自动生成与表对应的实体类、Mapper 接口、Service 接口及其实现类等文件。

8. 生成的代码结构

生成的代码结构如下：

src/main/java
└── com
    └── ziru
        ├── bean
        │   └── <Entity>.java
        ├── mapper
        │   └── <Entity>Mapper.java
        ├── service
        │   └── <Entity>Service.java
        └── service
            └── impl
                └── <Entity>ServiceImpl.java

9. 总结

通过 MyBatis-Plus 的代码生成器，开发者可以快速生成基础的 CRUD 代码，大大提高了开发效率，减少了重复劳动。本文详细介绍了如何配置和使用 MyBatis-Plus 的代码生成器，帮助开发者更好地理解和应用这一工具。更多详细信息和高级配置可以参考 MyBatis-Plus 官方文档。