基于SpringBoot+MyBatis-Plus的代码生成器

已于 2024-04-11 14:25:16 修改
阅读量637 收藏 3
点赞数 14
分类专栏： Spring系列 文章标签： springboot 代码生成 mybatis-plus
于 2024-04-09 15:09:31 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39311781/article/details/137552782
版权

一、功能说明

  • 数据源管理：实现多个数据库的表代码生成
  • 表管理：从数据源导入表，配置表和字段
  • 默认配置：配置项目默认信息，配置字段数据类型映射
  • 操作日志

功能截图

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

二、代码实现

  • 基于velocity-engine模板代码生成
package com.qiangesoft.bootcodegen.utils;

import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.config.ConstVal;
import com.baomidou.mybatisplus.generator.util.FileUtils;
import com.qiangesoft.bootcodegen.constant.CodegenConstant;
import com.qiangesoft.bootcodegen.entity.BcgTableColumn;
import com.qiangesoft.bootcodegen.framework.config.CodeGenParam;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;

import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;

/**
 * 代码生成工具类
 *
 * @author qiangesoft
 * @date 2023-09-29
 */
public class CodeGenUtil {

    /**
     * 路径分隔符
     */
    public static final String FILE_SEP = "/";

    /**
     * java路径
     */
    public static final String JAVA_PATH = FILE_SEP + "src" + FILE_SEP + "main" + FILE_SEP + "java";

    /**
     * 资源文件路径
     */
    public static final String RESOURCES_PATH = FILE_SEP + "src" + FILE_SEP + "main" + FILE_SEP + "resources";

    /**
     * 控制层
     */
    public static String CONTROLLER = "controller";

    /**
     * 实体类
     */
    public static String ENTITY = "entity";

    /**
     * 服务层接口
     */
    public static String SERVICE = "service";

    /**
     * 服务层实现类
     */
    public static String SERVICE_IMPL = "serviceImpl";

    /**
     * 持久层
     */
    public static String MAPPER = "mapper";

    /**
     * 持久层xml
     */
    public static String MAPPER_XML = "mapperXml";

    /**
     * 查询对象
     */
    public static String QUERY = "query";

    /**
     * 传输对象
     */
    public static String DTO = "dto";

    /**
     * 对象转换
     */
    public static String CONVERT = "convert";

    /**
     * 视图对象
     */
    public static String VO = "vo";

    /**
     * vue页面
     */
    public static String PAGE = "page";

    /**
     * js代码
     */
    public static String API_JS = "api";

    /**
     * 模板文件
     */
    public static final Map<String, String> TEMPLATE_MAP = new HashMap<>();

    /**
     * 模板文件位置
     */
    static {
        TEMPLATE_MAP.put(CONTROLLER, FILE_SEP + "templates" + FILE_SEP + "controller.java.vm");
        TEMPLATE_MAP.put(ENTITY, FILE_SEP + "templates" + FILE_SEP + "entity.java.vm");
        TEMPLATE_MAP.put(SERVICE, FILE_SEP + "templates" + FILE_SEP + "service.java.vm");
        TEMPLATE_MAP.put(SERVICE_IMPL, FILE_SEP + "templates" + FILE_SEP + "serviceImpl.java.vm");
        TEMPLATE_MAP.put(MAPPER, FILE_SEP + "templates" + FILE_SEP + "mapper.java.vm");
        TEMPLATE_MAP.put(QUERY, FILE_SEP + "templates" + FILE_SEP + "Query.java.vm");
        TEMPLATE_MAP.put(DTO, FILE_SEP + "templates" + FILE_SEP + "DTO.java.vm");
        TEMPLATE_MAP.put(VO, FILE_SEP + "templates" + FILE_SEP + "VO.java.vm");
        TEMPLATE_MAP.put(CONVERT, FILE_SEP + "templates" + FILE_SEP + "Convert.java.vm");
        TEMPLATE_MAP.put(MAPPER_XML, FILE_SEP + "templates" + FILE_SEP + "mapper.xml.vm");
        TEMPLATE_MAP.put(PAGE, FILE_SEP + "templates" + FILE_SEP + "page.vue.vm");
        TEMPLATE_MAP.put(API_JS, FILE_SEP + "templates" + FILE_SEP + "api.js.vm");
    }

