MyBatisPlus3.x中使用代码生成器(全注释)

最新推荐文章于 2024-04-02 05:53:52 发布
最新推荐文章于 2024-04-02 05:53:52 发布
阅读量5.8k 收藏 15
点赞数 1
分类专栏： MyBatisPlus 文章标签： mybatisPlus代码生成器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/badao_liumang_qizhi/article/details/89518466
版权

场景

MyBaitsPlus3.x与2.x是不一样的。这里使用3.0.1版本。

官方文档

https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B

这里在IDEA上的SpringBoot项目中进行代码生成测试。

实现

添加依赖

添加 代码生成器 依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.2.0</version>
</dependency>

注意：MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖


            <!-- 模板引擎velocity start-->
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.0</version>
            </dependency>
            <!-- 模板引擎velocity end-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.0.1</version>
            </dependency>

模板引擎

MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎。

注意！如果您选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());

编写代码

在test下新建单元测试类Generatortest.java

全局配置

 //全局配置
        GlobalConfig config = new GlobalConfig();
        //设置是否支持AR模式
        config.setActiveRecord(true)
                //设置生成代码的作者
                .setAuthor("badaoliumangqizhi")
                //设置输出代码的位置
                .setOutputDir("f:output")
                //.setEnableCache(false)// XML 二级缓存
                //.setBaseResultMap(true)// XML ResultMap
                //.setBaseColumnList(true)// XML columList
                //.setKotlin(true) 是否生成 kotlin 代码
                //设置是否覆盖原来的代码
                .setFileOverride(true);

数据源配置

//数据库连接url
        String dbUrl = "jdbc:sqlserver://;DatabaseName=";
        //数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        //数据库类型 枚举
        dataSourceConfig.setDbType(DbType.SQL_SERVER)
                //设置url
                .setUrl(dbUrl)
                //设置用户名
                .setUsername("")
                //设置密码
                .setPassword("")
                //设置数据库驱动
                .setDriverName("com.microsoft.sqlserver.jdbc.SQLServerDriver")
                // 自定义数据库表字段类型转换【可选】
                .setTypeConvert(new MySqlTypeConvert() {
                    @Override
                    public DbColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                        System.out.println("转换类型：" + fieldType);
                        //tinyint转换成Boolean
                         if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
                            return DbColumnType.BOOLEAN;
                         }
                         //将数据库中datetime转换成date
                        if ( fieldType.toLowerCase().contains( "datetime" ) ) {
                            return DbColumnType.DATE;
                        }
                        return (DbColumnType) super.processTypeConvert(globalConfig, fieldType);
                    }
                });

策略配置

//策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig
                //全局大写命名是否开启
                .setCapitalMode(true)
                //【实体】是否为lombok模型
                .setEntityLombokModel(true)
                //表名生成策略  下划线转驼峰
                .setNaming(NamingStrategy.underline_to_camel)
                //自动填充设置
                //.setTableFillList(tableFillList)
                //修改替换成你需要的表名，多个表名传数组
                .setInclude("wms_receive_order");

集成注入配置

//注入全局设置
        new AutoGenerator().setGlobalConfig(config)
                //注入数据源配置
                .setDataSource(dataSourceConfig)
                //注入策略配置
                .setStrategy(strategyConfig)
                //设置包名信息
                .setPackageInfo(
                        new PackageConfig()
                                //提取公共父级包名
                                .setParent("com.badao.bus.sys")
                                //设置controller信息
                                .setController("controller")
                                //设置实体类信息
                                .setEntity("entity")
                )
                //设置自定义模板
                .setTemplate(
                        new TemplateConfig()
                                //.setXml(null)//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
                                //注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
                                // 自定义模板配置，模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
                                // 至您项目 src/main/resources/template 目录下，模板名称也可自定义如下配置：
                                // .setController("...");
                                // .setEntity("...");
                                // .setMapper("...");
                                // .setXml("...");
                                // .setService("...");
                                 .setServiceImpl("templates/serviceImpl.java")
                )
                //开始执行代码生成
                .execute();
    }

完整生成器代码

package com.ws.test.generator;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import org.junit.Test;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;
import java.util.List;

/**
 * Created by badado on 2019/4/25.
 */
