java-MyBatisGenerator-（二）开发一个支持tkmybatis的插件

已于 2022-03-30 09:25:05 修改
阅读量586 收藏
点赞数
分类专栏： java 文章标签： java
于 2022-03-29 20:51:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xxj_jing/article/details/123831717
版权

（一）插件开发生成自定的代码

（二）开发一个支持tkmybatis的插件


 

java-MyBatisGenerator-（二）开发一个支持tkmybatis的插件

现在大多数都是前后端分离的开发模式，这样就需要定义好多实体对象从前到后包含但不限于vo、bo、dto、do，一堆o ....
其实都是体力劳动，好吧，让我们把这些o交给生成器吧~~~~

一、上篇讲了怎么写插件，下载就直接上代码。
主要的功能有3个：
1.修改默认生成的接口文件，添加了注解和父类；
2.修改默认生成的类文件，为实体添加了tk.mybatis需要的注解，和一个select方法；
3.生成了一个vo实体，支持swagger的文档描述；

生成的接口内容如下：

package gen.inters;

import static java.util.List;
import static org.apache.ibatis.annotations.Mapper;
import static org.apache.ibatis.annotations.Select;
import static org.springframework.stereotype.Component;

import gen.models.BudgetAppCategoryRelDo;

/**
* 表：budget_app_category_rel
* 预算填报产品类别关系表
*/
@Mapper
@Component
public interface BudgetAppCategoryRelDao extends tk.mybatis.mapper.common.Mapper<BudgetAppCategoryRelDo> {
    /**
     *代码生成器生成内容
     */
    int insert(BudgetAppCategoryRelDo record);

    /**
     *代码生成器生成内容
     */
    int insertSelective(BudgetAppCategoryRelDo record);

    @Select("select * from budget_app_category_rel;")
    List<BudgetAppCategoryRelDo> getAll();
}


生成的实体内容如下：

package gen.models;

import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import org.springframework.stereotype.Component;

/**
 * 表名：budget_app_category_rel
 *   预算填报产品类别关系表
 * 生成时间：2022-03-29 19:12:19
 */
@Table(name = "budget_app_category_rel")
public class BudgetAppCategoryRelDo {
    /**
     * id:id
     */
    /** +注释内容 */
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    /**
     * app_id:app_id
     */
    /** +注释内容 */
    @Column(name = "app_id")
    private Integer appId;

    /**
     * type_id:类别id
     */
    /** +注释内容 */
    @Column(name = "type_id")
    private Integer typeId;

    /**
     * sub_type_id:子类id
     */
    /** +注释内容 */
    @Column(name = "sub_type_id")
    private Integer subTypeId;

    ...
}

生成的vo对象如下：

package gen.tkmybatis;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

/**
* 预算填报产品类别关系表
* @author xxx
*/
@ApiModel(value = "预算填报产品类别关系表",description = "xx")
class BudgetAppCategoryRelVo {
    @ApiModelProperty("id")
    private Integer id;

    @ApiModelProperty("app_id")
    private Integer appId;

    @ApiModelProperty("类别id")
    private Integer typeId;

    @ApiModelProperty("子类id")
    private Integer subTypeId;
    ...
}

二、插件全部代码
配置
<plugin type="org.mybatis.generator.myplugins.TkMybatisPlugin"/>

TkMybatisPlugin类代码

package org.mybatis.generator.myplugins;

import org.mybatis.generator.api.*;
import org.mybatis.generator.api.dom.java.*;
import org.mybatis.generator.config.PropertyRegistry;
import org.mybatis.generator.internal.util.JavaBeansUtil;

import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;

/***
 * tk.mybatis 插件
 * @author xxj
 * @date 2022/3/21 20:07
 */
