FreeMarker代码生成器和Mybatis-plus代码生成器之一

最新推荐文章于 2024-04-23 23:17:15 发布
最新推荐文章于 2024-04-23 23:17:15 发布
阅读量822 收藏 6
点赞数 10
文章标签： java 开发语言 mybatis maven
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45440755/article/details/136118828
版权

1. 利用freemarker和mybatis进行代码生成

1.1 利用mybatis-gengerator插件为数据库生成

在项目模块依赖中导入插件以及数据库连接依赖

<!-- mybatis generator 自动生成代码插件 -->  
            <plugin>  
                <groupId>org.mybatis.generator</groupId>  
                <artifactId>mybatis-generator-maven-plugin</artifactId>  
                <version>1.4.0</version>  
                    <configurationFile>src/main/resources/generator-config-business.xml</configurationFile>  
                    <overwrite>true</overwrite>  
                    <verbose>true</verbose>  
                </configuration>                
                <dependencies>                    
	                <dependency>                        
		                <groupId>mysql</groupId>  
                        <artifactId>mysql-connector-java</artifactId>  
                        <version>8.0.22</version>  
                    </dependency>                
                </dependencies>            
	        </plugin>

在为XXX数据库生成文件时，直接修改configurationFile中的参数即可，改换xml文件。XML文件的定义如下所示

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE generatorConfiguration  
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"  
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">  
  
<generatorConfiguration>  
    <context id="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">  
  
        <!-- 自动检查关键字，为关键字增加反引号 -->  
        <property name="autoDelimitKeywords" value="true"/>  
        <property name="beginningDelimiter" value="`"/>  
        <property name="endingDelimiter" value="`"/>  
  
        <!--覆盖生成XML文件-->  
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />  
        <!-- 生成的实体类添加toString()方法 -->  
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>  
  
        <!-- 不生成注释 -->  
        <commentGenerator>  
            <property name="suppressAllComments" value="true"/>  
        </commentGenerator>  
        <!-- 配置数据源，需要根据自己的项目修改 -->  
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"  
                        connectionURL="XXX"  
                        userId="XXX"  
                        password="XXX">  
        </jdbcConnection>  
        <!-- domain类的位置 targetProject是相对pom.xml的路径-->  
        <javaModelGenerator targetProject="../business/src/main/java"  
                            targetPackage="com.monster.business.domain"/>  
  
        <!-- mapper xml的位置 targetProject是相对pom.xml的路径 -->  
        <sqlMapGenerator targetProject="../business/src/main/resources"  
                         targetPackage="mapper"/>  
  
        <!-- mapper类的位置 targetProject是相对pom.xml的路径 -->  
        <javaClientGenerator targetProject="../business/src/main/java"  
                             targetPackage="com.monster.business.mapper"  
                             type="XMLMAPPER"/>  
		<!-- 需要为多少个表生成，则依次填写即可-->  
        <table tableName="station" domainObjectName="Station"/>  
    </context></generatorConfiguration>

此时部署已经完成，找到Maven中该模块的插件，找到mybatis-generator，启动即可，如下图所示：
在这里插入图片描述

1.2 利用freemarker快速生成增删改查以及Vue文件

首先需要编写模块文件即ftl文件，例子如下所示：，其中的${module}由代码生成类进行注入

package com.monster.${module}.req;  
  
import com.monster.common.req.PageReq;  
  
public class ${Domain}QueryReq extends PageReq {  
  
    @Override  
    public String toString() {  
        return "${Domain}QueryReq{" +  
                "} " + super.toString();  
    }  
}

在有了模板之后，需要进行模板读取，以及根据模板生成文件，定义为FreemarkerUtil类

package com.monster.train.generator.util;  
import freemarker.template.Configuration;  
import freemarker.template.DefaultObjectWrapper;  
import freemarker.template.Template;  
import freemarker.template.TemplateException;  
  
import java.io.BufferedWriter;  
import java.io.File;  
import java.io.FileWriter;  
import java.io.IOException;  
import java.util.Map;  
  
