Bootstrap

MybatisPlus代码生成器

1.前言 

        MyBatis-Plus 的代码生成器主要是基于 MyBatis-Plus 的元数据分析功能,通过读取数据库中的表结构信息,生成对应的 Entity、Mapper、Service、Controller 等代码文件。

  1. 元数据分析: 代码生成器首先连接到数据库,读取数据库中的表结构信息,包括表名、字段名、字段类型、注释等元数据信息。

  2. 模板引擎: 代码生成器使用模板引擎来生成代码文件。模板文件定义了生成文件的结构和内容,其中可以包含一些占位符,用于动态替换成实际的数据,如表名、字段名等。

  3. 代码生成: 根据元数据信息和模板文件,代码生成器生成对应的 Java 代码文件。生成的文件包括 Entity 类(对应数据库表的字段)、Mapper 接口(提供数据库操作方法)、Service 类(封装业务逻辑)、Controller 类(处理 HTTP 请求)等。

  4. 自定义配置: 代码生成器提供了丰富的配置选项,可以根据用户的需求进行灵活配置。用户可以指定生成的包名、输出路径、命名规则等,以满足不同项目的需求。

  5. 执行生成: 用户运行代码生成器的程序,代码生成器根据配置信息读取数据库表结构,并根据模板文件生成对应的代码文件,最终输出到指定的路径中。

总的来说,MyBatis-Plus 的代码生成器利用数据库的元数据信息和模板文件,自动化地生成与数据库表对应的 Java 代码文件,极大地提高了开发效率,减少了重复劳动。

这个代码生成器的原理就跟造句一样,公共的部分给你生成出来,让你配置一个配置类进行填空即可,

这个mapper接口其中的book也就是我们需要填的空。

 上面的pojo也是我们需要填的空,而模版是mybatis-plus通过用户的使用和分析进行抽取的。 

 2. 引入依赖

<!--        使用mybatis_plus的代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
<!--        velocity模板引擎-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
<!--        导入mybatis_plus依赖 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>

3. 配置 MyBatis-Plus 代码生成器

创建一个代码生成器配置类,配置生成器的策略、包名、输出路径等信息。

package com.csy;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;

public class CodeGenerator {
    public static void main(String[] args) {
        //1.获取代码生成器的对象
        AutoGenerator autoGenerator = new AutoGenerator();

        //设置数据库相关配置
        DataSourceConfig dataSource = new DataSourceConfig();
        dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/amount?serverTimezone=UTC");
        dataSource.setUsername("root");
        dataSource.setPassword("123456");
        autoGenerator.setDataSource(dataSource);

        //设置全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir("D:\\SSM\\mybatis_plus\\src\\main\\java");    //设置代码生成位置
        globalConfig.setOpen(false);    //设置生成完毕后是否打开生成代码所在的目录
        globalConfig.setAuthor("风止");    //设置作者
        globalConfig.setFileOverride(true);     //设置是否覆盖原始生成的文件
        globalConfig.setMapperName("%sDao");    //设置数据层接口名,%s为占位符,指代模块名称
        globalConfig.setIdType(IdType.ASSIGN_ID);   //设置Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);

        //设置包名相关配置
        PackageConfig packageInfo = new PackageConfig();
        packageInfo.setParent("com.aaa");   //设置生成的包名,与代码所在位置不冲突,二者叠加组成完整路径
        packageInfo.setEntity("domain");    //设置实体类包名
        packageInfo.setMapper("dao");   //设置数据层包名
        autoGenerator.setPackageInfo(packageInfo);

        //策略设置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("user");  //设置当前参与生成的表名,参数为可变参数
//        strategyConfig.setTablePrefix("tbl_");  //设置数据库表的前缀名称,模块名 = 数据库表名 - 前缀名  例如: User = tbl_user - tbl_
        strategyConfig.setRestControllerStyle(true);    //设置是否启用Rest风格
        strategyConfig.setVersionFieldName("version");  //设置乐观锁字段名
        strategyConfig.setLogicDeleteFieldName("deleted");  //设置逻辑删除字段名
        strategyConfig.setEntityLombokModel(true);  //设置是否启用lombok
        autoGenerator.setStrategy(strategyConfig);
        //2.执行生成操作
        autoGenerator.execute();
    }
}

总结

通过 MyBatis-Plus 的代码生成器,我们可以快速生成项目的基本代码,节省开发时间,提高开发效率。同时,生成器提供了丰富的配置选项,可以根据项目需求进行灵活配置。

希望这篇文章对你有帮助!


这篇博客详细介绍了如何配置和使用 MyBatis-Plus 的代码生成器,在 Spring Boot 项目中快速生成基本的代码。你可以根据自己的实际需求进一步扩展和优化代码生成器的配置。

;