Mybatis——》mybatis-plus-generator代码生成器

- 日理万妓 2024-04-08 09:04 207阅读 0赞

推荐链接：
总结——》【Java】
总结——》【Mysql】
总结——》【Spring】
总结——》【SpringBoot】
总结——》【MyBatis、MyBatis-Plus】

Mybatis——》mybatis-plus-generator代码生成器

  • 一、数据库
  • 二、项目结构
  • 三、添加pom依赖
  • 四、创建代码生成器类
    • 1、3.5.1以下版本
    • 2、3.5.1 及其以上版本
  • 五、执行main方法
  • 六、测试

https://gitee.com/xiaoxianwansui/springboot-mybatisplus-generator

一、数据库

  1. /*
  2.     Schema：test
  3.     Info：测试数据库
  4.     Date：2022/09/07 13:49:38
  5. */
  6. -- 1、创建数据库
  7. CREATE
  8. DATABASE `xiaoxian` CHARACTER SET 'utf8' COLLATE 'utf8_general_ci';
  10. -- 2、创建表
  11. DROP TABLE IF EXISTS `user`;
  12. CREATE TABLE `user`
  13. (
  14.     `id`          bigint   NOT NULL AUTO_INCREMENT,
  15.     `name`        varchar(10) CHARACTER SET utf8 COLLATE utf8_general_ci DEFAULT NULL,
  16.     `version`     int      NOT NULL                                      DEFAULT '0' COMMENT '乐观锁版本号',
  17.     `is_delete`   tinyint(1) NOT NULL DEFAULT '0' COMMENT '逻辑删除标识1:已删除,0:未删除',
  18.     `create_user` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '创建用户',
  19.     `create_time` datetime NOT NULL                                      DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  20.     `update_time` datetime NOT NULL                                      DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
  21.     `update_user` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '更新用户',
  22.     PRIMARY KEY (`id`) USING BTREE
  23. ) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb3 ROW_FORMAT=DYNAMIC;
  25. -- 3、插入数据
  26. INSERT INTO `xiaoxian`.`user` (`id`, `name`, `version`, `is_delete`, `create_user`, `create_time`, `update_time`,
  27.                                `update_user`)
  28. VALUES (1, '赵', 0, 0, 'system', '2022-08-16 13:44:57', '2022-08-16 13:45:11', 'system');
  29. INSERT INTO `xiaoxian`.`user` (`id`, `name`, `version`, `is_delete`, `create_user`, `create_time`, `update_time`,
  30.                                `update_user`)
  31. VALUES (2, '钱', 0, 0, 'system', '2022-08-16 13:44:57', '2022-08-16 13:45:11', 'system');
  32. INSERT INTO `xiaoxian`.`user` (`id`, `name`, `version`, `is_delete`, `create_user`, `create_time`, `update_time`,
  33.                                `update_user`)
  34. VALUES (3, '孙', 0, 0, 'system', '2022-08-16 13:44:57', '2022-08-16 13:45:11', 'system');
  35. INSERT INTO `xiaoxian`.`user` (`id`, `name`, `version`, `is_delete`, `create_user`, `create_time`, `update_time`,
  36.                                `update_user`)
  37. VALUES (4, '李', 0, 0, 'system', '2022-08-16 13:44:57', '2022-08-16 13:45:11', 'system');

二、项目结构

在这里插入图片描述