public class FreemarkerUtil {  
	  //ftl文件所在位置
    static String ftlPath = "generator/src/main/java/com/monster/train/generator/ftl/";  
  
    static Template temp;  
  
    /**  
     * 读模板  
     */  
    public static void initConfig(String ftlName) throws IOException {  
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_31);  
        cfg.setDirectoryForTemplateLoading(new File(ftlPath));  
        cfg.setObjectWrapper(new DefaultObjectWrapper(Configuration.VERSION_2_3_31));  
        temp = cfg.getTemplate(ftlName);  
    }  
  
    /**  
     * 根据模板，生成文件  
     */  
    public static void generator(String fileName, Map<String, Object> map) throws IOException, TemplateException {  
        FileWriter fw = new FileWriter(fileName);  
        BufferedWriter bw = new BufferedWriter(fw);  
        temp.process(map, bw);  
        bw.flush();  
        fw.close();  
    }  
}

由于针对数据库的表进行模板生成文件，会进行数据库连接的操作，再定义一个DBUtil类（不再展示，可以私信博主获取）
针对数据库表中属性，会有不同的类型，由此再定义一个Field类，来声明所有的属性类型
至此，编写代码生成器类，如下所示：

package com.monster.train.generator.gen;  
  
import com.monster.train.generator.util.Field;  
import com.monster.train.generator.util.FreemarkerUtil;  
import com.monster.train.generator.util.DbUtil;  
import freemarker.template.TemplateException;  
import org.dom4j.Document;  
import org.dom4j.DocumentException;  
import org.dom4j.Node;  
import org.dom4j.io.SAXReader;  
  
import java.io.File;  
import java.io.IOException;  
import java.util.*;  
  
public class ServerGenerator {  
    static boolean readOnly = false;  
    static String vuePath = "admin/src/views/main/";  
    static String serverPath = "[module]/src/main/java/com/monster/[module]/";  
    static String pomPath = "generator/pom.xml";  
    //为哪个模块生成代码，则修改
    static String module = "XXX";  
    static {  
        new File(serverPath).mkdirs();  
    }  
  
    public static void main(String[] args) throws Exception {  
        // 获取mybatis-generator  
        String generatorPath = getGeneratorPath();  
        // 比如generator-config-member.xml，得到module = member  
        module = generatorPath.replace("src/main/resources/generator-config-", "").replace(".xml", "");  
        System.out.println("module: " + module);  
        serverPath = serverPath.replace("[module]", module);  
        // new File(servicePath).mkdirs();  
        System.out.println("servicePath: " + serverPath);  
  
        // 读取table节点  
        Document document = new SAXReader().read("generator/" + generatorPath);  
        Node table = document.selectSingleNode("//table");  
        System.out.println(table);  
        Node tableName = table.selectSingleNode("@tableName");  
        Node domainObjectName = table.selectSingleNode("@domainObjectName");  
        System.out.println(tableName.getText() + "/" + domainObjectName.getText());  
  
        // 为DbUtil设置数据源  
        Node connectionURL = document.selectSingleNode("//@connectionURL");  
        Node userId = document.selectSingleNode("//@userId");  
        Node password = document.selectSingleNode("//@password");  
        System.out.println("url: " + connectionURL.getText());  
        System.out.println("user: " + userId.getText());  
        System.out.println("password: " + password.getText());  
        DbUtil.url = connectionURL.getText();  
        DbUtil.user = userId.getText();  
        DbUtil.password = password.getText();  
  
        // 示例：表名 monster_test        // Domain = monsterTest        String Domain = domainObjectName.getText();  
        // domain = monsterTest  
        String domain = Domain.substring(0, 1).toLowerCase() + Domain.substring(1);  
        // do_main = monster-test  
        String do_main = tableName.getText().replaceAll("_", "-");  
        // 表中文名  
        String tableNameCn = DbUtil.getTableComment(tableName.getText());  
        List<Field> fieldList = DbUtil.getColumnByTableName(tableName.getText());  
        Set<String> typeSet = getJavaTypes(fieldList);  
  
        // 组装参数  
        Map<String, Object> param = new HashMap<>();  
        param.put("module", module);  
        param.put("Domain", Domain);  
        param.put("domain", domain);  
        param.put("do_main", do_main);  
        param.put("tableNameCn", tableNameCn);  
        param.put("fieldList", fieldList);  
        param.put("typeSet", typeSet);  
        param.put("readOnly", readOnly);  
        System.out.println("组装参数：" + param);  
  
        gen(Domain, param, "service", "service");  
        gen(Domain, param, "controller/admin", "adminController");  
        gen(Domain, param, "req", "saveReq");  
        gen(Domain, param, "req", "queryReq");  
        gen(Domain, param, "resp", "queryResp");  
    }  
  
