CodeGenerator自定义模板一直带doc多行注释

最新推荐文章于 2023-05-25 09:14:49 发布
最新推荐文章于 2023-05-25 09:14:49 发布
阅读量219 收藏
点赞数
分类专栏： mybatis-plus CodeGenerator 文章标签： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43043092/article/details/130181086
版权
文章介绍了如何使用Mybatis-Plus生成带文档注释的实体类模板，包括引入Swagger2注解以支持API文档，以及利用Lombok简化getter/setter等代码。同时，展示了如何自定义模板输出路径和文件名。
摘要由CSDN通过智能技术生成

mybatis-plus提供的原版

package ${package.Entity};

#foreach($pkg in ${table.importPackages})
import ${pkg};
#end
#if(${swagger2})
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
#end
#if(${entityLombokModel})
import lombok.Data;
import lombok.EqualsAndHashCode;
#if(${chainModel})
import lombok.experimental.Accessors;
#end
#end

/**
 * <p>
 * $!{table.comment}
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${entityLombokModel})
@Data
  #if(${superEntityClass})
@EqualsAndHashCode(callSuper = true)
  #else
@EqualsAndHashCode(callSuper = false)
  #end
  #if(${chainModel})
@Accessors(chain = true)
  #end
#end
#if(${table.convert})
@TableName("${table.name}")
#end
#if(${swagger2})
@ApiModel(value="${entity}对象", description="$!{table.comment}")
#end
#if(${superEntityClass})
public class ${entity} extends ${superEntityClass}#if(${activeRecord})<${entity}>#end {
#elseif(${activeRecord})
public class ${entity} extends Model<${entity}> {
#else
public class ${entity} implements Serializable {
#end

#if(${entitySerialVersionUID})
    private static final long serialVersionUID=1L;
#end
## ----------  BEGIN 字段循环遍历  ----------
#foreach($field in ${table.fields})

#if(${field.keyFlag})
#set($keyPropertyName=${field.propertyName})
#end
#if("$!field.comment" != "")
  #if(${swagger2})
    @ApiModelProperty(value = "${field.comment}")
  #else
    /**
     * ${field.comment}
     */
  #end
#end
#if(${field.keyFlag})
## 主键
  #if(${field.keyIdentityFlag})
    @TableId(value = "${field.annotationColumnName}", type = IdType.AUTO)
  #elseif(!$null.isNull(${idType}) && "$!idType" != "")
    @TableId(value = "${field.annotationColumnName}", type = IdType.${idType})
  #elseif(${field.convert})
    @TableId("${field.annotationColumnName}")
  #end
## 普通字段
#elseif(${field.fill})
## -----   存在字段填充设置   -----
  #if(${field.convert})
    @TableField(value = "${field.annotationColumnName}", fill = FieldFill.${field.fill})
  #else
    @TableField(fill = FieldFill.${field.fill})
  #end
#elseif(${field.convert})
    @TableField("${field.annotationColumnName}")
#end
## 乐观锁注解
#if(${versionFieldName}==${field.name})
    @Version
#end
## 逻辑删除注解
#if(${logicDeleteFieldName}==${field.name})
    @TableLogic
#end
    private ${field.propertyType} ${field.propertyName};
#end
## ----------  END 字段循环遍历  ----------

#if(!${entityLombokModel})
#foreach($field in ${table.fields})
  #if(${field.propertyType.equals("boolean")})
    #set($getprefix="is")
  #else
    #set($getprefix="get")
  #end

    public ${field.propertyType} ${getprefix}${field.capitalName}() {
        return ${field.propertyName};
    }

  #if(${chainModel})
    public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
  #else
    public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
  #end
        this.${field.propertyName} = ${field.propertyName};
  #if(${chainModel})
        return this;
  #end
    }
#end
## --foreach end---
#end
## --end of #if(!${entityLombokModel})--

#if(${entityColumnConstant})
  #foreach($field in ${table.fields})
    public static final String ${field.name.toUpperCase()} = "${field.name}";

  #end
#end
#if(${activeRecord})
    @Override
    protected Serializable pkVal() {
  #if(${keyPropertyName})
        return this.${keyPropertyName};
  #else
        return null;
  #end
    }

