1 目录结构

  1. ├─src
  2. │  ├─main
  3. │  │  ├─java
  4. │  │  │  └─com
  5. │  │  │      └─hikktn
  6. │  │  │          ├─common
  7. │  │  │          │  ├─base
  8. │  │  │          │  ├─enums
  9. │  │  │          │  ├─exception
  10. │  │  │          │  ├─rest
  11. │  │  │          │  └─validator
  12. │  │  │          ├─content
  13. │  │  │          │  ├─controller
  14. │  │  │          │  ├─dao
  15. │  │  │          │  ├─entity
  16. │  │  │          │  └─service
  17. │  │  │          │      └─impl
  18. │  │  │          └─generator
  19. │  │  └─resources
  20. │  │      ├─mapper
  21. │  │      └─templates

2 示例

2.1 依赖引入

  1.     <parent>
  2.         <groupId>org.springframework.boot</groupId>
  3.         <artifactId>spring-boot-starter-parent</artifactId>
  4.         <version>2.1.3.RELEASE</version>
  5.     </parent>
  6.     <dependencies>
  7.         <dependency>
  8.             <groupId>org.springframework.boot</groupId>
  9.             <artifactId>spring-boot-starter</artifactId>
  10.         </dependency>
  11.         <dependency>
  12.             <groupId>org.springframework.boot</groupId>
  13.             <artifactId>spring-boot-starter-test</artifactId>
  14.             <scope>test</scope>
  15.         </dependency>
  16.         <dependency>
  17.             <groupId>org.springframework.boot</groupId>
  18.             <artifactId>spring-boot-starter-web</artifactId>
  19.         </dependency>
  20.         <!--mybatis-plus的springboot支持-->
  21.         <dependency>
  22.             <groupId>com.baomidou</groupId>
  23.             <artifactId>mybatis-plus-boot-starter</artifactId>
  24.             <version>3.1.0</version>
  25.         </dependency>
  26.         <dependency>
  27.             <groupId>com.baomidou</groupId>
  28.             <artifactId>mybatis-plus-generator</artifactId>
  29.             <version>3.1.0</version>
  30.         </dependency>
  31.         <!-- MP 核心库 -->
  32.         <dependency>
  33.             <groupId>com.baomidou</groupId>
  34.             <artifactId>mybatis-plus</artifactId>
  35.             <version>3.1.0</version>
  36.         </dependency>
  37.         <!--mysql驱动-->
  38.         <dependency>
  39.             <groupId>mysql</groupId>
  40.             <artifactId>mysql-connector-java</artifactId>
  41.         </dependency>
  42.         <!--简化代码的工具包-->
  43.         <dependency>
  44.             <groupId>org.projectlombok</groupId>
  45.             <artifactId>lombok</artifactId>
  46.         </dependency>
  48.         <!-- 模板引擎依赖Freemarker -->
  49.         <dependency>
  50.             <groupId>org.freemarker</groupId>
  51.             <artifactId>freemarker</artifactId>
  52.             <version>2.3.29</version>
  53.         </dependency>
  54.         <!-- thymeleaf模板插件 -->
  55.         <dependency>
  56.             <groupId>org.springframework.boot</groupId>
  57.             <artifactId>spring-boot-starter-thymeleaf</artifactId>
  58.         </dependency>
  59.         <dependency>
  60.             <groupId>commons-fileupload</groupId>
  61.             <artifactId>commons-fileupload</artifactId>
  62.             <version>1.3</version>
  63.         </dependency>
  64.         <!-- velocity -->
  65.         <dependency>
  66.             <groupId>org.apache.velocity</groupId>
  67.             <artifactId>velocity</artifactId>
  68.             <version>1.7</version>
  69.         </dependency>
  70.         <dependency>
  71.             <groupId>io.springfox</groupId>
  72.             <artifactId>springfox-swagger2</artifactId>
  73.             <version>2.9.2</version>
  74.         </dependency>
  75.         <dependency>
  76.             <groupId>io.springfox</groupId>
  77.             <artifactId>springfox-swagger-ui</artifactId>
  78.             <version>2.9.2</version>
  79.         </dependency>
  80.         <dependency>
  81.             <groupId>com.alibaba</groupId>
  82.             <artifactId>fastjson</artifactId>
  83.             <version>1.2.75</version>
  84.         </dependency>
  85.     </dependencies>

