Java Mybatis-plus Generator Swagger2

1、先搭建项目，引入依赖

  1. <parent>
  2.     <groupId>org.springframework.boot</groupId>
  3.     <artifactId>spring-boot-starter-parent</artifactId>
  4.     <version>2.1.9.RELEASE</version>
  5. </parent>
  7. <dependencies>
  8.     <dependency>
  9.         <groupId>org.springframework.boot</groupId>
  10.         <artifactId>spring-boot-starter-web</artifactId>
  11.     </dependency>
  12.     <!-- jdbc -->
  13.     <dependency>
  14.         <groupId>org.springframework.boot</groupId>
  15.         <artifactId>spring-boot-starter-jdbc</artifactId>
  16.     </dependency>
  17.     <!-- MySQL -->
  18.     <dependency>
  19.         <groupId>mysql</groupId>
  20.         <artifactId>mysql-connector-java</artifactId>
  21.     </dependency>
  22.     <!-- lombok -->
  23.     <dependency>
  24.         <groupId>org.projectlombok</groupId>
  25.         <artifactId>lombok</artifactId>
  26.         <optional>true</optional>
  27.     </dependency>
  28.     <!-- mybatis-plus -->
  29.     <dependency>
  30.         <groupId>com.baomidou</groupId>
  31.         <artifactId>mybatis-plus-boot-starter</artifactId>
  32.         <version>3.1.1</version>
  33.     </dependency>
  34.     <dependency>
  35.         <groupId>com.baomidou</groupId>
  36.         <artifactId>mybatis-plus-generator</artifactId>
  37.         <version>3.1.1</version>
  38.     </dependency>
  39.     <!-- swagger2 -->
  40.     <dependency>
  41.         <groupId>io.springfox</groupId>
  42.         <artifactId>springfox-swagger2</artifactId>
  43.         <version>2.9.2</version>
  44.     </dependency>
  45.     <!-- Velocity模板引擎 -->
  46.     <dependency>
  47.         <groupId>org.apache.velocity</groupId>
  48.         <artifactId>velocity-engine-core</artifactId>
  49.         <version>2.1</version>
  50.     </dependency>
  51. </dependencies>