三、添加pom依赖

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.   <modelVersion>4.0.0</modelVersion>
  5.   <parent>
  6.     <groupId>org.springframework.boot</groupId>
  7.     <artifactId>spring-boot-starter-parent</artifactId>
  8.     <version>2.7.1</version>
  9.     <relativePath/>
  10.   </parent>
  11.   <groupId>com.xiaoxian</groupId>
  12.   <artifactId>mybatisplus-generator</artifactId>
  13.   <version>0.0.1-SNAPSHOT</version>
  14.   <name>generator</name>
  15.   <description>springboot-mybatisplus-generator</description>
  16.   <properties>
  17.     <java.version>1.8</java.version>
  18.     <druid.version>1.1.22</druid.version>
  19.     <mybatis.plus.version>3.4.1</mybatis.plus.version>
  20.     <!--        <mybatis.plus.version>3.5.1</mybatis.plus.version>-->
  21.     <guava.version>28.2-jre</guava.version>
  22.     <knife4j.version>2.0.8</knife4j.version>
  23.     <fastjson.version>1.2.70</fastjson.version>
  24.   </properties>
  25.   <dependencies>
  26.     <dependency>
  27.       <groupId>org.springframework.boot</groupId>
  28.       <artifactId>spring-boot-starter-web</artifactId>
  29.     </dependency>
  30.     <dependency>
  31.       <groupId>org.springframework.boot</groupId>
  32.       <artifactId>spring-boot-starter-jdbc</artifactId>
  33.     </dependency>
  34.     <dependency>
  35.       <groupId>mysql</groupId>
  36.       <artifactId>mysql-connector-java</artifactId>
  37.       <scope>runtime</scope>
  38.     </dependency>
  39.     <dependency>
  40.       <groupId>com.alibaba</groupId>
  41.       <artifactId>druid-spring-boot-starter</artifactId>
  42.       <version>${druid.version}</version>
  43.     </dependency>
  44.     <!-- mybatis-plus start-->
  45.     <dependency>
  46.       <groupId>com.baomidou</groupId>
  47.       <artifactId>mybatis-plus-boot-starter</artifactId>
  48.       <version>${mybatis.plus.version}</version>
  49.     </dependency>
  51.     <dependency>
  52.       <groupId>com.baomidou</groupId>
  53.       <artifactId>mybatis-plus</artifactId>
  54.       <version>${mybatis.plus.version}</version>
  55.     </dependency>
  56.     <!-- mybatis-plus generator start-->
  57.     <dependency>
  58.       <groupId>com.baomidou</groupId>
  59.       <artifactId>mybatis-plus-generator</artifactId>
  60.       <version>${mybatis.plus.version}</version>
  61.     </dependency>
  63.     <dependency>
  64.       <groupId>org.apache.velocity</groupId>
  65.       <artifactId>velocity-engine-core</artifactId>
  66.       <version>2.2</version>
  67.     </dependency>
  69.     <!--test start-->
  70.     <dependency>
  71.       <groupId>org.springframework.boot</groupId>
  72.       <artifactId>spring-boot-starter-test</artifactId>
  73.       <scope>test</scope>
  74.     </dependency>
  76.     <!--lombok start-->
  77.     <dependency>
  78.       <groupId>org.projectlombok</groupId>
  79.       <artifactId>lombok</artifactId>
  80.       <optional>true</optional>
  81.     </dependency>
  83.       <!-- swagger start -->
  84.       <dependency>
  85.       <groupId>com.google.guava</groupId>
  86.       <artifactId>guava</artifactId>
  87.       <version>${guava.version}</version>
  88.     </dependency>
  89.       <dependency>
  90.       <groupId>com.github.xiaoymin</groupId>
  91.       <artifactId>knife4j-spring-boot-starter</artifactId>
  92.       <version>${knife4j.version}</version>
  93.     </dependency>
  94.       <dependency>
  95.       <groupId>com.github.xiaoymin</groupId>
  96.       <artifactId>knife4j-aggregation-spring-boot-starter</artifactId>
  97.       <version>${knife4j.version}</version>
  98.     </dependency>
  100.       <!--fastjson start-->
  101.       <dependency>
  102.       <groupId>com.alibaba</groupId>
  103.       <artifactId>fastjson</artifactId>
  104.       <version>${fastjson.version}</version>
  105.     </dependency>
  106.     </dependencies>
  108.       <build>
  110.     </build>
  112.     </project>

四、创建代码生成器类

1、3.5.1以下版本