2.2 控制器 - controller.java.vm

  1. package ${package.Controller};
  3. import ${package.Entity}.${entity};
  4. import ${package.Service}.${table.serviceName};
  5. import com.hikktn.common.base.PageDto;
  6. import com.hikktn.common.exception.RestException;
  7. import com.hikktn.common.rest.RestResponse;
  8. import org.apache.commons.lang.StringUtils;
  9. import org.springframework.web.bind.annotation.*;
  10. import io.swagger.annotations.Api;
  11. import io.swagger.annotations.ApiOperation;
  12. import org.springframework.beans.factory.annotation.Autowired;
  13. import org.springframework.http.MediaType;
  16. #if(${superControllerClassPackage})
  17. import $!{superControllerClassPackage};
  18. #end
  21. /**
  22.  * <p>
  23.  * $!{table.comment} 前端控制器
  24.  * </p>
  25.  *
  26.  * @author ${author}
  27.  * @since ${date}
  28.  * @version ${cfg.version}
  29.  */
  30. #set($entityName = ${entity.substring(0,1).toLowerCase()}+${entity.substring(1)})
  31. @RestController
  32. @RequestMapping(value = {"#if(${controllerMappingHyphenStyle})/api/${controllerMappingHyphen}#else /api/${table.entityPath}#end"},
  33.         produces = MediaType.APPLICATION_JSON_VALUE)
  34. @Api(value = "${table.controllerName}", description = "$!{table.comment}", produces = MediaType.APPLICATION_JSON_VALUE)
  35. public class ${table.controllerName} extends ${superControllerClass} {
  36.     @Autowired
  37.     private ${table.serviceName} ${entityName}Service;
  39.     @ResponseBody
  40.     @ApiOperation(value = "$!{table.comment}-分页查询", notes = "$!{table.comment}-分页查询")
  41.     @RequestMapping(value = "/_search", method = RequestMethod.POST)
  42.     public RestResponse search(@RequestBody PageDto<${entity}> page){
  43.         return RestResponse.success();
  44.     }
  46.     @ResponseBody
  47.     @ApiOperation(value = "$!{table.comment}-保存", notes = "$!{table.comment}-保存")
  48.     @RequestMapping(value = "", method = RequestMethod.POST)
  49.     public RestResponse<String> save(@RequestBody ${entity} $entityName){
  50.         ${entityName}Service.save($entityName);
  51.         return RestResponse.success();
  52.     }
  54.     @ResponseBody
  55.     @ApiOperation(value = "$!{table.comment}-更新", notes = "$!{table.comment}-更新")
  56.     @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
  57.     public RestResponse<String> update(@PathVariable String id, @RequestBody ${entity} $entityName){
  58.         if (StringUtils.isEmpty(id)){
  59.             throw new RestException("ID不能为空");
  60.         }
  61.         ${entityName}Service.updateById($entityName);
  62.         return RestResponse.success();
  63.     }
  66.     @ResponseBody
  67.     @ApiOperation(value = "$!{table.comment}-删除", notes = "$!{table.comment}-删除")
  68.     @RequestMapping(value = "/{id}", method = RequestMethod.DELETE)
  69.     public RestResponse<String> delete(@PathVariable String id){
  70.         ${entityName}Service.removeById(id);
  71.         return RestResponse.success();
  72.     }
  74. }

2.3 领域对象 - entity.java.vm

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

2.4 Mapper接口 - mapper.java.vm

  1. package ${package.Mapper};
  3. import ${package.Entity}.${entity};
  4. import ${superMapperClassPackage};
  5. import org.springframework.stereotype.Repository;
  7. /**
  8.  * <p>
  9.  * $!{table.comment} Mapper 接口
  10.  * </p>
  11.  *
  12.  * @author ${author}
  13.  * @since ${date}
  14.  * @version ${cfg.version}
  15.  */
  16. @Repository
  17. public interface ${table.mapperName} extends ${superMapperClass}<${entity}> {
  19. }

