滚雪球学MyBatis-Plus(10)：代码生成器

bug菌¹

于 2024-09-04 16:21:41 发布

阅读量708

点赞数 27

文章标签：零基础入门教学 mybatis-plus 代码生成器

本文链接：https://blog.csdn.net/weixin_43970743/article/details/141028538

版权

滚雪球学 MyBatis-Plus(10)：代码生成器

前言

在上期内容中，我们深入探讨了 MyBatis Plus 的乐观锁和性能优化技术。通过这些技术，我们能够在并发环境中保持数据的一致性，并显著提高应用程序的运行效率。我们详细介绍了如何配置和使用乐观锁、性能分析插件、分页优化、缓存配置以及索引优化。

本期内容将重点介绍 MyBatis Plus 的代码生成器。代码生成器能够自动生成实体类、Mapper 接口、服务类、控制器和 XML 映射文件，显著提高开发效率，减少重复劳动。通过本期内容，你将学会如何配置和使用代码生成器，并将其应用到实际项目中。

一、代码生成器简介

MyBatis Plus 的代码生成器是一款强大的工具，可以根据数据库表结构自动生成相应的代码文件。这些文件包括实体类、Mapper 接口、服务类、控制器以及 XML 映射文件。代码生成器支持高度自定义，可以根据需求生成符合项目规范的代码。

二、配置代码生成器

添加依赖

在 pom.xml 中添加代码生成器的依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.0</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

配置代码生成器

在 src/test/java/com/example/mybatisplusdemo 目录下创建 CodeGenerator 类，配置代码生成器：

package com.example.mybatisplusdemo;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
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.VelocityTemplateEngine;

import java.util.Scanner;

public class CodeGenerator {

    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入").append(tip).append("：");
        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("your_name");
        gc.setOpen(false);
        gc.setSwagger2(true); // 实体属性 Swagger2 注解
        gc.setIdType(IdType.AUTO);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus_demo?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=UTC");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("your_password");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

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

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

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("com.example.mybatisplusdemo.common.BaseEntity");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setSuperControllerClass("com.example.mybatisplusdemo.common.BaseController");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setSuperEntityColumns("id");
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new VelocityTemplateEngine());
        mpg.execute();
    }
}

三、使用代码生成器

运行代码生成器
- 在 IDE 中运行 CodeGenerator 类，按照提示输入模块名和表名。代码生成器将根据输入生成相应的代码文件。
生成的代码文件
- 代码生成器将根据数据库表结构生成以下代码文件：
  - 实体类：src/main/java/com/example/mybatisplusdemo/entity/YourEntity.java
  - Mapper 接口：src/main/java/com/example/mybatisplusdemo/mapper/YourEntityMapper.java
  - 服务类：src/main/java/com/example/mybatisplusdemo/service/YourEntityService.java
  - 服务实现类：src/main/java/com/example/mybatisplusdemo/service/impl/YourEntityServiceImpl.java
  - 控制器：src/main/java/com/example/mybatisplusdemo/controller/YourEntityController.java
  - XML 映射文件：src/main/resources/mapper/YourEntityMapper.xml

四、代码生成器的自定义配置

代码生成器支持高度自定义，可以根据项目需求生成符合规范的代码。

自定义模板
- 可以在 src/main/resources/templates 目录下自定义代码生成模板。例如，自定义实体类模板：
```
#parse("templates/entity.java.vm")
public class ${entity} {
    // 自定义内容
}
```

自定义文件输出

可以在 InjectionConfig 中自定义文件输出路径和内容：

InjectionConfig cfg = new InjectionConfig() {
    @Override
    public void initMap() {
        // to do nothing
    }
};
List<FileOutConfig> focList = new ArrayList<>();
focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
    @Override
    public String outputFile(TableInfo tableInfo) {
        // 自定义输出文件名，如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
        return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
    }
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);