devbox
Gausst松鼠会
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

mybatis-plus-generator（mybatisplus代码生成器篇）

作者：Gausst松鼠会 | 2024-03-13 23:16:57

赞

踩

mybatis-plus-generator

前言：mybatisplus用了也挺久了，期间用过mybatis的代码生成器，那个主要生成mapper.xml文件，里面基本涵盖了绝大多数常用的方法；项目也用过一些开源框架自带的代码生成器，比如jeecg-boot框架自带的代码生成器，不过那个由于做了一些自定义封装，普适性不是很好，今天记录一下mybatis-plus代码生成器的简单使用（生成基本的controller、service、mapper、mapper.xml），如果感觉功能太少，可以在mybatis-plus自带的模板引擎demo基础上进行自定义改造，下面我们开始正篇吧，废话不多说，上代码：

maven依赖自己酌情增减：

  1.     <parent>
  2. 	    <groupId>org.springframework.boot</groupId>
  3. 	    <artifactId>spring-boot-starter-parent</artifactId>
  4. 	    <version>2.3.5.RELEASE</version>
  5. 	    <relativePath/>
  6. 	</parent>
  7.     
  8.     <properties>
  9.         <java.version>1.8</java.version>
  10.         <lombok.version>1.18.16</lombok.version>
  11.         <freemarker.version>2.3.30</freemarker.version>
  12.         <mybatis-plus.version>3.4.1</mybatis-plus.version>
  13.         <druid.version>1.1.22</druid.version>
  14.         <mysql.version>8.0.22</mysql.version>
  15.     </properties>
  16.  
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>org.springframework.boot</groupId>
  20.             <artifactId>spring-boot-starter-web</artifactId>
  21.         </dependency>
  22.  
  23.         <!--mysql数据库依赖-->
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-jdbc</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>mysql</groupId>
  30.             <artifactId>mysql-connector-java</artifactId>
  31.             <version>${mysql.version}</version>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>com.alibaba</groupId>
  35.             <artifactId>druid-spring-boot-starter</artifactId>
  36.             <version>${druid.version}</version>
  37.         </dependency>
  38.         <dependency>
  39.             <groupId>com.baomidou</groupId>
  40.             <artifactId>mybatis-plus-boot-starter</artifactId>
  41.             <version>${mybatis-plus.version}</version>
  42.         </dependency>
  43.  
  44.         <!--mybatis-plus代码生成器相关依赖-->
  45.         <dependency>
  46.             <groupId>com.baomidou</groupId>
  47.             <artifactId>mybatis-plus-generator</artifactId>
  48.             <version>${mybatis-plus.version}</version>
  49.         </dependency>
  50.         <dependency>
  51.             <groupId>org.freemarker</groupId>
  52.             <artifactId>freemarker</artifactId>
  53.             <version>${freemarker.version}</version>
  54.         </dependency>
  55.  
  56.         <dependency>
  57.             <groupId>org.apache.commons</groupId>
  58.             <artifactId>commons-lang3</artifactId>
  59.             <version>${commons-lang3.version}</version>
  60.         </dependency>
  61.  
  62.         <dependency>
  63.             <groupId>org.projectlombok</groupId>
  64.             <artifactId>lombok</artifactId>
  65.             <version>${lombok.version}</version>
  66.         </dependency>
  67.  
  68.         <dependency>
  69.             <groupId>org.springframework.boot</groupId>
  70.             <artifactId>spring-boot-starter-test</artifactId>
  71.             <scope>test</scope>
  72.         </dependency>
  73.  
  74.     </dependencies>
  75.  
  76.     <build>
  77.         <plugins>
  78.             <plugin>
  79.                 <groupId>org.springframework.boot</groupId>
  80.                 <artifactId>spring-boot-maven-plugin</artifactId>
  81.             </plugin>
  82.         </plugins>
  83.     </build>