2.5 Mapper-XML - mapper.xml.vm

  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}">
  5.     #if(${enableCache})
  6.         <!-- 开启二级缓存 -->
  7.         <cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
  9.     #end
  10.     #if(${baseResultMap})
  11.         <!-- 通用查询映射结果 -->
  12.     <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
  13.         #foreach($field in ${table.fields})
  14.             #if(${field.keyFlag})##生成主键排在第一位
  15.                 <id column="${field.name}" property="${field.propertyName}"/>
  16.             #end
  17.         #end
  18.         #foreach($field in ${table.commonFields})##生成公共字段
  19.             <result column="${field.name}" property="${field.propertyName}"/>
  20.         #end
  21.         #foreach($field in ${table.fields})
  22.             #if(!${field.keyFlag})##生成普通字段
  23.                 <result column="${field.name}" property="${field.propertyName}"/>
  24.             #end
  25.         #end
  26.     </resultMap>
  28.     #end
  29.     #if(${baseColumnList})
  30.         <!-- 通用查询结果列 -->
  31.     <sql id="Base_Column_List">
  32.         #foreach($field in ${table.commonFields})
  33.             #if(${field.name} == ${field.propertyName})${field.name}#else${field.name} AS ${field.propertyName}#end,
  34.         #end
  35.         ${table.fieldNames}
  36.     </sql>
  38.     #end
  39. </mapper>

2.6 业务层 - service.java.vm

  1. package ${package.Service};
  3. import com.hikktn.common.base.PageDto;
  4. import ${package.Entity}.${entity};
  5. import ${superServiceClassPackage};
  7. /**
  8.  * <p>
  9.  * $!{table.comment} 服务类
  10.  * </p>
  11.  *
  12.  * @author ${author}
  13.  * @since ${date}
  14.  * @version ${cfg.version}
  15.  */
  16. #set($entityName = ${entity.substring(0,1).toLowerCase()}+${entity.substring(1)})
  17. public interface ${table.serviceName} extends ${superServiceClass}<${entity}> {
  19.     /**
  20.      * 添加
  21.      * @param $entityName
  22.      */
  23.     @Override
  24.     boolean save(${entity} $entityName);
  26.     /**
  27.      * 分页查询
  28.      * @param pageDto 分页
  29.      * @return
  30.      */
  31.     PageDto<${entity}> page(PageDto<${entity}> pageDto);
  32. }

2.7 业务实现层 - serviceImpl.java.vm

  1. package ${package.ServiceImpl};
  3. import ${package.Entity}.${entity};
  4. import ${package.Mapper}.${table.mapperName};
  5. import ${package.Service}.${table.serviceName};
  6. import ${superServiceImplClassPackage};
  7. import com.hikktn.common.base.PageDto;
  8. import org.springframework.stereotype.Service;
  9. import com.hikktn.common.validator.ValidatorUtils;
  10. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  12. /**
  13.  * <p>
  14.  * $!{table.comment} 服务实现类
  15.  * </p>
  16.  *
  17.  * @author ${author}
  18.  * @since ${date}
  19.  * @version ${cfg.version}
  20.  */
  21. #set($entityName = ${entity.substring(0,1).toLowerCase()}+${entity.substring(1)})
  22. @Service
  23. public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> implements ${table.serviceName} {
  25.     @Override
  26.     public boolean save(${entity} $entityName) {
  27.         ValidatorUtils.validateEntity($entityName);
  29.         return this.save($entityName);
  31.     }
  33.     @Override
  34.     public PageDto<${entity}> page(PageDto<${entity}> pageDto) {
  35.         QueryWrapper<${entity}> ew = new QueryWrapper<>();
  37.         return new PageDto<>(super.page(pageDto.getDbPage(), ew));
  38.     }
  39. }