public class Generatortest {
    @Test
    public void generateTest(){
        //全局配置
        GlobalConfig config = new GlobalConfig();
        //设置是否支持AR模式
        config.setActiveRecord(true)
                //设置生成代码的作者
                .setAuthor("badaoliumangqizhi")
                //设置输出代码的位置
                .setOutputDir("f:output")
                //.setEnableCache(false)// XML 二级缓存
                //.setBaseResultMap(true)// XML ResultMap
                //.setBaseColumnList(true)// XML columList
                //.setKotlin(true) 是否生成 kotlin 代码
                //设置是否覆盖原来的代码
                .setFileOverride(true);

       //******************************数据源配置***************************************
        //数据库连接url
        String dbUrl = "jdbc:sqlserver://;DatabaseName=";
        //数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        //数据库类型 枚举
        dataSourceConfig.setDbType(DbType.SQL_SERVER)
                //设置url
                .setUrl(dbUrl)
                //设置用户名
                .setUsername("")
                //设置密码
                .setPassword("")
                //设置数据库驱动
                .setDriverName("com.microsoft.sqlserver.jdbc.SQLServerDriver")
                // 自定义数据库表字段类型转换【可选】
                .setTypeConvert(new MySqlTypeConvert() {
                    @Override
                    public DbColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
                        System.out.println("转换类型：" + fieldType);
                        //tinyint转换成Boolean
                         if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
                            return DbColumnType.BOOLEAN;
                         }
                         //将数据库中datetime转换成date
                        if ( fieldType.toLowerCase().contains( "datetime" ) ) {
                            return DbColumnType.DATE;
                        }
                        return (DbColumnType) super.processTypeConvert(globalConfig, fieldType);
                    }
                });

        //******************************策略配置******************************************************
        // 自定义需要填充的字段 数据库中的字段
        List<TableFill> tableFillList = new ArrayList<>();
        tableFillList.add(new TableFill("gmt_modified", FieldFill.INSERT_UPDATE));
        tableFillList.add(new TableFill("modifier_id", FieldFill.INSERT_UPDATE));
        tableFillList.add(new TableFill("creator_id", FieldFill.INSERT));
        tableFillList.add(new TableFill("gmt_creat", FieldFill.INSERT));
        tableFillList.add(new TableFill("available_flag", FieldFill.INSERT));
        tableFillList.add(new TableFill("deleted_flag", FieldFill.INSERT));
        tableFillList.add(new TableFill("sync_flag", FieldFill.INSERT));
        //策略配置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig
                //全局大写命名是否开启
                .setCapitalMode(true)
                //【实体】是否为lombok模型
                .setEntityLombokModel(true)
                //表名生成策略  下划线转驼峰
                .setNaming(NamingStrategy.underline_to_camel)
                //自动填充设置
                .setTableFillList(tableFillList)
                //修改替换成你需要的表名，多个表名传数组
                .setInclude("wms_receive_order");
        //集成注入设置
        //注入全局设置
        new AutoGenerator().setGlobalConfig(config)
                //注入数据源配置
                .setDataSource(dataSourceConfig)
                //注入策略配置
                .setStrategy(strategyConfig)
                //设置包名信息
                .setPackageInfo(
                        new PackageConfig()
                                //提取公共父级包名
                                .setParent("com.badao.bus.sys")
                                //设置controller信息
                                .setController("controller")
                                //设置实体类信息
                                .setEntity("entity")
                )
                //设置自定义模板
                .setTemplate(
                        new TemplateConfig()
                                //.setXml(null)//指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
                                //注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
                                // 自定义模板配置，模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
                                // 至您项目 src/main/resources/template 目录下，模板名称也可自定义如下配置：
                                // .setController("...");
                                // .setEntity("...");
                                // .setMapper("...");
                                // .setXml("...");
                                // .setService("...");
                                 .setServiceImpl("templates/serviceImpl.java")
                )
                //开始执行代码生成
                .execute();
    }
}

效果

运行测试

生成成功后会自动弹出生成代码的目录

 

霸道流氓气质
关注
  • 1
    点赞
  • 踩
  • 15
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 4
    评论