2、编写代码生成器代码（有说明）

  1. /**
  2.  * @Description: 代码生成器
  3.  * @author liangshaolian
  4.  */
  5. public class CodeGenerator {
  7.     /**
  8.      * <p>
  9.      * 读取控制台内容
  10.      * </p>
  11.      */
  12.     public static String scanner(String tip) {
  13.         Scanner scanner = new Scanner(System.in);
  14.         StringBuilder help = new StringBuilder();
  15.         help.append("请输入" + tip + "：");
  16.         System.out.println(help.toString());
  17.         if (scanner.hasNext()) {
  18.             String ipt = scanner.next();
  19.             if (StringUtils.isNotEmpty(ipt)) {
  20.                 return ipt;
  21.             }
  22.         }
  23.         throw new MybatisPlusException("请输入正确的" + tip + "！");
  24.     }
  26.     public static void main(String[] args) {
  27.         Scanner scanner = new Scanner(System.in);
  29.         AutoGenerator generator = new AutoGenerator();
  30.         // 全局变量配置
  31.         GlobalConfig gc = new GlobalConfig();
  32.         String projectPath = System.getProperty("user.dir"); //当前项目
  33.         gc.setOutputDir(projectPath+"/src/main/java"); // 输出路径
  34.         gc.setFileOverride(true); // 默认 false ,是否覆盖已生成文件
  35.         gc.setOpen(false); //默认true ,是否打开输出目录
  36.         gc.setEnableCache(false); // 默认false,是否开启二级缓存
  37.         gc.setAuthor("liangshaolian"); // 作者
  38.         gc.setSwagger2(true); //默认false
  39.         gc.setBaseResultMap(true); // 默认false
  40.         gc.setDateType(DateType.TIME_PACK); // 时间策略 默认TIME_PACK
  41.         gc.setBaseColumnList(true); //默认false  和basemodel相似
  42.         gc.setEntityName("%s");
  43.         gc.setControllerName("%sController");
  44.         gc.setServiceName("I%sService");
  45.         gc.setServiceImplName("%sServiceImpl");
  46.         gc.setMapperName("I%sMapper");
  47.         gc.setXmlName("%sMapper");
  48.         gc.setIdType(IdType.AUTO); // 指定生成的主键类型
  49.         generator.setGlobalConfig(gc);
  51.         // 数据源配置
  52.         DataSourceConfig dc = new DataSourceConfig();
  53.         dc.setDbQuery(new MySqlQuery()); // 数据库信息查询 //默认mysql
  54.         dc.setDbType(DbType.MYSQL);// 数据库类型
  55.         dc.setTypeConvert(new MySqlTypeConvert()); //类型转换 默认mysql
  56.         dc.setUrl("jdbc:mysql://127.0.0.1:3306/数据库名?serverTimezone=CTT&useUnicode=true&characterEncoding=utf-8&useSSL=false");
  57.         dc.setDriverName("com.mysql.cj.jdbc.Driver");
  58.         dc.setUsername("root");
  59.         dc.setPassword("密码");
  60.         generator.setDataSource(dc);
  62.         // 包配置
  63.         PackageConfig pc = new PackageConfig();
  64.         pc.setParent("com.liang.module");//代码生成到哪个包下面
  65. //        pc.setModuleName(""); //此处是所属模块名称
  66. //        pc.setEntity("entity"); //默认entity,controller,service,service.impl,mapper,mapper.xml
  67.         generator.setPackageInfo(pc);
  68.         // 自定义配置
  69.         InjectionConfig cfg = new InjectionConfig() {
  70.             @Override
  71.             public void initMap() {
  72.                 // to do nothing
  73.             }
  74.         };
  75.         /**
  76.          * 将xml生成到resource下面
  77.          */
  78.         String templatePath = "/templates/mapper.xml.vm"; // Velocity模板
  79.         // 自定义输出配置
  80.         List<FileOutConfig> focList = new ArrayList<>();
  81.         // 自定义配置会被优先输出
  82.         focList.add(new FileOutConfig(templatePath) {
  83.             @Override
  84.             public String outputFile(TableInfo tableInfo) {
  85.                 // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
  86.                 return projectPath + "/src/main/resources/mapper/"
  87. //                        + pc.getModuleName()
  88.                         + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
  89.             }
  90.         });
  91.         cfg.setFileOutConfigList(focList);
  92.         generator.setCfg(cfg);
  94.         // 配置模板
  95.         TemplateConfig tc = new TemplateConfig();
  96.         // templates/entity.java 模板路径配置，默认在templates目录下，.vm 后缀不用加
  97.         tc.setEntity("templates/entity.java");//使用自定义模板生成实体类
  98.         tc.setXml("");
  99.         generator.setTemplate(tc);
  101.         // 数据库表配置
  102.         StrategyConfig sc = new StrategyConfig();
  103.         sc.setCapitalMode(false); //是否大写命名 默认false
  104.         sc.setSkipView(true); //是否跳过试图 默认false
  105.         sc.setNaming(NamingStrategy.underline_to_camel);// 表映射 驼峰命名
  106.         sc.setColumnNaming(NamingStrategy.underline_to_camel); // 字段映射 驼峰
  107.         sc.setEntityLombokModel(true); //是否使用lombak 默认为false
  108.         sc.setRestControllerStyle(true); // 默认false
  109.         sc.setEntitySerialVersionUID(true); //默认true
  110.         sc.setEntityColumnConstant(true); //默认false 将mysql字段名生成静态变量
  111.         sc.setInclude(scanner("表名，多个英文逗号分割").split(",")); //表名，用，隔开  需要生产
  112.    //     sc.setExclude(""); //                 不需要生成  二选一
  113.         sc.setEntityTableFieldAnnotationEnable(true); // 默认false 注释
  114.         sc.setControllerMappingHyphenStyle(false); //默认false
  115.         sc.setLogicDeleteFieldName("status"); // 逻辑删除字段名称
  116.         generator.setStrategy(sc);
  118.         // 模板引擎
  119.         generator.setTemplateEngine(new VelocityTemplateEngine());
  120.         generator.execute();
  121.     }
  122. }

3、在resources目录下创建templates目录

4、在templates目录下创建entity.java.vm模板(代码如下)

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

5、基本完成只要运行代码生成器代码，输入表名即可

生成的实体类效果如下:

  1. /**
  2.  * @Description:汽车品牌表
  3.  */
  4. @ApiModel(value ="汽车品牌表")
  5. @Data
  6. @EqualsAndHashCode(callSuper = false)
  7. @TableName("tn_pur_brand")
  8. public class TnPurBrand implements Serializable {
  10.     private static final long serialVersionUID = 1L;
  12.     @ApiModelProperty(value = "主键")
  13.     @TableId(value = "id", type = IdType.AUTO)
  14.     private Long id;
  15.     @ApiModelProperty(value = "首字母")
  16.     @TableField("initials")
  17.     private String initials;
  18.     @ApiModelProperty(value = "汽车品牌")
  19.     @TableField("brand_name")
  20.     private String brandName;
  21.     @ApiModelProperty(value = "品牌LOGO")
  22.     @TableField("logo")
  23.     private String logo;
  25.     public static final String ID = "id";
  27.     public static final String INITIALS = "initials";
  29.     public static final String BRAND_NAME = "brand_name";
  31.     public static final String LOGO = "logo";
  33. }