2.8 appliaction.yml

  1. spring:
  2.   application:
  3.     name: mybatis-plus-demo
  4.   datasource:
  5.     driver-class-name: com.mysql.cj.jdbc.Driver
  6.     url: jdbc:mysql://127.0.0.1:3306/my_mybatis_plus?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=UTC&allowPublicKeyRetrieval=true
  7.     username: root
  8.     password: 123456
  9. #logging:
  10. #  level:
  11. #    root: debug
  12. mybatis-plus:
  13.   # 读取mybatis配置文件
  14. #  config-location: classpath:mybatis/mybatis-config.xml
  15.   # 读取mapper文件
  16. #  mapper-locations: classpath*:mybatis/mapper/*Mapper.xml
  17.   # 别名配置，在mybatis.xml文件resultType属性可以不指定类的全路径
  18. #  type-aliases-package: com.hikktn.pojo
  19.   # 开启驼峰映射，注意：配置configuration.map-underscore-to-camel-case则不能配置config-location
  20. #  configuration:
  21. #    map-underscore-to-camel-case: true
  22. # 日志
  23.   configuration:
  24.     log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  25. # 逻辑删除
  26.   global-config:
  27.     db-config:
  28.       logic-delete-value: 1 # 逻辑已删除值(默认为 1)
  29.       logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