专栏目录
mybatis代码自动生成,可修改生成模板
08-09
通过设置数据库连接，需要生成的表，即可生成对应的代码,生成model,mapper,controller,service,使用简单
Freemarker模版技术
qq_42572245的博客
06-04 219
一.初识Freemarker 什么是Freemarker Freemarker是一款模版引擎 Freemarker不是web框架 Freemarker官网http://http://freemarker.org 动态网页(数据可变)与静态网页(访问快，SEO排名高) 动态网页静态代(伪静态[只改后缀]，真静态) 模板技术：数据+模板=输入文本 freemarker【ftl】,velocity【vm...
SpringBoot集成MyBatis-Plus代码生成器Demo
最新发布
mickey2007的博客
04-02 844
MyBatis-Plus（简称 MP）是一个MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。官网:AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
模板和代码生成器
June_FlyingFrost的博客
03-31 3431
模板 1.模板技术 动态页面静态化 模板 + 数据 = 文本 freemarker(.ftl) velocity(.vm) velocity模板技术 1.Maven导包 <!-- 代码生成器模版技术 --> <dependency> <groupId>org.apache.velocity</groupId> <artifactId>...
FTL快速入门
05-14 2111
Freemaker 入门+深入+开发指南+学习笔记 freemaker的基本语法 freemaker的基本语法:  中存放所有freemaker的内容，之外的内容全部原样输出。  是函数调用 两个定界符内的内容中，第一个符号表示指令或者函数名，其后的跟随参数。freemaker提供的控制包括如下：   条件判断  遍历hash表或者collection（freemaker称作sequ
web项目调试
热门推荐
一筐猪的博客
08-15 1万+
  web项目调试 web项目往往由前端和后台组成，涉及的内容和知识特别多，初学者由于对其运行机制理解不到位，同时没有掌握恰当的调试方法，当项目出现问题时就比较茫然、无从下手。提高调试能力对于程序员来讲是至关重要，是成为一个合格程序员的必经之路。 一、总体思路 （1）理解清楚web项目运行基本机制，理清程序运行轨迹； （2）掌握Java代码调试方法和技巧； （3）掌握浏览器前端调试方法...
