Myabtis-Plus自定义代码生成器与自定义代码生成模板

已于 2022-08-29 15:54:26 修改
阅读量1.4k 收藏 3
点赞数
文章标签： mybatis java spring
于 2022-08-29 13:31:40 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/a1091758887/article/details/126580980
版权

一、前言

在编写代码时我们会编写大量与业务无关的代码，比如Contoller，Service，Entity以及一些增删改查接口的定义，这些代码基本都是固定的模板，手动编写浪费大量时间，今天介绍一下Mybatis-Plus代码生成器来简化代码的开发，减少重复代码的编写。
该代码生成器地址：https://gitee.com/a1091758887/AutoGenerateCode

二、引入Jar包

 <dependency>
		 <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.2</version>
        </dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.2</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.28</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.30</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>

三、代码

import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.util.HashMap;
import java.util.Map;

/**
 * @Author fanQie
 * @Date 2022/08/29 12:00
 */
public class AutoGenerator {
    //数据库配置
    private static final String url = "jdbc:mysql://127.0.0.1:3306/mybatis-plus";
    private static final String username = "root";
    private static final String password = "123456";
    //表名
    private static final String tables = "alarm_record,car_member_info,car_moving_code";
    //生成路径
    private static final String generatePath = "D://template";

    public static void main(String[] args) {
        FastAutoGenerator.create(url, username, password)
                .globalConfig(builder -> {
                    builder.author("fanQie") // 设置作者
                            .fileOverride() // 覆盖已生成文件
                            .outputDir(generatePath); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent(""); // 设置父包名（我这边为空，因为我的项目目录结构不统一，所以在代码生成模板中自己定义了包名，如果你的目录结构比较清晰可以在这里设置父目录）
                })
                .strategyConfig(builder -> {
                    builder. addInclude(tables) // 设置需要生成的表名
                            //Entity 策略配置
                            .entityBuilder()
                            .enableLombok() //开启lombok
                            .enableTableFieldAnnotation();//开启生成实体时生成字段注解 默认值:false（加上这个配置生成的实体字段会有 @TableField()注解）
                })
                .templateEngine(new EnhanceFreemarkerTemplateEngine()) //自定义模板
                .execute();
    }
    /**
     * 代码生成器支持自定义模版
     */
    public final  static class EnhanceFreemarkerTemplateEngine extends FreemarkerTemplateEngine {