代码生成器使用示例：

  1. //执行 main 方法，控制台输入模块表名，回车自动生成对应项目目录中
  2. public class MybatisPlusCodeGenerator {
  3.  
  4.     public static void main(String[] args) {
  5.         //====================配置变量区域=====================//
  6.         String author="";//生成文件的作者，可以不填
  7.         String rootPackage="org.example.xxxx";//生成的entity、controller、service等包所在的公共上一级包路径全限定名
  8.         String moduleName="province-sess-platfrom-xqxy";
  9.         //数据库配置
  10.         String url="jdbc:mysql://192.168.xxx.xxx:3306/xxx?useSSL=false&characterEncoding=utf8";
  11.         String driverClassName="com.mysql.jdbc.Driver";//或者com.mysql.cj.jdbc.Driver
  12.         String username="root";
  13.         String password="xxxxxx";
  14.         String tableNames="annualplan";//表名，多个使用,分隔
  15.         //====================配置变量区域=====================//
  16.  
  17.         // 代码生成器
  18.         AutoGenerator generator = new AutoGenerator();
  19.         // 全局配置
  20.         GlobalConfig globalConfig = new GlobalConfig();
  21.         String projectPath = System.getProperty("user.dir");
  22.         globalConfig.setOutputDir(projectPath +"/"+moduleName+"/src/main/java");
  23.         globalConfig.setFileOverride(false);//是否覆盖已有文件，默认false
  24.         globalConfig.setOpen(false);//是否打开输出目录
  25.         globalConfig.setAuthor(author);
  26.         globalConfig.setServiceName("%sService");//去掉service接口的首字母I
  27.         globalConfig.setBaseResultMap(true);//开启 BaseResultMap
  28.         globalConfig.setDateType(DateType.ONLY_DATE);//只使用 java.util.date代替
  29.         globalConfig.setIdType(IdType.ASSIGN_ID);//分配ID (主键类型为number或string）
  30.         generator.setGlobalConfig(globalConfig);
  31.  
  32.         // 数据源配置
  33.         DataSourceConfig dataSourceConfig = new DataSourceConfig();
  34.         dataSourceConfig.setUrl(url);
  35.         dataSourceConfig.setDbType(DbType.MYSQL);//数据库类型
  36.         dataSourceConfig.setDriverName(driverClassName);
  37.         dataSourceConfig.setUsername(username);
  38.         dataSourceConfig.setPassword(password);
  39.         generator.setDataSource(dataSourceConfig);
  40.  
  41.         // 包配置
  42.         PackageConfig packageConfig = new PackageConfig();
  43.         //packageConfig.setModuleName(scanner("模块名"));
  44.         packageConfig.setParent(rootPackage);//例：org.jeecg.modules.xqxy
  45.         generator.setPackageInfo(packageConfig);
  46.  
  47.         //注意：模板引擎在mybatisplus依赖中的templates目录下，可以依照此默认模板进行自定义
  48.  
  49.         // 策略配置：配置根据哪张表生成代码
  50.         StrategyConfig strategy = new StrategyConfig();
  51.         strategy.setInclude(tableNames);//表名，多个英文逗号分割（与exclude二选一配置）
  52.         strategy.setNaming(NamingStrategy.underline_to_camel);
  53.         strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  54.         //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
  55.         strategy.setEntityLombokModel(true);//lombok模型，@Accessors(chain = true)setter链式操作
  56.         strategy.setRestControllerStyle(true);//controller生成@RestController
  57.         strategy.setEntityTableFieldAnnotationEnable(true);//是否生成实体时，生成字段注解
  58.  
  59.         generator.setStrategy(strategy);
  60.         generator.setTemplateEngine(new FreemarkerTemplateEngine());
  61.         generator.execute();
  62.     }
  63.  
  64. }

详细配置可以在idea中查看配置类注释，download source，里面的注释都是中文的，比较详细。

 模板引擎在mybatisplus依赖中的templates目录下，可以依照此默认模板进行自定义：