Mybatis-plus代码生成器（旧版）带注释快速上手
m0_71751187的博客
03-14 333
Mybatis-plus代码生成器（旧版）带注释快速上手
修改mybatis plus Generator模板生成字段注释枚举常量
小月施主的博客
09-10 4532
修改mybatis plus Generator模板生成字段注释枚举常量 本文基于最新的mybatis-plus 3.0.1版本源码修改，如果使用其它版本，处理方式也类似，主要是生成Entity的FreekMarker模板文件的修改。 源码下载：https://gitee.com/baomidou/mybatis-plus 目标： 表的字段定义如下： `na...
mybatis generator 中文注释_Mybatis-Plus 3.4.0 发布，更新内容较多
weixin_39874269的博客
11-28 251
简介Mybatis-Plus是一款MyBatis的增强工具包，简化 CRUD 操作。启动加载 XML 配置时注入单表 SQL 操作 ，为简化开发工作、提高生产率而生。Mybatis-Plus 启动注入非拦截实现、性能更优，让你专注业务快速敏捷开发更新日志：新增 Oscar(神通) 数据库支持新增 clickhouse 数据库支持fix: @TableName.autoResultMap=true ...
Mybatis-plus 逆向工程自动生成代码-实体类字段添加@TableField
weixin_52067659的博客
12-21 2639
Mybatis-plus 逆向工程自动生成代码-实体类字段添加@TableField
Mybatis-Plus生成代码（超全注释配置）
qq_38496561的博客
11-14 5750
背景 以前用的Tkmybatis，新入职的公司用的是Mybatis-Plus，琢磨了下Mybatis-Plus生成代码，感觉挺爽的（默认整合swagger，配合swagger妈妈再也不用担心项目一行注释都没有了），再此记录下生成代码的配置。 简介 MyBatis-Plus（简称 MP）是一个MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。...
mybatisplus-generator 代码生成器 人大金仓数据库支持扩展
11-02
mybatisplus-generator是个代码生成器，但是不支持人大金仓数据库。 本资源扩展了代码生成器的几个类，支持人大金仓数据库。另外，继承AutoGenerator新建了LesAutoGenerator，解决了数据库注释换行导致代码生成后...
代码注释生成器.rar
09-06
代码注释生成器 如你所见 传一张图片就可以生成文字注释 比如说佛祖保佑那张 或者整个爱豆也能
mybatis代码生成器(含中文注释)
04-10
mybatis代码生成器(含中文注释)，可以根据数据库的字段信息及注释生成相应的entity，dao，mapper，极大的提高开发效率！ win可以直接运行bat文件，mac需要使用命令：java -Dfile.encoding=UTF-8 -jar mybatis-...
SAMSUNG S3C44B0x开发板的bootloader源代码中文注释.rar
09-02
分析arm的好资料：S3C44B0x开发板的bootloader源代码中文注释 arm , SAMSUNG , 分析 , 源代码 , 中文
Mybatis-generator生成字段注释
赵海鑫|芽孢八叠球菌|John Helsing
05-22 8703
Mybatis自动生成工具能够根据数据库表/视图等自动生成相应的bean和mapper，大大的简化了开发工作。 但默认的生成bean并没有将数据库表中的字段注释也放到生成的bean的属性上。 本文记录如何让mybatis-generator根据数据库表字段注释生成bean的属性注释。 一.编写自定义注释生成工具 首先我们要实现CommentGenerator这个接口，编写一个自定义注释生成工具...
MybatisPlus代码生成器的简单配置与使用
zhangcongyue的博客
06-22 555
本篇MybatisPlus代码生成器的代码我已经上传到gitee，链接：https://gitee.com/yue-zi/mybatisplus。最后代码生成完后切记在Mapper接口上加上@Mapper注解，并且在配置文件中配置数据库。还有最后的策略配置，输入你要生成的表，设置表的前缀名，这样在生成过后就会自动省去这个前缀。这一段是全局配置，可以修改代码生成的位置，和Id生成的策略，默认为自动递增。这一段是数据库的配置，需要改成你连接的数据库的信息。这一段是设置包名相关的配置。
Mybatis代码生成器如何自定义注释
weixin_43248672的博客
05-10 2639
我们在使用Mybatis代码生成器生成mapper、po以及xml文件的时候，mapper中的方法和po的字段上一般会自动生成一些“无用”的注释，使得代码看起来很乱。为了解决这个问题，一般有三种方式：第一种就是通过配置generatorConfig.xml文件来精简注释，第二种就是通过实现CommentGenerator中的方法，让代码生成器生成我们自己想要的注释效果，第三种既可以做到自定义注释，还能省去get、set方法。 修改generatorConfig.xml中的配置 context &lt
mybatis-plus代码生成器去除注释中的日期
03-27
可以在代码生成器的配置文件中设置一个自定义的注释模板，在模板中去除日期部分。具体操作如下： 1. 找到代码生成器的配置文件，一般为 `mybatis-plus-generator\src\main\resources\generator\generatorConfig.xml`。 2. 在配置文件中找到 `commentGenerator` 配置项，修改为以下内容： ```xml <commentGenerator type="com.baomidou.mybatisplus.generator.config.CustomCommentGenerator"> <!-- 去除日期的注释模板 --> <property name="author" value="Your Name"/> <property name="dateFormat" value=""/> <property name="suppressDate" value="true"/> <property name="suppressAllComments" value="false"/> </commentGenerator> ``` 3. 新建一个 `CustomCommentGenerator` 类，继承 `DefaultCommentGenerator` 类，并重写 `addGeneralMethodComment()` 和 `addGeneralMethodAnnotation()` 方法。代码如下： ```java public class CustomCommentGenerator extends DefaultCommentGenerator { /** * 去除日期的方法注释模板 */ private static final String METHOD_COMMENT_TEMPLATE_WITHOUT_DATE = " * %s"; /** * 去除日期的方法注解模板 */ private static final String METHOD_ANNOTATION_TEMPLATE_WITHOUT_DATE = "@%s"; /** * 去除日期的方法注释 */ @Override public void addGeneralMethodComment(Method method, IntrospectedTable introspectedTable) { StringBuilder sb = new StringBuilder(); method.addJavaDocLine("/**"); sb.append(String.format(METHOD_COMMENT_TEMPLATE_WITHOUT_DATE, method.getName())); method.addJavaDocLine(sb.toString()); method.addJavaDocLine(" */"); } /** * 去除日期的方法注解 */ @Override public void addGeneralMethodAnnotation(Method method, IntrospectedTable introspectedTable, Set<FullyQualifiedJavaType> set) { String annotationName = null; for (FullyQualifiedJavaType type : set) { annotationName = type.getShortName(); break; } if (annotationName != null) { StringBuilder sb = new StringBuilder(); sb.append(String.format(METHOD_ANNOTATION_TEMPLATE_WITHOUT_DATE, annotationName)); method.addAnnotation(sb.toString()); } } } ``` 4. 在配置文件中加入 `CustomCommentGenerator` 类的配置，修改 `commentGenerator` 为以下内容： ```xml <commentGenerator type="com.baomidou.mybatisplus.generator.config.CustomCommentGenerator"> <!-- 去除日期的注释模板 --> <property name="author" value="Your Name"/> <property name="suppressDate" value="true"/> <property name="suppressAllComments" value="false"/> </commentGenerator> ``` 5. 重新运行代码生成器，生成的代码中注释中的日期就被去除了。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

霸道流氓气质

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

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

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

打赏作者

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

抵扣说明：

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

余额充值