        @Override
        protected void outputCustomFile(@NotNull Map<String, String> customFile, @NotNull TableInfo tableInfo, @NotNull Map<String, Object> objectMap) {
            String entityName = tableInfo.getEntityName();
            String otherPath = this.getPathInfo(OutputFile.other);
            //自定义模板参数（定义的这些参数可以在我们的Freemark模板中使用&{}语法取到该值，比如 &{requestMapping}）
            objectMap.put("requestMapping", StringUtils.firstToLowerCase(entityName));
            objectMap.put("entityPackage", "com.ly.smallscene.database.entity.ticketsmallscene");
            objectMap.put("controllerPackage", "com.ly.smallscene.resourceadmin.modules." + tableInfo.getEntityName().toLowerCase());
            objectMap.put("facadePackage", "com.ly.smallscene.common.modules." + tableInfo.getEntityName().toLowerCase() + ".facade");
            objectMap.put("facadeImplPackage", "com.ly.smallscene.common.modules." + tableInfo.getEntityName().toLowerCase() + ".facade.impl");
            objectMap.put("servicePackage", "com.ly.smallscene.common.modules." + tableInfo.getEntityName().toLowerCase() + ".sevice");
            objectMap.put("servicePackageImpl", "com.ly.smallscene.common.modules." + tableInfo.getEntityName().toLowerCase() + ".sevice.impl");
            objectMap.put("mapperPackage", "com.ly.smallscene.database.mapper.ticketsmallscene");
            objectMap.put("requestPackage", "com.ly.smallscene.common.modules." + tableInfo.getEntityName().toLowerCase() + ".request");
            objectMap.put("responsePackage", "com.ly.smallscene.common.modules." + tableInfo.getEntityName().toLowerCase() + ".response");

            //设置要生成的文件名以及FreeMark模板文件路径
            customFile = new HashMap<>();
            customFile.put(entityName + StringPool.DOT_JAVA, "/template/entity.java.ftl");
            customFile.put(entityName + "Controller" + StringPool.DOT_JAVA, "/template/controller.java.ftl");
            customFile.put(entityName + "Facade" + StringPool.DOT_JAVA, "/template/facade.java.ftl");
            customFile.put(entityName + "FacadeImpl" + StringPool.DOT_JAVA, "/template/facadeImpl.java.ftl");
            customFile.put(entityName + "Service" + StringPool.DOT_JAVA, "/template/service.java.ftl");
            customFile.put(entityName + "ServiceImpl" + StringPool.DOT_JAVA, "/template/serviceImpl.java.ftl");
            customFile.put(entityName + "Mapper" + StringPool.DOT_JAVA, "/template/mapper.java.ftl");
            customFile.put(entityName + "Mapper" + StringPool.DOT_XML, "/template/mapper.xml.ftl");
            customFile.put(entityName + "SaveRequest" + StringPool.DOT_JAVA, "/template/saveRequest.java.ftl");
            customFile.put(entityName + "DeleteRequest" + StringPool.DOT_JAVA, "/template/deleteRequest.java.ftl");
            customFile.put(entityName + "UpdateRequest" + StringPool.DOT_JAVA, "/template/updateRequest.java.ftl");
            customFile.put(entityName + "DetailRequest" + StringPool.DOT_JAVA, "/template/detailRequest.java.ftl");
            customFile.put(entityName + "PageListRequest" + StringPool.DOT_JAVA, "/template/pageListRequest.java.ftl");
            customFile.put(entityName + "DetailResponse" + StringPool.DOT_JAVA, "/template/detailResponse.java.ftl");
            customFile.put(entityName + "PageListResponse" + StringPool.DOT_JAVA, "/template/pageListResponse.java.ftl");

            customFile.forEach((key, value) -> {
                //拼接生成文件的目录
                String fileName = otherPath + "/" + entityName + "/" +key;
                //核心方法来生成模板
                this.outputFile(new File(fileName), objectMap, value, this.getConfigBuilder().getInjectionConfig().isFileOverride());
            });
        }
    }
}

FreeMark模板

1.模板目录

在这里插入图片描述

2.controller.java.ftl代码

package ${controllerPackage};

import ${entityPackage}.${entity};
import ${servicePackage}.${table.serviceName};
import com.ly.smallscene.common.base.entity.BaseResponseEntity;
import com.ly.smallscene.common.base.tool.PageInfo;
import ${requestPackage}.${entity}SaveRequest;
import ${requestPackage}.${entity}DeleteRequest;
import ${requestPackage}.${entity}UpdateRequest;
import ${requestPackage}.${entity}DetailRequest;
import ${requestPackage}.${entity}PageListRequest;
import ${responsePackage}.${entity}DetailResponse;
import ${responsePackage}.${entity}PageListResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;
/**
* @author ${author}
* @since ${date}
*/
@Tag(name = "${(table.comment!?html?replace('\r\n','') )!}")
@RestController
@RequestMapping("${requestMapping}")
public class ${table.controllerName} {

    @Autowired
    private ${entity}Facade ${entity?uncap_first}Facade;

    @Operation(summary = "新增")
    @PostMapping(value = "/save")
    public BaseResponseEntity save(@RequestBody @Valid ${entity}SaveRequest request) {
        ${entity?uncap_first}Facade.save(request);
        return new BaseResponseEntity();
    }

    @Operation(summary = "删除")
    @PostMapping(value = "/delete")
    public BaseResponseEntity delete(@RequestBody @Valid ${entity}DeleteRequest request) {
        ${entity?uncap_first}Facade.delete(request);
        return new BaseResponseEntity();
    }

    @Operation(summary = "更新")
    @PostMapping(value = "/update")
    public BaseResponseEntity update(@RequestBody @Valid ${entity}UpdateRequest request) {
        ${entity?uncap_first}Facade.update(request);
        return new BaseResponseEntity();
    }