controller.java.ftl:

  1. package ${package.Controller};
  2.  
  3.  
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5.  
  6. <#if restControllerStyle>
  7. import org.springframework.web.bind.annotation.RestController;
  8. <#else>
  9. import org.springframework.stereotype.Controller;
  10. </#if>
  11. <#if superControllerClassPackage??>
  12. import ${superControllerClassPackage};
  13. </#if>
  14.  
  15. /**
  16.  * <p>
  17.  * ${table.comment!} 前端控制器
  18.  * </p>
  19.  *
  20.  * @author ${author}
  21.  * @since ${date}
  22.  */
  23. <#if restControllerStyle>
  24. @RestController
  25. <#else>
  26. @Controller
  27. </#if>
  28. @RequestMapping("<#if package.ModuleName?? && package.ModuleName != "">/${package.ModuleName}</#if>/<#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>")
  29. <#if kotlin>
  30. class ${table.controllerName}<#if superControllerClass??> : ${superControllerClass}()</#if>
  31. <#else>
  32. <#if superControllerClass??>
  33. public class ${table.controllerName} extends ${superControllerClass} {
  34. <#else>
  35. public class ${table.controllerName} {
  36. </#if>
  37.  
  38. }
  39. </#if>

entity.java.ftl:

  1. package ${package.Entity};
  2.  
  3. <#list table.importPackages as pkg>
  4. import ${pkg};
  5. </#list>
  6. <#if swagger2>
  7. import io.swagger.annotations.ApiModel;
  8. import io.swagger.annotations.ApiModelProperty;
  9. </#if>
  10. <#if entityLombokModel>
  11. import lombok.Data;
  12. import lombok.EqualsAndHashCode;
  13.     <#if chainModel>
  14. import lombok.experimental.Accessors;
  15.     </#if>
  16. </#if>
  17.  
  18. /**
  19.  * <p>
  20.  * ${table.comment!}
  21.  * </p>
  22.  *
  23.  * @author ${author}
  24.  * @since ${date}
  25.  */
  26. <#if entityLombokModel>
  27. @Data
  28.     <#if superEntityClass??>
  29. @EqualsAndHashCode(callSuper = true)
  30.     <#else>
  31. @EqualsAndHashCode(callSuper = false)
  32.     </#if>
  33.     <#if chainModel>
  34. @Accessors(chain = true)
  35.     </#if>
  36. </#if>
  37. <#if table.convert>
  38. @TableName("${table.name}")
  39. </#if>
  40. <#if swagger2>
  41. @ApiModel(value="${entity}对象", description="${table.comment!}")
  42. </#if>
  43. <#if superEntityClass??>
  44. public class ${entity} extends ${superEntityClass}<#if activeRecord><${entity}></#if> {
  45. <#elseif activeRecord>
  46. public class ${entity} extends Model<${entity}> {
  47. <#else>
  48. public class ${entity} implements Serializable {
  49. </#if>
  50.  
  51. <#if entitySerialVersionUID>
  52.     private static final long serialVersionUID = 1L;
  53. </#if>
  54. <#-- ----------  BEGIN 字段循环遍历  ---------->
  55. <#list table.fields as field>
  56.     <#if field.keyFlag>
  57.         <#assign keyPropertyName="${field.propertyName}"/>
  58.     </#if>
  59.  
  60.     <#if field.comment!?length gt 0>
  61.         <#if swagger2>
  62.     @ApiModelProperty(value = "${field.comment}")
  63.         <#else>
  64.     /**
  65.      * ${field.comment}
  66.      */
  67.         </#if>
  68.     </#if>
  69.     <#if field.keyFlag>
  70.         <#-- 主键 -->
  71.         <#if field.keyIdentityFlag>
  72.     @TableId(value = "${field.annotationColumnName}", type = IdType.AUTO)
  73.         <#elseif idType??>
  74.     @TableId(value = "${field.annotationColumnName}", type = IdType.${idType})
  75.         <#elseif field.convert>
  76.     @TableId("${field.annotationColumnName}")
  77.         </#if>
  78.         <#-- 普通字段 -->
  79.     <#elseif field.fill??>
  80.     <#-- -----   存在字段填充设置   ----->
  81.         <#if field.convert>
  82.     @TableField(value = "${field.annotationColumnName}", fill = FieldFill.${field.fill})
  83.         <#else>
  84.     @TableField(fill = FieldFill.${field.fill})
  85.         </#if>
  86.     <#elseif field.convert>
  87.     @TableField("${field.annotationColumnName}")
  88.     </#if>
  89.     <#-- 乐观锁注解 -->
  90.     <#if (versionFieldName!"") == field.name>
  91.     @Version
  92.     </#if>
  93.     <#-- 逻辑删除注解 -->
  94.     <#if (logicDeleteFieldName!"") == field.name>
  95.     @TableLogic
  96.     </#if>
  97.     private ${field.propertyType} ${field.propertyName};
  98. </#list>
  99. <#------------  END 字段循环遍历  ---------->
  100.  
  101. <#if !entityLombokModel>
  102.     <#list table.fields as field>
  103.         <#if field.propertyType == "boolean">
  104.             <#assign getprefix="is"/>
  105.         <#else>
  106.             <#assign getprefix="get"/>
  107.         </#if>
  108.     public ${field.propertyType} ${getprefix}${field.capitalName}() {
  109.         return ${field.propertyName};
  110.     }
  111.  
  112.     <#if chainModel>
  113.     public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
  114.     <#else>
  115.     public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
  116.     </#if>
  117.         this.${field.propertyName} = ${field.propertyName};
  118.         <#if chainModel>
  119.         return this;
  120.         </#if>
  121.     }
  122.     </#list>
  123. </#if>
  124.  
  125. <#if entityColumnConstant>
  126.     <#list table.fields as field>
  127.     public static final String ${field.name?upper_case} = "${field.name}";
  128.  
  129.     </#list>
  130. </#if>
  131. <#if activeRecord>
  132.     @Override
  133.     protected Serializable pkVal() {
  134.     <#if keyPropertyName??>
  135.         return this.${keyPropertyName};
  136.     <#else>
  137.         return null;
  138.     </#if>
  139.     }
  140.  
  141. </#if>
  142. <#if !entityLombokModel>
  143.     @Override
  144.     public String toString() {
  145.         return "${entity}{" +
  146.     <#list table.fields as field>
  147.         <#if field_index==0>
  148.             "${field.propertyName}=" + ${field.propertyName} +
  149.         <#else>
  150.             ", ${field.propertyName}=" + ${field.propertyName} +
  151.         </#if>
  152.     </#list>
  153.         "}";
  154.     }
  155. </#if>
  156. }

mapper.java.ftl:

  1. package ${package.Mapper};
  2.  
  3. import ${package.Entity}.${entity};
  4. import ${superMapperClassPackage};
  5.  
  6. /**
  7.  * <p>
  8.  * ${table.comment!} Mapper 接口
  9.  * </p>
  10.  *
  11.  * @author ${author}
  12.  * @since ${date}
  13.  */
  14. <#if kotlin>
  15. interface ${table.mapperName} : ${superMapperClass}<${entity}>
  16. <#else>
  17. public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {
  18.  
  19. }
  20. </#if>

mapper.xml.ftl:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="${package.Mapper}.${table.mapperName}">
  4.  
  5. <#if enableCache>
  6.     <!-- 开启二级缓存 -->
  7.     <cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
  8.  
  9. </#if>
  10. <#if baseResultMap>
  11.     <!-- 通用查询映射结果 -->
  12.     <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
  13. <#list table.fields as field>
  14. <#if field.keyFlag><#--生成主键排在第一位-->
  15.         <id column="${field.name}" property="${field.propertyName}" />
  16. </#if>
  17. </#list>
  18. <#list table.commonFields as field><#--生成公共字段 -->
  19.         <result column="${field.name}" property="${field.propertyName}" />
  20. </#list>
  21. <#list table.fields as field>
  22. <#if !field.keyFlag><#--生成普通字段 -->
  23.         <result column="${field.name}" property="${field.propertyName}" />
  24. </#if>
  25. </#list>
  26.     </resultMap>
  27.  
  28. </#if>
  29. <#if baseColumnList>
  30.     <!-- 通用查询结果列 -->
  31.     <sql id="Base_Column_List">
  32. <#list table.commonFields as field>
  33.         ${field.columnName},
  34. </#list>
  35.         ${table.fieldNames}
  36.     </sql>
  37.  
  38. </#if>
  39. </mapper>

service.java.ftl:

  1. package ${package.Service};
  2.  
  3. import ${package.Entity}.${entity};
  4. import ${superServiceClassPackage};
  5.  
  6. /**
  7.  * <p>
  8.  * ${table.comment!} 服务类
  9.  * </p>
  10.  *
  11.  * @author ${author}
  12.  * @since ${date}
  13.  */
  14. <#if kotlin>
  15. interface ${table.serviceName} : ${superServiceClass}<${entity}>
  16. <#else>
  17. public interface ${table.serviceName} extends ${superServiceClass}<${entity}> {
  18.  
  19. }
  20. </#if>

serviceImpl.java.ftl:

  1. package ${package.ServiceImpl};
  2.  
  3. import ${package.Entity}.${entity};
  4. import ${package.Mapper}.${table.mapperName};
  5. import ${package.Service}.${table.serviceName};
  6. import ${superServiceImplClassPackage};
  7. import org.springframework.stereotype.Service;
  8.  
  9. /**
  10.  * <p>
  11.  * ${table.comment!} 服务实现类
  12.  * </p>
  13.  *
  14.  * @author ${author}
  15.  * @since ${date}
  16.  */
  17. @Service
  18. <#if kotlin>
  19. open class ${table.serviceImplName} : ${superServiceImplClass}<${table.mapperName}, ${entity}>(), ${table.serviceName} {
  20.  
  21. }
  22. <#else>
  23. public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> implements ${table.serviceName} {
  24.  
  25. }
  26. </#if>

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/Gausst松鼠会/article/detail/231095
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号