代码生成器-mybatis-plus-generator

article/2025/9/29 5:30:55

我们平时在开发的过程中，对于新建的一张表难免会有对其进行增删改查的操作，而且还要写Controller、service、Mapper、Mapper.xml、PO、VO等等。如果每次都要去写这些跟业务毫不相干但是却又耗时耗力的重复代码这不仅是让开发人员不能专注于业务逻辑甚至可能由于不注意导致字段大小写或者某个字母写错而出现bug。所以我们可以利用代码生成器来生成这些固有的代码，这样不仅正确性高，毕竟代码是不会骗人的。而且还节省了时间。

代码生成器有很多，大多数都是基于模板引擎freemarker或者velocity来实现的。git上有许多特别好用和功能强大的代码生成器，比如fast-generator，这也是通过freemarker模板引擎来生成模板代码的，并且提供了可视化界面。由于我的项目中之前使用的是mybatis-plus-generator，所以我决定使用mybatis-plus-generator来生成代码。这样最主要的工作就是去了解一下mybatis-plus-generator。

我们需要通过代码生成器来实现如下需求：

1. 数据库层Entity、Mapper、Xml，DTO层查询参数类、返回封装结果类；
2. 逻辑层Service类，包含对Entity的增删改查（条件查询）方法，查询方法包含分页、不分页2套；
3. Service,Xml联合实现批量insert、批量delete、乐观锁update;
4. 接口层 Controller类，包含基于DTO的增删改查方法；
5. 基于MybatisPlus，对生成的Entity类开启字段自动填充，选择开启逻辑删除、乐观锁；

首先我们打开mybatis-plus的官网，选择代码生成器mybatis-plus官网，看一下官网给出的例子即CodeGenerator类。修改里面的数据库配置和生成代码的位置就可以运行了，如果没有什么特殊的需求直接运行程序就会生成controller、service、mapper、entity这些代码。我们可以看mybatis-plus-generator自带的模板都在templates目录下

并且可以打开文件可以看到模板其实过于简单，里面并没有任何方法只是生成了一个空类，所以并不能满足我们的需求。所以我们需要改造 CodeGenerator类的main方法以及模板来满足我们的需求。先来分析一下官网给出的方法。

1、设置GlobalConfig：这里配置了自动生成文件的位置以及作者信息。我们可以打开配置列表，看看GlobalConfig还有哪些信息可以进行配置基本配置。可以看到这里还可以配置是否开启resultMap以及设置Controller、Service、Mapper等生成的名字，都是通过%s+自己想定义的后缀。%s是一个占位符，最后生成的时候会将Entity的名字填充到这里。名字可以通过这里设置当然也可以直接通过模板里面设定的方式来设置。

2、配置数据库信息：这里只要将它修改成自己的数据库地址以及账号密码即可，我们也可以打开基本配置来看有哪些我们需要的属性。

3、PackageConfig包配置：这里是配置更下一层的目录，最后的代码会生成在GlobalConfig的outputDir+PackageConfig设置的parent+PackageConfig设置的各个类目录。

比如我这里设置的就会生成在src.main.java的com.wjf.codegen的目录下面，并且这里分别设置了entity、service等的目录。

4、InjectionConfig：这个配置可以让我们实现一些自定义的配置

看一下这些配置，主要的是设置自定义的参数initMap以及自定义的输出文件。由于mybatis-plus的模板配置信息TemplateConfig中只能设置controller、service、mapper、mapper.xml、entity、serviceImpl。PackageConfig的配置也只能配置这些类的输出文件的位置，这就没有办法满足我们上面的需求。比如我们需要生成VO对象或者Vo和Entity转换的类Covert对象。这里我们就必须通过InjectionConfig来进行设置了。fileOutConfigList就是帮助我们定义一些其它的模板输出的位置，这里以VO对象为例

这里我自定义了一个VO对象并且定义了它输出的位置。

5、TemplateConfig：这类我们可以设置我们自己的模板的位置，如果设置了就会以我么自己配置的模板来生成代码，否则会以mybatis-plus-generator默认的模板来生成代码。

既然我们以及可以通过自己的配置以及自己模模板生成我们需要的类，那么这已经满足了我们的一些要求了，接下来是需要满足逻辑删除以及乐观锁更新以及自动填充。通过了解逻辑删除需要我们在逻辑删除字段上面添加@TableLogic注解，然后调用delete方法即可实现，所以我们在Entity的模板中给删除字段添加@TableLogic注解即可。乐观锁更新也是同样的道理，在乐观锁字段上添加@Version注解即可实现。可以看到这些实现都跟我们定义的模板有关，接下来我们就看看如何定义模板。

这是我定义的一个freemark的ftl模板，里面连个方法，一个是更新方法一个是分页查询方法，这里只是用来说明问题，乐观锁更新我们可以使用do{}while()的语法进行。可以看到我们的模板方法里面可以同${}然后通过变量名来获取变量，这里的变量都有哪些呢？其实这些变量就是我们上面通过12345点GlobalConfig、PackageConfig等信息里面进行配置的。只要配置只会我们都可以在这里获取到他的值。注意红色自定义的字，当我们自己定义Vo或者其它类的时候由于配置里面是没有的，我们怎么去获取呢？

官网上有一个特别说明，我们进入到这个类中看一下。

有这么多的参数，所以我们在写模板的时候就可以对着这里看看有哪些可以使用的参数。我们如何增加自己定义的参数呢。

通过InjectionConfig的initMap方法，最后一定要调用setMap方法以及AutoGenerator#setCfg(cfg)然后在模板中就可以通过${cfg.key}来获取变量了。我这里定义了一个voDir所以在模板中我可以通过${cfg.voDir}来获取我定义的vo生成的目录。最后一点我们来看一下如何实现自动填充，这其实也是在模板里面，将需要自动填充的字段上的@TableField注解中加入属性fill = FieldFill.INSERT(这表示在添加时自动填充)。