    /**
     * 代码存放路径
     */
    public static Map<String, String> codeGenFilePath(String genModule, String genPackage) {
        Map<String, String> codeGenFilePackage = codeGenFilePackage(genModule, genPackage);

        Map<String, String> map = new HashMap<>();
        String controllerPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(CONTROLLER).replace(".", FILE_SEP) + FILE_SEP;
        String entityPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(ENTITY).replace(".", FILE_SEP) + FILE_SEP;
        String servicePath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(SERVICE).replace(".", FILE_SEP) + FILE_SEP;
        String serviceImplPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(SERVICE_IMPL).replace(".", FILE_SEP) + FILE_SEP;
        String mapperPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(MAPPER).replace(".", FILE_SEP) + FILE_SEP;
        String queryPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(QUERY).replace(".", FILE_SEP) + FILE_SEP;
        String dtoPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(DTO).replace(".", FILE_SEP) + FILE_SEP;
        String voPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(VO).replace(".", FILE_SEP) + FILE_SEP;
        String convertPath = JAVA_PATH + FILE_SEP + codeGenFilePackage.get(CONVERT).replace(".", FILE_SEP) + FILE_SEP;
        String mapperXmlPath = RESOURCES_PATH + FILE_SEP + "mapper" + FILE_SEP + (StringUtils.isNotBlank(genModule) ? genModule + FILE_SEP : "");
        String pagePath = FILE_SEP + "page" + FILE_SEP + "views" + FILE_SEP;
        String apiJsPath = FILE_SEP + "page" + FILE_SEP + "api" + FILE_SEP;
        map.put(CONTROLLER, controllerPath);
        map.put(ENTITY, entityPath);
        map.put(SERVICE, servicePath);
        map.put(SERVICE_IMPL, serviceImplPath);
        map.put(MAPPER, mapperPath);
        map.put(QUERY, queryPath);
        map.put(DTO, dtoPath);
        map.put(VO, voPath);
        map.put(CONVERT, convertPath);
        map.put(MAPPER_XML, mapperXmlPath);
        map.put(PAGE, pagePath);
        map.put(API_JS, apiJsPath);
        return map;
    }

    /**
     * java代码包路径
     */
    public static Map<String, String> codeGenFilePackage(String genModule, String genPackage) {
        Map<String, String> map = new HashMap<>();
        String packagePath = StringUtils.isNotBlank(genModule) ? genPackage + "." + genModule : genPackage;
        String controllerPath = packagePath + ".controller";
        String entityPath = packagePath + ".entity";
        String servicePath = packagePath + ".service";
        String serviceImplPath = servicePath + ".impl";
        String mapperPath = packagePath + ".mapper";
        String queryPath = packagePath + ".pojo.query";
        String dtoPath = packagePath + ".pojo.dto";
        String voPath = packagePath + ".pojo.vo";
        String convertPath = packagePath + ".pojo.convert";
        map.put(CONTROLLER, controllerPath);
        map.put(ENTITY, entityPath);
        map.put(SERVICE, servicePath);
        map.put(SERVICE_IMPL, serviceImplPath);
        map.put(MAPPER, mapperPath);
        map.put(QUERY, queryPath);
        map.put(DTO, dtoPath);
        map.put(VO, voPath);
        map.put(CONVERT, convertPath);
        return map;
    }

    /**
     * 本地项目生成
     */
    public static void genLocal(CodeGenParam codeGenParam) throws IOException {
        // 1.初始化Velocity引擎
        initVelocity();

        // 2.加载velocity容器
        VelocityContext velocityContext = buildVelocityContext(codeGenParam);

        // 3.生成文件
        String genClass = codeGenParam.getGenClass();
        Map<String, String> map = codeGenFilePath(codeGenParam.getGenModule(), codeGenParam.getGenPackage());
        for (String key : map.keySet()) {
            String templatePath = TEMPLATE_MAP.get(key);
            String filePath = map.get(key);
            String fileName = getFileName(genClass, key, templatePath, filePath);
            File file = new File(codeGenParam.getGenPath() + fileName);
            boolean exist = file.exists();
            if (!exist) {
                File parentFile = file.getParentFile();
                FileUtils.forceMkdir(parentFile);
            }
            Template template = Velocity.getTemplate(templatePath, ConstVal.UTF8);
            try (FileOutputStream fos = new FileOutputStream(file);
                 OutputStreamWriter ow = new OutputStreamWriter(fos, ConstVal.UTF8);
                 BufferedWriter writer = new BufferedWriter(ow)) {
                template.merge(velocityContext, writer);
            } catch (Exception e) {
                throw new RuntimeException("代码生成失败");
            }
        }
    }