3.4.1

  1. package com.xiaoxian.mybatisplusgenerator;
  3. import com.baomidou.mybatisplus.core.toolkit.StringPool;
  4. import com.baomidou.mybatisplus.generator.AutoGenerator;
  5. import com.baomidou.mybatisplus.generator.InjectionConfig;
  6. import com.baomidou.mybatisplus.generator.config.*;
  7. import com.baomidou.mybatisplus.generator.config.builder.ConfigBuilder;
  8. import com.baomidou.mybatisplus.generator.config.po.TableInfo;
  9. import com.baomidou.mybatisplus.generator.config.rules.FileType;
  10. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  11. import lombok.extern.slf4j.Slf4j;
  13. import java.io.File;
  14. import java.util.ArrayList;
  15. import java.util.HashMap;
  16. import java.util.List;
  17. import java.util.Map;
  19. @Slf4j
  20.     public class CodeGenerator {
  23.         public static void generator(String projectPath, String projectName, String modulename, String mysqlUrl, String username, String password, String tableNams, String tablePrefix,
  24.                                      String superEntityClass) {
  26.             // 代码生成器
  27.             AutoGenerator mpg = new AutoGenerator();
  29.             modulename = modulename == null ? "" : modulename;
  30.             // 全局配置
  31.             GlobalConfig gc = new GlobalConfig();
  33.             gc.setOutputDir("/src/main/java");
  35.             gc.setFileOverride(true);
  36.             gc.setActiveRecord(true);
  37.             gc.setEnableCache(false);// XML 二级缓存
  38.             gc.setBaseResultMap(true);// XML ResultMap
  39.             gc.setBaseColumnList(true);// XML columList
  41.             gc.setAuthor("xiaoxian");
  42.             gc.setOpen(false);
  43.             gc.setSwagger2(true);
  44.             mpg.setGlobalConfig(gc);
  46.             // 数据源配置
  47.             DataSourceConfig dsc = new DataSourceConfig();
  48.             dsc.setUrl("jdbc:mysql://" + mysqlUrl + "?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&zeroDateTimeBehavior=convertToNull&useSSL=false");
  49.             dsc.setDriverName("com.mysql.jdbc.Driver");
  50.             dsc.setUsername(username);
  51.             dsc.setPassword(password);
  52.             mpg.setDataSource(dsc);
  54.             // 包配置
  55.             PackageConfig pc = new PackageConfig();
  56.             pc.setModuleName(modulename);
  57.             pc.setParent("com.xiaoxian." + projectName);
  58.             pc.setEntity("entity");
  59.             pc.setXml("mapper");
  60.             pc.setMapper("mapper");
  61.             pc.setService("service");
  62.             pc.setServiceImpl("service.impl");
  63.             pc.setController("controller");
  65.             Map<String, String> map = new HashMap();
  66.             map.put(ConstVal.ENTITY_PATH, projectPath + gc.getOutputDir() + "/com/xiaoxian/" + "/" + projectName + modulename + "/entity");
  67.             map.put(ConstVal.SERVICE_PATH, projectPath + gc.getOutputDir() + "/com/xiaoxian/" + "/" + projectName + modulename + "/service");
  68.             map.put(ConstVal.SERVICE_IMPL_PATH, projectPath + gc.getOutputDir() + "/com/xiaoxian/" + projectName + "/" + modulename + "/service/impl");
  69.             map.put(ConstVal.MAPPER_PATH, projectPath + gc.getOutputDir() + "/com/xiaoxian/" + "/" + projectName + modulename + "/mapper");
  70.             map.put(ConstVal.XML_PATH, projectPath + "/src/main/resources/mapper");
  71.                     map.put(ConstVal.CONTROLLER_PATH, projectPath + gc.getOutputDir() + "/com/xiaoxian/" + "/" + projectName + modulename + "/controller");
  73.                     pc.setPathInfo(map);
  74.                     mpg.setPackageInfo(pc);
  76.                     // 自定义配置
  77.                     InjectionConfig cfg = new InjectionConfig() {
  79.                     @Override
  80.                     public void initMap() {
  82.                     // to do nothing
  83.                     }
  84.                     };
  86.                     // 如果模板引擎是 freemarker
  87.                     //        String templatePath = "/templates/mapper.xml.ftl";
  88.                     // 如果模板引擎是 velocity
  89.                     String templatePath = "/templates/mapper.xml.vm";
  91.                     // 自定义输出配置
  92.                     List<FileOutConfig> focList = new ArrayList<>();
  93.                     // 自定义配置会被优先输出
  94.                     focList.add(new FileOutConfig(templatePath) {
  96.                     @Override
  97.                     public String outputFile(TableInfo tableInfo) {
  99.                     // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
  100.                     return projectPath + "/src/main/resources/mapper/"
  101.                     + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
  102.                     }
  103.                     });
  105.                     cfg.setFileCreate(new IFileCreate() {
  107.                     @Override
  108.                     public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
  110.                     // 判断自定义文件夹是否需要创建
  111.                     checkDir(filePath);
  112.                     if (fileType == FileType.MAPPER) {
  114.                     // 已经生成 mapper 文件判断存在，不想重新生成返回 false
  115.                     return !new File(filePath).exists();
  116.                     }
  117.                     // 允许生成模板文件
  118.                     return true;
  119.                     }
  120.                     });
  122.                     cfg.setFileOutConfigList(focList);
  123.                     mpg.setCfg(cfg);
  125.                     // 配置模板
  126.                     TemplateConfig templateConfig = new TemplateConfig();
  128.                     // 配置自定义输出模板
  129.                     //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
  130.                     // templateConfig.setEntity("templates/entity2.java");
  131.                     // templateConfig.setService();
  132.                     // templateConfig.setController();
  134.                     templateConfig.setXml(null);
  135.                     mpg.setTemplate(templateConfig);
  137.                     // 策略配置
  138.                     StrategyConfig strategy = new StrategyConfig();
  139.                     strategy.setNaming(NamingStrategy.underline_to_camel);
  140.                     strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  141.                     strategy.setSuperEntityClass(superEntityClass);
  142.                     strategy.setEntityLombokModel(true);
  143.                     strategy.setRestControllerStyle(true);
  145.                     // 公共父类
  146.                     //        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
  147.                     // 写于父类中的公共字段
  149.                     strategy.setSuperEntityColumns("id", "version", "is_delete", "create_time", "update_time", "update_user", "create_user");
  150.                     strategy.setInclude(tableNams.split(","));
  151.                     strategy.setControllerMappingHyphenStyle(true);
  152.                     strategy.setTablePrefix(tablePrefix);
  153.                     mpg.setStrategy(strategy);
  154.                     //        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  155.                     mpg.execute();
  156.                     }
  158.                     public static void main(String[] args) {
  160.                     //生成在当前项目路径
  161.                     String projectPath = System.getProperty("user.dir");
  162.                     generator(
  163.                     projectPath,
  164.                     "mybatisplusgenerator",
  165.                     "",
  166.                     "127.0.0.1:3306/test",
  167.                     "root",
  168.                     "123456",
  169.                     "user",
  170.                     "t_",
  171.                     "com.xiaoxian.mybatisplusgenerator.common.BaseEntity"
  172.                     );
  173.                     }
  175.                     }