public class TkMybatisPlugin extends PluginAdapter {
    private String _packageName = "gen.tkmybatis";
    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }
    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 操作表实体类的插件方法
    /** 表实体类添加注解，构造完成后的回调函数 */
    @Override
    public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass
            , IntrospectedTable introspectedTable) {
        //添加依赖包
        topLevelClass.addImportedType("org.apache.ibatis.annotations.Mapper");
        topLevelClass.addImportedType("org.apache.ibatis.annotations.Select");
        topLevelClass.addImportedType("org.springframework.stereotype.Component");
        //添加类注解
        topLevelClass.addAnnotation("@Table(name = \""+introspectedTable.getFullyQualifiedTableNameAtRuntime()+"\")");
        //添加类的父类
        //topLevelClass.setSuperClass("tk.mybatis.mapper.common.Mapper<MyTestDo>");
        return super.modelBaseRecordClassGenerated(topLevelClass, introspectedTable);
    }

    /** 表实体类的成员变量添加注解，构造完成后的回调函数 */
    @Override
    public boolean modelFieldGenerated(Field field //当前属性的对象
            , TopLevelClass topLevelClass  //属性的宿主类
            , IntrospectedColumn introspectedColumn //数据库表字段对象
            , IntrospectedTable introspectedTable //数据库表对象
            , ModelClassType modelClassType) {
        //为生成的方法添加 tk.mybatis 注解
        field.getJavaDocLines().add("/** +注释内容 */");
        //添加主键注解
        if(introspectedColumn.isAutoIncrement()) {
            field.addAnnotation("@Id");
            field.addAnnotation("@GeneratedValue(strategy = GenerationType.IDENTITY)");
            return true;
        }
        field.addAnnotation("@Column(name = \""+introspectedColumn.getActualColumnName()+"\")");

        return super.modelFieldGenerated(field, topLevelClass, introspectedColumn, introspectedTable, modelClassType);
    }

    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 操作表接口类的插件方法
    /** 当整个表对应的客户端代码对象生成完后，方法被调佣一次 */
    @Override
    public boolean clientGenerated(Interface interfaze
            , TopLevelClass topLevelClass
            , IntrospectedTable introspectedTable) {
        String tableName = introspectedTable.getFullyQualifiedTableNameAtRuntime();
        String domainObjectName = MessageFormat.format(
                introspectedTable.getTableConfiguration().getEntityName() //xml中table.entityName属性，修改过源码支持占位符
                ,introspectedTable.getFullyQualifiedTable().getDomainObjectName() //表实体对象名
        );
        //添加接口注释内容
        interfaze.addJavaDocLine("/**");
        interfaze.addJavaDocLine("* 表："+introspectedTable.getFullyQualifiedTableNameAtRuntime());
        interfaze.addJavaDocLine("* "+introspectedTable.getRemarks());
        interfaze.addJavaDocLine("*/");
        //添加依赖包
        interfaze.addStaticImport("org.apache.ibatis.annotations.Mapper");
        interfaze.addStaticImport("org.apache.ibatis.annotations.Select");
        interfaze.addStaticImport("org.springframework.stereotype.Component");
        interfaze.addStaticImport("java.util.List");
        //添加注解
        interfaze.addAnnotation("@Mapper");
        interfaze.addAnnotation("@Component");
        //添加父类
        interfaze.addSuperInterface(new FullyQualifiedJavaType(
                "tk.mybatis.mapper.common.Mapper<"+domainObjectName+">"));
        //添加方法
        Method f = new Method();
        f.addAnnotation(String.format("@Select(\"select * from %s;\")",tableName));
        f.setReturnType(new FullyQualifiedJavaType("List<"+domainObjectName+">"));
        f.setName("getAll");
        interfaze.addMethod(f);
        return super.clientGenerated(interfaze, topLevelClass, introspectedTable);
    }

    //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 操作表实体类的插件方法
    /** 可以生成自定义的文件 */
    @Override
    public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable) {
        List<GeneratedJavaFile> answer = new ArrayList<GeneratedJavaFile>();
        answer.add(getTestJaveFile(introspectedTable));//测试用的
        answer.add(getTestJaveVoFile(introspectedTable));//生成一个vo对象
        return answer;
    }
    /** 生成一个Vo对象 */
    private GeneratedJavaFile getTestJaveVoFile(IntrospectedTable introspectedTable){
        String tableName = introspectedTable.getFullyQualifiedTableNameAtRuntime();
        String domainObjectName =introspectedTable.getFullyQualifiedTable().getDomainObjectName();
        String typeName = MessageFormat.format("{0}.{1}Vo",_packageName,domainObjectName);
        FullyQualifiedTable table = introspectedTable.getFullyQualifiedTable();
        //类的完全限定名（决定生成的文件的目录接口）
        TopLevelClass c = new TopLevelClass(typeName);
        //导入的依赖包
        c.addImportedType(new FullyQualifiedJavaType("io.swagger.annotations.ApiModel"));
        c.addImportedType(new FullyQualifiedJavaType("io.swagger.annotations.ApiModelProperty"));
        //添加注释
        c.addJavaDocLine("/**");
        c.addJavaDocLine("* "+introspectedTable.getRemarks());
        c.addJavaDocLine("* @author xxx");
        c.addJavaDocLine("*/");
        //添加注解
        c.addAnnotation(MessageFormat.format("@ApiModel(value = \"{0}\",description = \"xx\")"
                ,introspectedTable.getRemarks()));
        //类的成员属性
        for(IntrospectedColumn col : introspectedTable.getAllColumns()){
            Field f = new Field();
            f.setVisibility(JavaVisibility.PRIVATE);
            f.addAnnotation("@ApiModelProperty(\""+col.getRemarks()+"\")");
            f.setName(col.getJavaProperty());
            f.setType(col.getFullyQualifiedJavaType());
            c.addField(f);
        }
        //类的方法
        for(IntrospectedColumn col : introspectedTable.getAllColumns()){
            //get
            Method fun = new Method();
            fun.setName(JavaBeansUtil.getGetterMethodName(col.getJavaProperty(),col.getFullyQualifiedJavaType()));
            fun.setReturnType(col.getFullyQualifiedJavaType());
            fun.setVisibility(JavaVisibility.PUBLIC);
            fun.addBodyLine(MessageFormat.format("return {0};",col.getJavaProperty()));
            c.addMethod(fun);
            //get
            fun = new Method();
            fun.setName(JavaBeansUtil.getSetterMethodName(col.getJavaProperty()));
            fun.setVisibility(JavaVisibility.PUBLIC);
            Parameter pars = new Parameter(col.getFullyQualifiedJavaType(),col.getJavaProperty());
            fun.addParameter(pars);
            fun.addBodyLine(MessageFormat.format("return this.{0}={0};",col.getJavaProperty()));
            c.addMethod(fun);
        }
        //构建一个编译单元
        GeneratedJavaFile gjf = new GeneratedJavaFile(
                c,
                context.getJavaModelGeneratorConfiguration().getTargetProject(),
                context.getProperty(PropertyRegistry.CONTEXT_JAVA_FILE_ENCODING),
                context.getJavaFormatter());
        return gjf;
    }

    /** 生成一个自定义文件 */
    private GeneratedJavaFile getTestJaveFile(IntrospectedTable introspectedTable){
        String typeName = MessageFormat.format("{0}.TestInfo",_packageName);
        //类的完全限定名（决定生成的文件的目录接口）
        TopLevelClass c = new TopLevelClass(typeName);
        //导入的依赖包
        c.addImportedType(new FullyQualifiedJavaType("java.io.File;//111"));
        c.addImportedType(new FullyQualifiedJavaType("java.io.File;//222"));
        //构建一个编译单元
        GeneratedJavaFile gjf = new GeneratedJavaFile(
                c,
                context.getJavaModelGeneratorConfiguration().getTargetProject(),
                context.getProperty(PropertyRegistry.CONTEXT_JAVA_FILE_ENCODING),
                context.getJavaFormatter());
        //类的成员属性怎么标识？？
        Field f = new Field();
        f.setVisibility(JavaVisibility.PRIVATE);
        f.setInitializationString("\"aaa\"");
        f.setComment("//my field");
        f.setName("id");
        f.setType(FullyQualifiedJavaType.getStringInstance());
        c.addField(f);
        //类的方法
        Method fun = new Method();
        fun.addBodyLine("//hello word");
        fun.addBodyLine("return \"xxx\";");
        fun.setName("getId");
        fun.setReturnType(FullyQualifiedJavaType.getStringInstance());
        fun.addAnnotation("//@Service(111)");
        fun.addJavaDocLine("/** hello function */");
        c.addMethod(fun);
        return gjf;
    }

}