    @Operation(summary = "详情")
    @PostMapping(value = "/detail")
    public BaseResponseEntity detail(@RequestBody @Valid ${entity}DetailRequest request) {
        ${entity}DetailResponse response = ${entity?uncap_first}Facade.detail(request);
        return new BaseResponseEntity(response);
    }

    @Operation(summary = "分页列表")
    @PostMapping(value = "/pageList")
    public BaseResponseEntity pageList(@RequestBody ${entity}PageListRequest request) {
        PageInfo<${entity}PageListResponse> response = ${entity?uncap_first}Facade.pageList(request);
        return new BaseResponseEntity(response);
    }
}

3.entity.java.ftl代码

package ${entityPackage};

import com.baomidou.mybatisplus.annotation.TableName;
import com.baomidou.mybatisplus.annotation.IdType;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableField;
import java.io.Serializable;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.experimental.Accessors;

/**
* ${table.comment!}
* @author ${author}
* @since ${date}
*/
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("${table.name}")
public class ${entity} implements Serializable {

    private static final long serialVersionUID = 1L;

<#-- ----------  BEGIN 字段循环遍历  ---------->
<#list table.fields as field>
    <#if field.keyFlag>
        <#assign keyPropertyName="${field.propertyName}"/>
    </#if>

    <#if field.comment!?length gt 0>
    /**
    * ${field.comment}
    */
    </#if>
    <#if field.keyFlag>
    <#-- 主键 -->
        <#if field.keyIdentityFlag>
    @TableId(value = "${field.name}", type = IdType.AUTO)
        <#elseif idType??>
    @TableId(value = "${field.name}", type = IdType.${idType})
        <#elseif field.convert>
    @TableId("${field.name}")
        </#if>
    <#-- 普通字段 -->
    <#elseif field.fill??>
    <#-- -----   存在字段填充设置   ----->
        <#if field.convert>
    @TableField(value = "${field.name}", fill = FieldFill.${field.fill})
        <#else>
    @TableField(fill = FieldFill.${field.fill})
        </#if>
    <#elseif field.convert>
    @TableField("${field.name}")
    </#if>
    private ${field.propertyType} ${field.propertyName};
</#list>

}

总结