2、3.5.1 及其以上版本

3.5.1

  1. package com.xiaoxian.mybatisplusgenerator;
  3. import com.baomidou.mybatisplus.generator.FastAutoGenerator;
  4. import com.baomidou.mybatisplus.generator.config.OutputFile;
  5. import lombok.extern.slf4j.Slf4j;
  7. import java.util.HashMap;
  8. import java.util.Map;
  10. @Slf4j
  11.     public class CodeGeneratorNew {
  14.         public static void generator(String projectPath, String projectName, String modulename, String mysqlUrl, String username, String password, String tableNams, String tablePrefix,
  15.                                      String superEntityClass) {
  18.             String javaDir = projectPath + "/src/main/java";
  19.             String resourcesDir = projectPath + "/src/main/resources";
  21.             Map<OutputFile, String> map = new HashMap();
  23.             map.put(OutputFile.entity, javaDir + "/com/xiaoxian/" + "/" + projectName + modulename + "/entity");
  24.             map.put(OutputFile.service, javaDir + "/com/xiaoxian/" + "/" + projectName + modulename + "/service");
  25.             map.put(OutputFile.serviceImpl, javaDir + "/com/xiaoxian/" + projectName + "/" + modulename + "/service/impl");
  26.             map.put(OutputFile.mapper, javaDir + "/com/xiaoxian/" + "/" + projectName + modulename + "/mapper");
  27.             map.put(OutputFile.mapperXml, resourcesDir + "/mapper");
  28.             map.put(OutputFile.controller, javaDir + "/com/xiaoxian/" + "/" + projectName + modulename + "/controller");
  31.             FastAutoGenerator.create("jdbc:mysql://" + mysqlUrl + "?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&zeroDateTimeBehavior=convertToNull&useSSL=false", username, password)
  32.                 .globalConfig(builder -> {
  34.                     builder.author("xiaoxiao") // 设置作者
  35.                         .enableSwagger() // 开启 swagger 模式
  36.                         .fileOverride() // 覆盖已生成文件
  37.                         .outputDir(javaDir); // 指定输出目录
  38.                 })
  40.                 .packageConfig(builder -> {
  42.                     builder.parent("com.xiaoxian.mybatisplusgenerator") // 设置父包名
  43.                         .entity("entity")
  44.                         .mapper("mapper")
  45.                         .moduleName("") // 设置父包模块名
  46.                         .pathInfo(map); // 设置mapperXml生成路径
  47.                 })
  48.                 .strategyConfig(builder -> {
  50.                     builder.addInclude("user") // 设置需要生成的表名
  51.                         .addTablePrefix("cms_", "c_") // 设置过滤表前缀
  52.                         .entityBuilder().enableLombok().enableChainModel().enableActiveRecord().superClass(superEntityClass)
  53.                         ;
  54.                 })
  55.                 //                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
  56.                 .execute();
  58.         }
  60.         public static void main(String[] args) {
  62.             //生成在当前项目路径
  63.             String projectPath = System.getProperty("user.dir");
  64.             generator(
  65.                 projectPath,
  66.                 "mybatisplusgenerator",
  67.                 "",
  68.                 "127.0.0.1:3306/xiaoxian",
  69.                 "root",
  70.                 "123456",
  71.                 "user",
  72.                 "t_",
  73.                 "com.xiaoxian.mybatisplusgenerator.common.BaseEntity"
  74.                 );
  75.                 }
  77.                 }

五、执行main方法

在这里插入图片描述

六、测试

  1. package com.xiaoxian.mybatisplusgenerator;
  3. import com.xiaoxian.mybatisplusgenerator.service.IUserService;
  4. import org.junit.jupiter.api.Test;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.boot.test.context.SpringBootTest;
  8. @SpringBootTest
  9. class ApplicationTests {
  12.     @Autowired
  13.     IUserService userService;
  15.     @Test
  16.     void list() {
  18.         System.out.println(userService.list());
  19.     }
  20. }

在这里插入图片描述

发表评论

表情：
评论列表 （有 0 条评论，207人围观）

还没有评论，来说两句吧...

相关阅读

    相关 代码生成器

    如果你是一名后端开发者，那么大多数的工作一定是重复编写各种 CRUD（增删改查）代码。时间长了你会发现，这些工作不仅无趣，还会浪费你的很多时间，没有机会去做更有创造力和挑战的工

    小灰灰小灰灰/ 0 赞/ 207 阅读