2.9 生成类

  1. package com.hikktn.generator;
  3. import com.baomidou.mybatisplus.annotation.DbType;
  4. import com.baomidou.mybatisplus.annotation.IdType;
  5. import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
  6. import com.baomidou.mybatisplus.core.toolkit.StringPool;
  7. import com.baomidou.mybatisplus.core.toolkit.StringUtils;
  8. import com.baomidou.mybatisplus.generator.AutoGenerator;
  9. import com.baomidou.mybatisplus.generator.InjectionConfig;
  10. import com.baomidou.mybatisplus.generator.config.*;
  11. import com.baomidou.mybatisplus.generator.config.po.TableInfo;
  12. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  13. import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
  14. import com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
  15. import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
  16. import org.springframework.core.io.ClassPathResource;
  18. import java.util.*;
  20. /**
  21.  * @ClassName MpGenerator
  22.  * @Description Mybatis-Plus代码生成器
  23.  * @Author lisonglin
  24.  * @Date 2021/5/30 15:09
  25.  * @Version 1.0
  26.  */
  27. public class MyGenerator {
  28.     // TODO 修改服务名以及数据表名
  29.     /**
  30.      * 顶层包名
  31.      */
  32.     private static final String SERVICE_NAME = "content";
  33.     /**
  34.      * 最终包路径
  35.      */
  36.     private static final StringBuilder FINAL_PATH = new StringBuilder();
  37.     /**
  38.      * 多个数据表名
  39.      */
  40.     private static final String[] TABLE_NAMES = new String[]{"tb_user", "t_area"};
  43.     /**
  44.      * <p>
  45.      * 读取控制台内容
  46.      * </p>
  47.      */
  48.     public static String scanner(String tip) {
  49.         Scanner scanner = new Scanner(System.in);
  50.         StringBuilder help = new StringBuilder();
  51.         help.append("请输入" + tip + "：");
  52.         System.out.println(help);
  53.         if (scanner.hasNext()) {
  54.             String ipt = scanner.next();
  55.             if (StringUtils.isNotEmpty(ipt)) {
  56.                 return ipt;
  57.             }
  58.         }
  59.         throw new MybatisPlusException("请输入正确的" + tip + "！");
  60.     }
  62.     /**
  63.      * 代码生成器
  64.      */
  65.     public static void main(String[] args) {
  66.         // 目标数据表名
  67.         String[] tableName = scanner("表名，多个英文逗号分割").split(",");
  68.         generateByTables(tableName);
  69.     }
  71.     private static void generateByTables(String... tableNames) {
  72.         // 选择 freemarker 引擎，默认 Velocity
  73.         AutoGenerator mpg = new AutoGenerator();
  74.         // mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  75.         mpg.setTemplateEngine(new VelocityTemplateEngine());
  76.         // 全局配置
  77.         GlobalConfig gc = globalGenerate();
  78.         // 包配置
  79.         PackageConfig pc = packageGenerate();
  80.         // 文件路径输出配置
  81.         List<FileOutConfig> foc = fileOutGenerate(pc);
  82.         // 其他参数
  83.         InjectionConfig cfg = injectionGenerate(foc);
  84.         // 数据库配置
  85.         DataSourceConfig dsc = dataSourceGenerate();
  86.         // 自定义模板
  87.         TemplateConfig tc = templateGenerate();
  88.         // 策略配置
  89.         StrategyConfig strategy = strategyGenerate(tableNames);
  90.         mpg.setGlobalConfig(gc);
  91.         mpg.setDataSource(dsc);
  92.         mpg.setPackageInfo(pc);
  93.         mpg.setCfg(cfg);
  94.         mpg.setTemplate(tc);
  95.         mpg.setStrategy(strategy);
  96.         mpg.execute();
  97.     }
  99.     /**
  100.      * 数据库配置
  101.      *
  102.      * @return 数据源
  103.      */
  104.     private static DataSourceConfig dataSourceGenerate() {
  105.         YamlPropertiesFactoryBean yamlMapFactoryBean = new YamlPropertiesFactoryBean();
  106.         yamlMapFactoryBean.setResources(new ClassPathResource("application.yml"));
  107.         //获取yml里的参数
  108.         Properties properties = yamlMapFactoryBean.getObject();
  109.         String url = properties.getProperty("spring.datasource.url");
  110.         String driver = properties.getProperty("spring.datasource.driver-class-name");
  111.         String username = properties.getProperty("spring.datasource.username");
  112.         String password = properties.getProperty("spring.datasource.password");
  113.         // 数据库配置
  114.         DataSourceConfig dsc = new DataSourceConfig();
  115.         //数据类型
  116.         dsc.setDbType(DbType.MYSQL);
  117.         dsc.setUrl(url);
  118.         dsc.setDriverName(driver);
  119.         dsc.setUsername(username);
  120.         dsc.setPassword(password);
  121.         return dsc;
  122.     }
  124.     /**
  125.      * 全局配置
  126.      *
  127.      * @return 全局配置
  128.      */
  129.     private static GlobalConfig globalGenerate() {
  130.         // 全局配置
  131.         GlobalConfig gc = new GlobalConfig();
  132.         //是否覆盖文件
  133.         gc.setFileOverride(true);
  134.         // 获取顶层目录
  135.         String projectPath = System.getProperty("user.dir");
  136.         // 获取子项目目录
  137.         String path = MyGenerator.class.getClassLoader().getResource("").getPath();
  138.         String levelPath = path.substring(0, path.indexOf("target") - 1);
  139.         if (!projectPath.equals(levelPath)) {
  140.             FINAL_PATH.append(levelPath);
  141.         } else {
  142.             FINAL_PATH.append(projectPath);
  143.         }
  144.         //输出路径
  145.         gc.setOutputDir(FINAL_PATH + "/src/main/java");
  146.         //作者名称
  147.         gc.setAuthor("hikktn");
  148.         //生成后是否自动打开文件
  149.         gc.setOpen(false);
  150.         // XML 二级缓存
  151.         gc.setEnableCache(false);
  152.         //是否使用swagger2
  153.         gc.setSwagger2(true);
  154.         // 自定义文件命名，注意 %s 会自动填充表实体属性！
  155.         gc.setControllerName("%sController");
  156.         gc.setServiceName("%sService");
  157.         gc.setServiceImplName("%sServiceImpl");
  158.         gc.setMapperName("%sMapper");
  159.         gc.setXmlName("%sMapper");
  160.         //mapper.xml中生成基础resultMap
  161.         gc.setBaseResultMap(true);
  162.         //mapper.xml中生成基础columnList
  163.         gc.setBaseColumnList(true);
  164.         // 主键类型
  165.         gc.setIdType(IdType.ID_WORKER);
  166.         return gc;
  167.     }
  169.     /**
  170.      * 策略配置
  171.      * 主要的表字段映射
  172.      *
  173.      * @param tableName 表名
  174.      * @return 策略配置
  175.      */
  176.     private static StrategyConfig strategyGenerate(String[] tableName) {
  177.         // 策略配置
  178.         StrategyConfig strategy = new StrategyConfig();
  179.         //表名映射到实体策略，带下划线的转成 驼峰
  180.         strategy.setNaming(NamingStrategy.underline_to_camel);
  181.         //列名映射到类型属性策略，带下划线的转成驼峰
  182.         strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  183.         // 表名和字段名是否大小写
  184.         strategy.setCapitalMode(false);
  185.         //实体类使用lombok
  186.         strategy.setEntityLombokModel(false);
  187.         //controller使用rest接口模式
  188.         strategy.setRestControllerStyle(true);
  189.         // 继承顶层controller
  190.         strategy.setSuperControllerClass("com.hikktn.common.base.BaseController");
  191.         //设置表名
  192.         strategy.setInclude(tableName);
  193.         //strategy.setInclude(TABLE_NAMES);
  194.         //表名映射到实体名称去掉前缀
  195.         strategy.setTablePrefix("tb_");
  196.         // Boolean类型字段是否移除is前缀处理
  197.         strategy.setEntityBooleanColumnRemoveIsPrefix(true);
  198.         // 驼峰转连字符
  199.         strategy.setControllerMappingHyphenStyle(true);
  200.         // 建造者模式
  201.         strategy.setEntityBuilderModel(true);
  202.         return strategy;
  203.     }
  205.     /**
  206.      * 自定义模板
  207.      *
  208.      * @return 模板
  209.      */
  210.     private static TemplateConfig templateGenerate() {
  211.         // 设置模板
  212.         TemplateConfig tc = new TemplateConfig();
  213.         tc.setController("templates/controller.java.vm")
  214.                 .setEntity("templates/entity.java.vm")
  215.                 .setService("templates/service.java.vm")
  216.                 .setServiceImpl("templates/serviceImpl.java.vm")
  217.                 .setMapper("templates/mapper.java.vm")
  218.                 // 不要源码包内的mapper
  219.                 .setXml(null);
  220.         return tc;
  221.     }
  223.     /**
  224.      * 文件路径输出配置
  225.      *
  226.      * @param pc 包配置
  227.      * @return 文件路径输出配置
  228.      */
  229.     private static List<FileOutConfig> fileOutGenerate(PackageConfig pc) {
  230.         String templatePath = "/templates/mapper.xml.vm";
  231.         // 自定义输出配置
  232.         List<FileOutConfig> focList = new ArrayList<>();
  233.         // 自定义配置会被优先输出
  234.         focList.add(new FileOutConfig(templatePath) {
  235.             @Override
  236.             public String outputFile(TableInfo tableInfo) {
  238.                 // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
  239.                 return FINAL_PATH + "/src/main/resources/mapper/"
  240.                         + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
  241.             }
  242.         });
  243.         return focList;
  244.     }
  246.     /**
  247.      * 其他参数，在velocity使用的参数，格式：${cfg.version}
  248.      *
  249.      * @param focList 文件路径输出配置
  250.      * @return 其他参数
  251.      */
  252.     private static InjectionConfig injectionGenerate(List<FileOutConfig> focList) {
  253.         InjectionConfig cfg = new InjectionConfig() {
  254.             @Override
  255.             public void initMap() {
  256.                 Map<String, Object> map = new HashMap<>(10);
  257.                 // 查询参数名
  258.                 map.put("version", "1.0");
  259.                 // 逻辑删除
  260.                 map.put("logicDeleteFieldName","is_deleted");
  261.                 // 创建时间（自动生成时间）
  262.                 map.put("createTime","create_time");
  263.                 // 修改时间
  264.                 map.put("updateTime","update_time");
  265.                 this.setMap(map);
  266.             }
  267.         };
  268.         cfg.setFileOutConfigList(focList);
  269.         return cfg;
  270.     }
  272.     /**
  273.      * 包配置
  274.      *
  275.      * @return 包配置
  276.      */
  277.     private static PackageConfig packageGenerate() {
  278.         // 包配置
  279.         PackageConfig pc = new PackageConfig();
  280.         pc.setModuleName(SERVICE_NAME);
  281.         pc.setParent("com.hikktn");
  282.         pc.setEntity("entity");
  283.         pc.setService("service");
  284.         pc.setServiceImpl("service.impl");
  285.         pc.setMapper("dao");
  286.         // 不要设置包目录，否则会生成到源码包内
  287.         pc.setXml(null);
  288.         return pc;
  289.     }
  290. }