    /**
     * 下载代码
     *
     * @param codeGenParam
     * @param response
     */
    public static void genDownload(CodeGenParam codeGenParam, HttpServletResponse response) {
        // 1.初始化Velocity引擎
        initVelocity();

        // 2.加载velocity容器
        VelocityContext velocityContext = buildVelocityContext(codeGenParam);

        // 3.生成文件
        String genClass = codeGenParam.getGenClass();
        Map<String, String> map = codeGenFilePath(codeGenParam.getGenModule(), codeGenParam.getGenPackage());
        try {
            ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
            ZipOutputStream zipOutputStream = new ZipOutputStream(outputStream);
            for (String key : map.keySet()) {
                String templatePath = TEMPLATE_MAP.get(key);
                String filePath = map.get(key);
                String fileName = getFileName(genClass, key, templatePath, filePath).replaceFirst("/", "");
                creatZipEntry(templatePath, fileName, velocityContext, zipOutputStream);
            }
            IOUtils.closeQuietly(zipOutputStream);
            byte[] bytes = outputStream.toByteArray();
            response.reset();
            response.setHeader("Content-Disposition", "attachment; filename=code.zip");
            response.addHeader("Content-Length", "" + bytes.length);
            response.setContentType("application/octet-stream; charset=UTF-8");
            IOUtils.write(bytes, response.getOutputStream());
        } catch (Exception e) {
            throw new RuntimeException("代码生成失败");
        }
    }

    /**
     * 初始化vm
     */
    private static void initVelocity() {
        Properties properties = new Properties();
        properties.setProperty(ConstVal.VM_LOAD_PATH_KEY, ConstVal.VM_LOAD_PATH_VALUE);
        properties.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, StringPool.EMPTY);
        properties.setProperty(Velocity.ENCODING_DEFAULT, ConstVal.UTF8);
        properties.setProperty(Velocity.INPUT_ENCODING, ConstVal.UTF8);
        properties.setProperty("file.resource.loader.unicode", StringPool.TRUE);

        Velocity.init(properties);
    }

    /**
     * 变量替换参数
     *
     * @param codeGenParam
     * @return
     */
    private static VelocityContext buildVelocityContext(CodeGenParam codeGenParam) {
        VelocityContext velocityContext = new VelocityContext();
        velocityContext.put("tableName", codeGenParam.getTableName());
        velocityContext.put("genAuthor", codeGenParam.getGenAuthor());
        velocityContext.put("genDate", codeGenParam.getGenDate());
        velocityContext.put("genFunction", codeGenParam.getGenFunction());
        velocityContext.put("genClass", codeGenParam.getGenClass());
        char firstChar = codeGenParam.getGenClass().charAt(0);
        velocityContext.put("genClassCamel", Character.toLowerCase(firstChar) + codeGenParam.getGenClass().substring(1));
        List<BcgTableColumn> columnList = codeGenParam.getColumnList();
        velocityContext.put("columnList", columnList);
        velocityContext.put("controllerMapping", TableColumnInitUtil.camelToChar(codeGenParam.getGenClass(), '-'));
        velocityContext.put("packageConfig", codeGenFilePackage(codeGenParam.getGenModule(), codeGenParam.getGenPackage()));
        velocityContext.put("columnConfig", CodegenConstant.COLUMN_CONFIG);
        for (BcgTableColumn tableColumn : columnList) {
            if (tableColumn.getColumnPk()) {
                velocityContext.put("idConfig", tableColumn);
                break;
            }
        }

        velocityContext.put("hutoolStrUtil", cn.hutool.core.util.StrUtil.class);
        return velocityContext;
    }

    /**
     * 文件信息
     *
     * @param genClass
     * @param key
     * @param templatePath
     * @param filePath
     * @return
     */
    private static String getFileName(String genClass, String key, String templatePath, String filePath) {
        String fileBaseName = templatePath.substring(templatePath.lastIndexOf('/') + 1, templatePath.lastIndexOf('.'));
        String fileName;
        if (ENTITY.equals(key)) {
            fileName = filePath + genClass + ".java";
        } else if (PAGE.equals(key)) {
            fileName = filePath + genClass + ".vue";
        } else if (API_JS.equals(key)) {
            fileName = filePath + genClass + ".js";
        } else if (SERVICE.equals(key)) {
            fileName = filePath + "I" + genClass + Character.toUpperCase(fileBaseName.charAt(0)) + fileBaseName.substring(1);
        } else {
            fileName = filePath + genClass + Character.toUpperCase(fileBaseName.charAt(0)) + fileBaseName.substring(1);
        }
        return fileName;
    }

    /**
     * 合成单个文件
     *
     * @param templatePath
     * @param fileName
     * @param velocityContext
     * @param zipOutputStream
     */
    private static void creatZipEntry(String templatePath, String fileName, VelocityContext velocityContext, ZipOutputStream zipOutputStream) throws IOException {
        // 加载模板并替换变量
        try (StringWriter stringWriter = new StringWriter()) {
            Template template = Velocity.getTemplate(templatePath, ConstVal.UTF8);
            template.merge(velocityContext, stringWriter);
            zipOutputStream.putNextEntry(new ZipEntry(fileName));
            String content = stringWriter.toString();
            zipOutputStream.write(content.getBytes(ConstVal.UTF8));
            zipOutputStream.flush();
            zipOutputStream.closeEntry();
        }
    }

}