    private static void gen(String Domain, Map<String, Object> param, String packageName, String target) throws IOException, TemplateException {  
        FreemarkerUtil.initConfig(target + ".ftl");  
        String toPath = serverPath + packageName + "/";  
        new File(toPath).mkdirs();  
        String Target = target.substring(0, 1).toUpperCase() + target.substring(1);  
        String fileName = toPath + Domain + Target + ".java";  
        System.out.println("开始生成：" + fileName);  
        FreemarkerUtil.generator(fileName, param);  
    }  
  
    private static void genVue(String do_main, Map<String, Object> param) throws IOException, TemplateException {  
        FreemarkerUtil.initConfig("vue.ftl");  
        new File(vuePath + module).mkdirs();  
        String fileName = vuePath + module + "/" + do_main + ".vue";  
        System.out.println("开始生成：" + fileName);  
        FreemarkerUtil.generator(fileName, param);  
    }  
  
    private static String getGeneratorPath() throws DocumentException {  
        SAXReader saxReader = new SAXReader();  
        Map<String, String> map = new HashMap<String, String>();  
        map.put("pom", "http://maven.apache.org/POM/4.0.0");  
        saxReader.getDocumentFactory().setXPathNamespaceURIs(map);  
        Document document = saxReader.read(pomPath);  
        Node node = document.selectSingleNode("//pom:configurationFile");  
        System.out.println(node.getText());  
        return node.getText();  
    }  
  
    /**  
     * 获取所有的Java类型，使用Set去重  
     */  
    private static Set<String> getJavaTypes(List<Field> fieldList) {  
        Set<String> set = new HashSet<>();  
        for (int i = 0; i < fieldList.size(); i++) {  
            Field field = fieldList.get(i);  
            set.add(field.getJavaType());  
        }  
        return set;  
    }  
}

该生成器类会与generator-config-XXX.xml进行相关联，获取其中的参数，点击运行之后为其中声明的表生成相应的增删改查类。