番丶茄
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
若依源码解析：代码生成ruoyi-generator
字节叔叔
05-29 8792
若依的代码生成器模块（ruoyi-generator）可以根据数据库表的设计信息和配置的模板，自动生成相应的Java代码文件。代码生成器使用Velocity作为模板引擎，根据模板文件中的占位符和变量替换规则，将元数据信息嵌入到生成的代码中，生成具体的代码文件。通过导入表结构和生成代码两个后端接口，实现了快速导入数据库表结构和生成代码的功能。
Mybatis plus 自动生成代码与自定义模板
热门推荐
学习学习学习学习
07-29 1万+
Mybatis-plus 生成代码，基于源码的自定义模板增强
使用 zliss-mybatis-generator 开源mybatis代码生成器生成mybatis代码 支持自定义模板
最新发布
xhei997的博客
05-12 254
只需简单引入后，即可使用生成数据库对应的mybatis代码文件，支持生成、maven-plugin插件方式生成。
完全开源的代码生成器之code-generator
沈光阳的博客
12-13 5586
code-generator是一个低代码平台, 可以解决90%单表增删改查工作量, 你可以通过自定义代码模板来生成适合自己的代码。目前该系统主要针对的是语言是java, 数据源是mysql(其他数据库待测试)，数据源支持mysql, oracle, dm, PostgreSql等数据库。支持vue前端吗?理论上只要你定义好了vue代码模板, 也是可以支持前端代码生成java8运行环境, 数据存储使用的是内嵌h2数据库(可切换到mysql)构建代码采用 maven3.8简介常用代码模板。
Mybatis-plus自定义模板生成代码
crabdave的博客
02-29 1296
Mybatis-plus自定义模板生成代码。
mybatis-generator:自我感觉不错的模板
书山有路，学海无涯
11-15 2734
mybatis generator配置文件
springboot3.2.1整合mybatis-plus-generator3.5.3，并自定义vm模板
weixin_44699860的博客
01-14 585
springboot3.2.1整合mybatis-plus-generator3.5.3，并自定义vm模板
MyBatis-plus框架代码生成器
12-10
MyBatis-plus框架代码生成器fengyuxinxing-generator
mybatis-plus 达梦 代码生成
06-10
提供修改数据库地址后可直接使用的代码，提供达梦7的驱动包 提供所需maven以来 驱动包放置仓库位置等
mybatis-puls自定义代码生成器
01-04
mybatis-puls自定义代码生成器，自动生成Api、service、dao、mapper
mybatis-plus代码生成器模版代码
08-17
mybatis-plus代码生成器模版代码
mybatis-plus自定义模板.zip
05-28
1、自定义模板 代码：https://blog.csdn.net/xionglangs/article/details/106396515
mybatis plus 代码生成器配置
weixin_44701385的博客
07-09 1104
代码生成器
mybatis-plus代码生成器自定义模板
weixin_38423691的博客
10-21 1665
最近接受到一个任务，代码生成器的开发。当时自己有两种思路来实现，第一种：自己写个程序，通过java代码生成，第二种：寻找第三方插件来支持，引用他们的。当时自己开发了一个代码生成器程序，但是不够完善，不能全面满足需求，还是借鉴他人意见，网上查询资料，发现Mybatis-plus插件还是挺不错，分享给大家，不过本人才疏学浅，若有说的不对，还望大家指出来。 Mybatis-plus官...
MyBatis-Plus代码生成器模板（适用3.5.1以下）
m0_51643873的博客
11-16 571
直接运行CodeGenerator即可。
mybatis-plus代码生成器的使用（一文搞定）
wnagchenyu的博客
04-27 404
mybatis-plus极大地简化我们做crud的开发，从而让我们有更多精力来从事业务流程的开发。我这边以最新版本为例讲解新版的代码生成器的使用。注：在resources下面建立templates目录，然后创建文件下面集成了增、删、多选项删除、查一个、查多个、查分页、和修改功能。
20个代码生成框架
12-22 4725
1.1 CodeSmith 一款人气很旺国外的基于模板的dotnet代码生成器 官方网站：http：//www.codesmithtools.com 官方论坛：http：//forum.codesmithtools.com/default.aspx 版权形式：30天试用 开源：否 需要先注册确认后才能下载 1.2 MyGenerator MyGenerator是又一个国外...
从零构建区块链量化交易平台实战
08-26
国内第一套区块链量化交易实战课程。本课程主要分享从零搭建区块链量化交易平台(包括Java后端、Web端、App端)的过程、途中遇到的问题及解决方法，帮助想尝试量化交易的战友的少走弯路，更有效率的提升自己的能力。同时也分享一些个人在量化交易领域的心得体会。
【超好用】自定义的mybatis-plus代码生成器
杨大仙
02-19 2672
你是否也有这样的烦恼：每次写代码都需要创建很多包很多层很多类很多接口？耗时且费力姑且不谈，有时可能还大意了没有闪，搞出一堆bug这谁顶得住啊都3202年了，让程序自力更生吧！！
mybatis-plus自定义代码生成
09-07
mybatis-plus是一个支持自定义代码生成的框架。如果需要根据实体类生成自定义controller、service、mapper、entity文件，可以使用mybatis-plus的自定义引擎功能。具体使用方式如下： 1. 首先，引用mybatis-plus的源码，可以从以下链接获取： 2. 在项目中注入配置，在注入配置的过程中，可以使用自定义模板和map，根据项目需要进行封装。示例代码如下： 3. 使用自定义模板引擎，可以选择EnhanceVelocityTemplaEngine作为模板引擎。示例代码如下： 4. 确保正确引用了mybatis-plus，并设置了自定义引擎文件。自定义引擎文件可以是多种格式，一般使用vm资源。 通过以上步骤，你就可以使用mybatis-plus的自定义代码生成功能来生成自定义的controller、service、mapper、entity文件了。<span class="em">1</span><span class="em">2</span><span class="em">3</span><span class="em">4</span>

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值