#end
#if(!${entityLombokModel})
    @Override
    public String toString() {
        return "${entity}{" +
  #foreach($field in ${table.fields})
    #if($!{foreach.index}==0)
        "${field.propertyName}=" + ${field.propertyName} +
    #else
        ", ${field.propertyName}=" + ${field.propertyName} +
    #end
  #end
        "}";
    }
#end
}

改良后的带doc注释的模板（不要通过idea等会自动调整格式的编辑器粘贴进去，会乱掉！！！）

package ${package.Entity};

#foreach($pkg in ${table.importPackages})
import ${pkg};
#end
#if(${swagger2})
import io.swagger.annotations.ApiModel;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModelProperty;
#end
#if(${entityLombokModel})
import lombok.Data;
import lombok.EqualsAndHashCode;
    #if(${chainModel})
    import lombok.experimental.Accessors;
    #end
#end

/**
 * <p>
 * $!{table.comment}
 * </p>
 *
 * @author ${author}
 * @since ${date}
 */
#if(${entityLombokModel})
@Data
    #if(${superEntityClass})
@EqualsAndHashCode(callSuper = true)
    #end
    #if(${chainModel})
@Accessors(chain = true)
    #end
#end
@TableName("${table.name}")
#if(${swagger2})
@ApiModel(value="${entity}对象", description="$!{table.comment}")
#end
#if(${superEntityClass})
public class ${entity} extends ${superEntityClass}#if(${activeRecord})<${entity}>#end {
#elseif(${activeRecord})
public class ${entity} extends Model<${entity}> {
#else
public class ${entity} implements Serializable {
#end

#if(${entitySerialVersionUID})
    private static final long serialVersionUID=1L;
#end
## ----------  BEGIN 字段循环遍历  ----------
#foreach($field in ${table.fields})

    #if(${field.keyFlag})
        #set($keyPropertyName=${field.propertyName})
    #end
    #if("$!field.comment" != "")
    /**
     * ${field.comment}
     */
    #if(${swagger2})
    @ApiModelProperty(value = "${field.comment}")
    #end
    #end
    #if(${field.keyFlag})
        #if(${field.keyIdentityFlag})
    @TableId(value = "${field.name}", type = IdType.AUTO)
        #elseif(!$null.isNull(${idType}) && "$!idType" != "")
    @TableId(value = "${field.name}", type = IdType.${idType})
        #elseif(${field.convert})
    @TableId("${field.name}")
        #end
    #elseif(${field.fill})
        #if(${field.convert})
    @TableField(value = "${field.name}", fill = FieldFill.${field.fill})
        #else
    @TableField(fill = FieldFill.${field.fill})
        #end
    #elseif(${field.convert})
    @TableField("${field.name}")
    #end
    #if(${versionFieldName}==${field.name})
    @Version
    #end
    #if(${logicDeleteFieldName}==${field.name})
    @TableLogic
    #end
    private ${field.propertyType} ${field.propertyName};
#end
## ----------  END 字段循环遍历  ----------

#if(!${entityLombokModel})
    #foreach($field in ${table.fields})
        #if(${field.propertyType.equals("boolean")})
            #set($getprefix="is")
        #else
            #set($getprefix="get")
        #end

    public ${field.propertyType} ${getprefix}${field.capitalName}() {
            return ${field.propertyName};
            }

        #if(${chainModel})
        public ${entity} set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        #else
        public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        #end
            this.${field.propertyName} = ${field.propertyName};
        #if(${chainModel})
                return this;
        #end
            }
    #end
    ## --foreach end---
#end
## --end of #if(!${entityLombokModel})--

#if(${entityColumnConstant})
    #foreach($field in ${table.fields})
    public static final String ${field.name.toUpperCase()} = "${field.name}";

    #end
#end
#if(${activeRecord})
@Override
protected Serializable pkVal() {
    #if(${keyPropertyName})
            return this.${keyPropertyName};
    #else
            return null;
    #end
        }

#end
#if(!${entityLombokModel})
@Override
public String toString() {
        return "${entity}{" +
    #foreach($field in ${table.fields})
        #if($!{foreach.index}==0)
                "${field.propertyName}=" + ${field.propertyName} +
        #else
                ", ${field.propertyName}=" + ${field.propertyName} +
        #end
    #end
        "}";
        }
#end
}