草青工作室
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【Mybatis】TKMybatis 介绍和使用
m0_67401499的博客
03-24 4097
目录 一、什么是 TKMybatis 二、TKMybatis 使用 2.1 Springboot 项目中加入依赖 2.2?使用讲解 2.2.1 实体类中使用 2.2.2 dao中使用 2.2.3 Service 层中使用 2.3 实际案例 2.3.1 dao 层使用 2.3.2 service 层使用 一、什么是 TKMybatis TKMybatis 是基于 Mybatis 框架开发的一个工具，内部实现了对单表的基本数据操作，只需要简单继承 TKMybatis 提供的接口，就能够实现无需编写任何 sql
Mybatis/tk-Mybatis/Mybatis-plus 中generator(代码生成器)的使用
weixin_43740223的博客
08-28 4638
mybatis-generator 代码生成器的应用
2024年Go最全推荐几个代码自动生成器_代码生成器(3)，一文说清
最新发布
BlackCATdog的博客
05-14 2109
下载地址很神秘。
tkmybatis详细教程（一篇就明白）
热门推荐
dgh112233的博客
05-28 5万+
tkmybatis 是对底层 sql 进行了抽象封装，不需要考虑 sql 怎么写，只需要按照逻辑思维，遵循 tkmybatis 的语法即可实现数据库操作。 本文适合对springboot项目结构有一定了解的读者。 本文的项目基础是一个demo项目（多模块的）。 1. 配置 1、添加 tkmybatis 的依赖 <dependency> <groupId>tk.mybatis</groupId>
使用tk-mybatis generator 自动生成代码（集成统一mapper）
lsqingfeng的博客
05-14 8643
tk-mybatis 是mybatis的一个功能扩展，可以在原有方法的基础之上提供更多的功能可用，如一个基类Mapper, 继承他就相当于拥有了常用的增删改查等功能，无需再每个mapper文件中都写增删改查，非常方便。那么接下来我们来开始。 1. 引入依赖包，我们使用的是springboot 2.1.4 这个版本，再pom中先引入依赖 <!--通用mapper，使用ma...
spring集成 tk.mybatis插件
05-31
spring4.0 集成 tk.mybatis插件，增删改无需增删改查，快速开发
mybatis-generator生成代码完整示例
01-31
在java项目开发中一般都用到mybatis框架，就会涉及到实体和表的映射，mapper的生成，mybatis-generator插件可以根据表结构自动生成实体和mapper，大大简化了开发的工作量 目前这个插件生成的原始实体没有字段注释，...
Mybatis Generator将tinyint映射成Integer的解决办法.pdf
12-16
在使用MyBatis Generator生成Java DAO层代码时，可能会遇到将数据库中的tinyint类型映射成Integer类型的问题。这个问题在上述描述中得到了详细的解释。首先，我们来看一下问题的背景和原因。 在Java环境中，使用...
mybatis.zip
02-08
博文：“一个简单的例子学会mybatis-generator+Tk 实现父子表关系查询”的示例代码，采用mybatis-generator的自动生成插件和Tk插件结合，实现对父子表的联合查询，使返回结果包括父表信息和它的子表每个子数据信息。
mybatis逆向工程基础上增加了自动生成swgger注解的功能generatorSqlmap-increase.zip
07-10
2. **自定义插件**：为了实现自动生成Swagger注解，项目可能创建了一个自定义的Mybatis Generator插件。这个插件会在生成Mapper接口和实体类时，根据数据库表的元数据添加相应的Swagger注解。 3. **注解解析**：...
ssm-demo.rar
11-20
4. **PageHelper**：这是一个MyBatis的分页插件，它可以方便地实现对数据库的分页查询，同时支持多种数据库，如MySQL、Oracle等，使得分页操作变得简单易行。 5. **tk.mybatis.mapper**：这是MyBatis的一个扩展，...
TkMybatis通用Mapper逆向工程代码生成工具
08-06
TkMybatis通用Mapper逆向工程代码生成工具，Maven项目工具；
mybatis帮助文档
07-31
mybatis帮助文档，用于查找mybatis的用法，简单方便。
springboot +tkmybatis + generator+单元测试.zip
08-15
配合文章使用，springboot +tkmybatis + generator+单元.zip 请配和文件使用
重新封装mybatis-generator
11-28
支持批量插入批量更新 支持常规类型 生成非常好用已经在n多个项目使用 希望可以帮助到大家，不积跬步无以至千里，不积小流无以成江河，
tk.mybatis通用mapper maven插件的使用
wwzzh1989的博客
03-22 1556
1.导入插件,通用mapper是依赖于mybatis-generator的,所以只是在其基础上的优化 生成的xml 和 mapper接口中没有那些方法了,但是mapper接口要继承通用Mapper接口 <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</a
10_SpringBoot集成TkMybatis插件
agg7911的博客
04-03 353
10_SpringBoot集成TkMybatis插件 明天你好向前奔跑关注 0.52018.09.11 11:15字数 163阅读 3794评论 0喜欢 3 @Author Jacky Wang ， 转载请注明出处 前提: 基于SpringBoot项目,正常集成Mybatis后,为了简化sql语句的编写,甚至达到无mapper.xml文件...
Spring Boot微服务框架整合之通用mapper插件（tk.mybatis）
Lktao_96
03-23 4379
继我上次的Springboot框架整合，整合了初步的微服务框架，还有mybatis整合实现数据库查询数据的demo现在给大家再整合一个本人觉得比较好用的通用mapper插件（tk.mybatis），这个插件里面封装好了我们需要用到的很多sql语句，不过这个插件是通过我们去调用它封装的各种方法来实现sql语句的效果。这样就不用像mybatis那样每次写一个接口就要写一条sql语句。这样大大减少了我们...
通用mapper generator 自动生成代码插件
lyf_ldh的博客
07-08 7682
专用代码生成器 1.使用Java编码方式运行MBG 使用这种方式，需要引入 MBG 的依赖，同时项目中应该已经有通用 Mapper 的依赖了。 <!-- https://mvnrepository.com/artifact/org.mybatis.generator/mybatis-generator-core --> <dependency> &lt...
MyBatis Generator插件开发
08-30
开发插件需要熟悉Java和MyBatis框架的使用，可以通过实现MyBatis Generator提供的接口来扩展其功能。 ### 回答2： MyBatis Generator是一个用于生成MyBatis的持久层代码的插件。通过生成代码，开发人员可以快速...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值