小黄妖怪
关注
  • 10
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
mybatis自动生成代码的模板--freemarker版本.zip
03-11
附件包含了mybatis-plus自动生成代码，基于freemarker的模板。包括常规的curd。 【特点】针对每个接口都有对应的入参和出参，不公用entity。 如，add接口，则入参会自动生成为addEntityReq。具体可下载模板进行查看...
mybatis-plus-generator：代码生成器
02-21
mybatis-plus-generator：代码生成器
（企业 / 公司项目）代码生成器底层原理：模板框架freemarker
全栈技术分享，项目分享，资料分享
12-18 490
启动类需要两个参数， 一个就是生成的路径，还有生成文件的名字 ServerGenerator.java。json还未流行时，数据传递都是用xml，传递同样的数据xml包更大，不利于传输 所以现在很少项目使用。2.也可以进行复杂Excel到处：可以转成xml，用xml来制作模板，在生成excel。3.需要批量生成格式固定的一类文件的需求也可以使用模板框架freemarker。1.按照设置好的模板文件就能生成Java，vue文件，前后端都可生成。首先引入相对应的依赖pom.xml。首先导入dom4j依赖。
基于freemarker构建专属代码生成器——代码生成器的底层原理
最新发布
m0_47532096的博客
04-23 612
通常来讲，在Java开发中最基本的也是占用我们最大量事件的就是CRUD，也就是频繁地构造“实体类”、“dao层代码”以及相关的service层和controller层的代码。其实，这一部分工作，可以使用代码生成器来完成，这里就要用到，我们的freemarker引擎了，我们需要将刚刚的代码复制到Hello.ftl文件中，然后将World和world提出按成变量（注意这里区分大小写）当然，我们可以使用循环，判断等逻辑表达生成更加复杂，通用性更好的模板。经过这样的三步走，最终就是我们的想要生成的目标代码。
Mybatis-Plus 3.5.2 + Freemake代码生成器
qq_21344887的博客
06-27 1599
代码生成器
Mybatis-Plus代码生成器-FreeMarker引擎
weixin_44309173的博客
02-24 2056
代码生成操作步骤 引入依赖 添加配置 ftl文件 编写配置类 配置类编写内容 new 代码生成器AutoGenerator 全局配置GlobalConfig 数据源配置DataSourceConfig 包配置PackageConfig 模板配置TemplateConfig 策略配置StrategyConfig 切面配置InjectionConfig（可不要，配置额外输出文件。如：SpringCloud的Feign接口） FreeMarker引擎配置 execute执行 FreeMa
FreeMarker--01---简介、环境搭建
时光里的博客
09-16 1083
文章目录FreeMarker[ FreeMarker官网: http://freemarker.foofun.cn/](http://freemarker.foofun.cn/)FreeMarker概念FreeMarker 是一款 模板引擎,是一套视图模板技术FreeMarker特性:FreeMarker环境搭建新建 Maven Web项目pom.xml修改配置文件 web.xml编写Servlet类-----FreeMarker01新建模板文件 ftl启动项目----jetty启动jetty:run -D
MyBatisPlus3--freemarker自定义模板
weixin_43671737的博客
06-04 7083
MyBatisPlus3–freemarker自定义模板 导包 <!--MyBatisPlus依赖模块--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.3.2</version> <
系统自动生成简单的代码生成器
01-20
mybatis-plus-generator 3.3.1.tmp org.springframework.boot spring-boot-starter-freemarker 2.创建生成一个类 package com.ysd.config; import ...
Java一键生成代码到controller层【源码】
11-26
2、对springboot，spring，mybatis，mybatis plus，mysql，freemarker等java技术有基本应用。 3、可大大提高开发效率，数据表创建完以后，自动生成entity,mapper.xml,dao,service,controller,vo,dto相关代码。 4、本...
代码生成器必备jar包：Freemarker-2.3.23
02-26
import freemarker.template.TemplateDirectiveModel; Freemarker-2.3.23低于2.3没有上面的命名空间 我下载了好几个版本的看了的
dalgenx:dalgenX是对支付宝dalgen代码生成器的开源实现，freemarker版，可迭代开发生成器，同时支持ibatis和mybatis
03-23
dalgenX是对支付宝dalgen代码生成器的开源实现，freemarker版 该项目基于cn_rapidframework（dalgenx为了生产使用性改造很多） dalgen开源初级版最初由badqiu放在taocode上，badqiu大神我不认识，mybatis-plus-...
后台数据库使用mybatisplus技术的，web应用开发之整合freemarker
进击的猪小Q
04-14 322
1,添加该项目所使用到的所有依赖（自己想简化，可以试着去改动测试） <!--配置freemarker模板依赖--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-freemarker</artifactId> </.
MyBatisPlus 最新版代码生成器（直接拿来就能用，包含自动生成 Vue 模版）
江帅帅
05-30 2314
开始了喂～ 别眨眼 O,O 一、编辑 pom.xml 文件，添加依赖 注意： 数据库，我用的是 PostgreSQL，用 MySQL 的同学记得自己换哈～ 模版，我用的是 FreeMarker，用 Velocity 的同学记得自己换哈～ <properties> <java.version>18</java.version> <postgresql.version>42.3.6</postgresql.version>
mybatis-plus代码生成器详细教程与代码
m0_65818274的博客
07-24 5797
mybatis-plus代码生成器是一个工具类，它可以根据数据库表的结构，自动创建对应的实体类、mapper接口、mapper.xml文件、service接口和controller类。这样可以节省开发者的时间和精力，避免重复的编码工作。mybatis-plus代码生成器的使用步骤如下：
Mybatis-plus可视化自动生成代码，提高开发效率神器！
飞乐鸟的博客
12-20 957
Mybatis-plus可视化自动生成代码，提高开发效率神器！
7.SpringBoot集成Mybats-plus且安装代码生成插件
qq_27860623的博客
11-04 207
配置需要生成的文件，比如service,controller等。项目需要集成Mybatis-plus用作服务的ORM。插件会生成代码文件到指定目录下，刷新项目文件夹即可出现。查询除了数据库dim_dept表里面的数据。
代码生成器:mybatis-plus-generator自定义模板生成 dto、vo、convertor
05-25
Mybatis-Plus 是一个基于 Mybatis 的增强工具，它简化了 Mybatis 的开发流程，提供了很多实用的功能，其中之一就是代码生成器。代码生成器可以根据数据库表结构自动生成实体类、mapper 接口、xml 文件等代码，极大地提高了开发效率。但是，Mybatis-Plus 自动生成的实体类并不一定满足我们的需求，因此我们需要自定义模板来生成我们需要的类。 下面，我将介绍如何使用 Mybatis-Plus 自定义模板生成 dto、vo、convertor。 1. 创建自定义模板 我们需要在 Mybatis-Plus 的代码生成器中创建自定义模板。打开 Mybatis-Plus 的代码生成器，点击“自定义模板”选项卡，然后点击“添加模板”按钮，输入模板名称和文件名，然后点击“保存”按钮。 在模板编辑器中，我们可以使用 FreeMarker 语法来编写模板。下面是一个简单的模板示例，用于生成 dto 类： ``` package ${dtoPackage}; import lombok.Data; @Data public class ${dtoName} { <#list table.columnList as column> private ${column.javaType} ${column.propertyName}; </#list> } ``` 在这个模板中，我们使用 `${}` 占位符来引用变量。`dtoPackage` 和 `dtoName` 变量由代码生成器自动提供，表示生成的 dto 类的包名和类名。`table` 变量表示当前生成的表信息，包含表名、列名、列类型等信息。我们使用 `<#list>` 和 `</#list>` 标签来遍历表的列信息，并生成对应的属性。 2. 配置代码生成器 在使用自定义模板之前，我们需要配置代码生成器。打开 Mybatis-Plus 的代码生成器，点击“全局配置”选项卡，在“自定义配置”中添加以下配置： ``` # dto 模板配置 dto=templates/dto.java.vm dtoOutputDir=src/main/java/${dtoPackage}/ ``` 其中，`dto` 是我们自定义模板的名称，`dtoOutputDir` 是生成的 dto 类的输出目录。我们还可以添加其他自定义模板和输出目录，例如： ``` # vo 模板配置 vo=templates/vo.java.vm voOutputDir=src/main/java/${voPackage}/ # convertor 模板配置 convertor=templates/convertor.java.vm convertorOutputDir=src/main/java/${convertorPackage}/ ``` 3. 生成代码 配置完成后，我们可以点击“执行”按钮来生成代码。代码生成器将根据配置生成实体类、mapper 接口、xml 文件、dto、vo、convertor 等代码。我们只需要将生成的代码复制到项目中即可。 总结 使用 Mybatis-Plus 的代码生成器可以大大提高开发效率，而自定义模板则可以生成我们需要的类。通过自定义模板，我们可以生成 dto、vo、convertor 等常用类，避免手写重复的代码，提高开发效率和代码质量。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值