添加自定义模板

        List<FileOutConfig> focList = new ArrayList<>();
        focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return projectPath + "/src/main/resources/mapper/"
                        + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });

        // 实体类文件输出
        focList.add(new FileOutConfig("/templates/entity.java.vm") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                return projectPath + "/src/main/java/com/entity/" + tableInfo.getEntityName() + StringPool.DOT_JAVA;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        mpg.setTemplate(new TemplateConfig().setXml(null).setEntity(null));
        // FreemarkerTemplateEngine识别.ftl模板文件， VelocityTemplateEngine识别.vm模板文件
        mpg.setTemplateEngine(new VelocityTemplateEngine());
入门の小菜鸟
关注
专栏目录
mako模版库实践
布鲁斯
10-21 2262
介绍 这几天在编写一个数据驱动测试框架，其中一个核心模块是根据数据输入，自动转换为测试用例代码。测试数据格式固定，对应的用例代码结构也相对稳定。基于此场景，联想到web页面根据数据从template渲染页面，决定使用类似的方式，采用模版库动态生成测试用例代码。 Python库有两个常用的模版库：Jinja2和Mako。两个库功能都很齐全强大，Jinja2广泛用于各种语言环境如Java/Go，Mak...
Flutter 注解处理及代码生成，移动金融应用开发
m0_65511992的博客
12-22 966
示例中我们返回的是 LibraryBuilder 对象，构造方法的参数是我们上一步创建的TestGenerator对象。 实际上根据不同的需求，我们还有其他Builder对象可选，Builder 的继承树： Builder _Builder PartBuilder LibraryBuilder SharedPartBuilder MultiplexingBuilder PartBuilder 与 SharedPartBuilder 涉及到 dart-part 关键字的使用，这里我们暂时不做展开，通常情况
CodeGenerator-T4模板代码生成器
01-14
CodeGenerator 使用T4模板从数据库生成实体/MAP 使用方法如下: 1.修改CodeGenerator.exe.config中的text连接字串并保存 2.打开CodeGenerator.exe 3.选择数据库 4.选择需要生成的表 5.选择对应的模板(选中模板后点VIEW可以打开模板进行查看/编辑) 模板是T4模板，置于Templete文件夹下，程序运行时会自动把此目录下的所有T4文件读出来. 6.点TEST查看根据第一个模板生成的效果 7.设置命名参数/数据表前缀(设置后前缀会在生成类名时去掉)/输出路径(默认当前程序下的OUTPUT文件夹) 8.点击Create进行生成。生成的文件会放在以在OUTPUT以模板名命名的文件夹中。 如果对此程序有意见与建议，欢迎向我提出:38677446
CodeGenerator自动生成的代码模板
最新发布
zjjh_123的专栏
05-25 197
【代码】CodeGenerator自动生成的代码模板。
MyBatis Generator模板
weixin_30567225的博客
07-20 182
注：注意替换红色部分 <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-ge...
mybatis-generator 模板
09-30
mybatis-generator 模板，增加了对mybatis-paginator 的支持 详见：https://blog.csdn.net/hcmdy/article/details/82910676
使用 Yeoman 自定义 Generator，包含新建 Vue 模板案例
GoldenaArcher的博客
06-17 1810
本章学习内容如下： 学习 Yeoman 即 Generator 的使用 使用 Yeoman 自定义一个 Generator 案例学习：使用 Yeoman 自定义一个 Vue 项目 案例学习：使用 inquirer 和 ejs 实现一个小型的脚手架工具 什么是 Yeoman Yeoman 是一个通用型的网页应用的脚手架工具，和 angular-cli, create-react-app, vue-cli 比起来，它是一个更加通用的脚手架工具，但是也因此它的灵活性更高。
Google开源项目Python 语言规范
baidu_35183648的博客
11-12 1398
Python语言代码规范 1.Python 语言规范 1.1. Lint Tip: 使用该 pylintrc 对你的代码运行 pylint 定义: pylint 是一个在 Python 源代码中查找 bug 的工具. 对于 C 和 C++ 这样的不那么动态的语言, 这些 bug 通常由编译器来捕获. 由于 Python 的动态特性, 有些警告可能不对，不过伪告警应该很少。 优点: 可以捕获容易忽视的错误, 例如输入错误, 使用未赋值的变量等。 缺点: pylint 不完美. 要利用其优势, 我们有时侯需要:
java常见单词汇总3（非常使用哦）
qq_42902470的博客
01-09 671
JSP中常用英文 URL: Universal Resource Location:统一资源定位符 IE: Internet Explorer 因特网浏览器 JSP:java server page.java服务器页面 Model:模型 View:视图 C:controller:控制器 Tomcat:一种jsp的web服务器 WebModule:web模块 Servlet:小服务程序 Reques...
和Ai一起学习CMake（一）
Cukor丘克的博客
05-04 1234
CMake是一个跨平台的安装（编译）工具，可以用简单的语句来描述所有平台的安装（编译过程）。CMake能够输出各种各样的makefile或者project文件，能测试编译器所支持的C++特性，类似UNIX下的automake。CMake不直接编译软件，而是结合原生构建系统来构建软件。CMake的产生可以追溯到20世纪90年代，当时开发人员使用的构建工具很有限，需要为不同的平台编写不同的Makefile，这极大地增加了软件开发的难度和复杂性。
rapid-generator4.06 JAVA代码生成器配置,模板自定义
varyall的专栏
04-11 3773
codeFactory介绍:1.codeFactory: Java代码生成,依赖rapid-generator.4.0.6.jar, 支持自定义模板生成代码, 弱业务下完全解放体力劳动.集成分页插件2.ssm模板实现:pojo,dao,daoimpl,service,serviceimpl,controller,各mapper.xml 代码自动生成,3.配置文件自动生(含:spring,sprin...
mybatis-plus-generator 通过模板引擎 一键生成增删改查代码（CRUD）,
waper97的博客
03-30 5777
mybatis-plus-generator 代码生成器，交互式一键生成CRUD
MyBatis Generator(MBG) 自动模板使用配置
进击的小白
01-09 1029
介绍 MBG是MyBatis访问数据库的代码生成器，可以支持对单表的CRUD操作，多表及其他操作还需手动编码。 MyBatis Generator官网 v1.3.7版本升级内容 JAVA8及以上版本 pom.xml引入mybatis-generator.jar包 &lt;build&gt; &lt;pluginManagement&gt; &lt;plugin...
MyBatis Plus代码生成器
lqbz456的博客
12-05 326
Mybatis-Plus 官网 1. 添加Maven依赖 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schem...
mybatis-generator手动生成模板代码步骤
gonghaiyu的博客
06-05 813
package com.tcl.database.generate; import com.google.common.base.CaseFormat; import freemarker.template.TemplateExceptionHandler; import org.apache.commons.lang3.StringUtils; import org.mybatis.generator.api.MyBatisGenerator; import org.mybatis.generator.
Mybatis-plus代码生成器，子模块下使用templates模板生成代码，在模块下使用单元测试文件直接生成
m0_46093203的博客
02-14 703
public class CodeGenerator { @Test public void run() { // 1、创建代码生成器 AutoGenerator mpg = new AutoGenerator(); // 2、全局配置 GlobalConfig gc = new GlobalConfig(); String projectPath = System.getProperty("user.dir.
完全开源的代码生成器之code-generator
沈光阳的博客
12-13 5874
code-generator是一个低代码平台, 可以解决90%单表增删改查工作量, 你可以通过自定义代码模板来生成适合自己的代码。目前该系统主要针对的是语言是java, 数据源是mysql(其他数据库待测试)，数据源支持mysql, oracle, dm, PostgreSql等数据库。支持vue前端吗?理论上只要你定义好了vue代码模板, 也是可以支持前端代码生成java8运行环境, 数据存储使用的是内嵌h2数据库(可切换到mysql)构建代码采用 maven3.8简介常用代码模板。
mybatis-plus生成的实体类支持swagger2
asheng_12345的博客
07-23 3401
package ${package.Entity}; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; #if(${activeRecord}) import java.io.Serializable; #end #foreach($pkg in ${ta...
mybatis代码生成器模板配置
qq_52699757的博客
04-13 843
mybatis代码生成器模板配置
自定义MyBatis Generator 注释配置教程
"MyBatis Generator 自定义生成注释的方法" 在开发过程中，MyBatis Generator (MBG) 是一个非常实用的工具，它能够自动生成数据库表对应的实体类、Mapper接口和XML配置文件，极大地提高了开发效率。然而，MBG默认...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值