完整代码下载：https://gitee.com/qiangesoft/boot-codegen

PG_强哥
关注
  • 14
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
mybatis-plus代码生成器详细教程与代码
m0_65818274的博客
07-24 5826
mybatis-plus代码生成器是一个工具类，它可以根据数据库表的结构，自动创建对应的实体类、mapper接口、mapper.xml文件、service接口和controller类。这样可以节省开发者的时间和精力，避免重复的编码工作。mybatis-plus代码生成器的使用步骤如下：
MyBatis-Plus可视化代码生成器，让你的开发效率大大提速
吴名氏的博客
12-26 3万+
MyBatis-Plus可视化代码生成器，让你的开发效率大大提速
MybatisPlus代码生成器
最新发布
风止的博客
05-23 825
MyBatis-Plus 的代码生成器主要是基于 MyBatis-Plus 的元数据分析功能，通过读取数据库中的表结构信息，生成对应的 Entity、Mapper、Service、Controller 等代码文件。代码生成器首先连接到数据库，读取数据库中的表结构信息，包括表名、字段名、字段类型、注释等元数据信息。代码生成器使用模板引擎来生成代码文件。模板文件定义了生成文件的结构和内容，其中可以包含一些占位符，用于动态替换成实际的数据，如表名、字段名等。
【我的开源】拿来即用！代码生成器：mybatis-plus-generator自定义模板生成 DTO、VO、Convertor、增删改查方法
万物皆字节
08-06 7992
在开发后台管理系统的时候，感觉基本上操作都是一样的：curd，于是借助并扩展mp的代码生成器自动生成一套api,减少重复劳动而且还统一规范，何乐而不为
MyBatis-Plus代码生成器（最新版适合新手跟做）
qq_62325622的博客
11-22 8453
本文介绍了mybatis-plus3.5.1后的代码生成器的使用，适合新手一步一步的按照操作进行，没有雷点。
MyBatis-Plus代码生成器（新）使用
Young_深情不及里子的博客
08-25 2万+
如何一键实现springboot基础代码完全实现，一篇文章给你参考，提高开发效率！
Mybatis-plus-代码生成器-官网学习
weixin_42517021的博客
08-30 5950
Mybatis-plus -- 快速入门简介特性功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入 简介 mybatis和mybatis-plus之间有什么区别?首先mybatis-plus只是在mybatis的基础上只做增加没有做修
springboot+mybatis-plus+jwt+redis的简易后端框架
04-10
1.快速搭建springboot+mybatis-plus代码自动生成器的后端框架https://blog.csdn.net/pengpm/article/details/124047191?spm=1001.2014.3001.5501 2.springboot+JWT+redis实现token身份令牌验证（附代码）（超详细） ...
springboot + mybatis-plus + oracle + 多数据源 + redis + hutool
04-06
配置了MP的代码生成器，意见生成代码，节省开发时间！ 可用于各种定时任务处理，各种夸库操作， 多数据源支持Oracle、Mysql、Sql Server 等数据库夸库操作，使用 @DS 切换数据源。， 可设置多主多从 、纯粹多库...
springboot+mybatis-plus 代码生成器 CRUD 分页插件
12-21
1 添加mybatis-plus相关依赖 com.baomidou mybatis-plus-boot-starter 3.1.1 com.baomidou mybatis-plus-generator 3.1.1 org.apache.velocity velocity-engine-core 2.1 org.projectlombok ...
SpringBoot集成MyBatis-Plus实现国产数据库适配.docx
05-20
* 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、Model 、Service 、Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用 * 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体...
SpringBoot整合MyBatis-Plus
06-17
SpringBoot整合MyBatis-Plus小Demo，含有MyBatis代码生成器
MybatisPlus---代码生成器
zerodiyi的博客
12-22 651
/ 比如当前项目为springboot,它所在的路径为D://aa/springboot，所以System.getProperty("user.dir")就表示D://aa/springboot。// 默认的父包是"com.baomidou", 它会自动放在上面设置的globalConfig.setOutputDir路径下,此时也就变成了/springboot1/src/main/java/com/example。//设置生成的包的名字为bb.aa， 通过改变包的名字，可以将生成的包放在指定的包下，
Mybatis Plus————代码生成器
热门推荐
Morty的技术乐园
06-17 11万+
代码生成器MyBatis Plus是MyBatis的扩展框架，而代码生成器是MP的核心功能之一，另外还有 “条件构造器”和“通用CRUD”等功能。步骤演示mp的代码生成器有两种方式自动生成代码，一种是通过main方法来执行程序，另一种是通过maven插件build产生。第二种方法需要在pom.xml中添加大量的配置信息，因此本人偏向于使用第一种方式。步骤如下：一、添加mybatis plus依赖：...
springboot mybatis-plus 代码生成工具
北巷东东的专栏
06-08 1231
springboot mybatis-plus 代码生成工具
MyBatis-Plus——代码自动生成器
m0_67402235的博客
07-28 4320
回想我们之前进行开发的过程，首先我们需要编写与数据库表对应的实体类，接着再进行创建各种层次的包（mapper,service,impl)，这个过程是不是感觉特别漫长呢，而现在一款神器MpBatis-Plus的代码自动生成器。一、介绍代码自动生成器非常好用，我们只需要提供我们数据库的表名，然后就可以让生成器自动帮我们完成各种代码的创建，整个过程非常清爽，可以说是加班人的福利！现在我们就来讲解怎么搭建这个代码自动生成器！...
【重要】springboot实战（六）之mybatis-plus代码自动生成器
it_erge的博客
09-06 3995
mybatis-plus代码生成器，会生成controller、servce、mapper、entity、mapper.xml等文件，大大减少编码工作量，将有限的工作时间放在业务处理上，提高编程效率，同时本文章也给出了分页查询的实践。
springboot+mybatisp-plus自动生成代码
08-28
Spring Boot和MyBatis-Plus是常用于Java开发的两个框架。Spring Boot是一个用于快速构建基于Spring的应用程序的框架，它简化了Spring应用的配置和部署。MyBatis-Plus是一个基于MyBatis的增强工具，提供了更便捷的操作数据库的方式。 在使用Spring Boot和MyBatis-Plus时，可以使用MyBatis-Plus提供的代码生成器来自动生成代码。代码生成器可以根据数据库中的表结构自动生成实体类、Mapper接口和XML文件，并提供一些常用的CRUD方法。 使用Spring Boot和MyBatis-Plus生成代码的步骤如下： 1. 首先，在pom.xml文件中添加MyBatis-Plus和数据库驱动的依赖。 2. 在Spring Boot的配置文件中配置数据库连接信息。 3. 创建数据库表，并确保表结构正确。 4. 创建一个代码生成器的配置类，配置生成的代码的包名、作者、父类等信息。 5. 运行代码生成器，即可自动生成实体类、Mapper接口和XML文件。 需要注意的是，代码生成器生成的代码是基础的CRUD操作，可能需要根据实际业务需求进行进一步的修改和扩展。 通过使用Spring Boot和MyBatis-Plus的代码生成器，可以快速生成基于数据库表结构的实体类和数据库操作代码，提高开发效率。<span class="em">1</span> #### 引用[.reference_title] - *1* [基于springboot+mybatis-plus+mysql+vue音乐网站管理系统](https://download.csdn.net/download/Timi2019/87746549)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 100%"] [ .reference_list ]

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

PG_强哥

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值