「这是我参与2022首次更文挑战的第4天,活动详情查看:2022首次更文挑战」
在我前面的文章,讲解了mybatis-plus的集成和使用方式,相信有不少同学还想要它的代码生成的教程吧,这次>我不光将教程给你,连源码的一并放送。
本文项目代码gitee地址: gitee.com/wei_rong_xi…
一、简介
我们在平时开发业务代码时,必然涉及到大量的拷贝工作,比如新创建的表,要实现增删改查,如果没有代码生成器,那么是很痛苦的。
好在mybatis就提供了逆向工程提高我们的编码效率,在后面的mybatis-plus对其进行了封装,更加简化了代码生成额流程。
那么想不想要一条可以在页面ui操作的代码生成器呢?比如说从数据库结构的groovy文件,到java代码,甚至到前端vue的基础增删改查界面?
本文使用
mybatis-plus-generator
提供的能力,结合velocity
模板引擎,实现了上面我们提到的能力,相信对于你自己的管理系统开发过程, 能有很大的帮助。
二、开始干活
本文是依赖于mybatis-plus,请先确保你的项目已经完成了mybatis-plus的集成,没有的同学移步我前面的文章。
2.1 工程准备
为什么有这一小节?因为我的生成代码的工程在我的项目中是一个单独的模块,有独立的数据库连接,独立的依赖等。
这么做的好处是,此模块作为一个服务,与其他服务解耦,可以注册在注册中心,可以被网关的接口文档发现到,更可以为我们日后作为可ui操作代码生成器做准备。如果你非要和其他项目放在一起也没有任何问题。
如上所示是我的工程结构,此工程是作为一个moudle存在的。关于如何创建moudle,这里不介绍了吧,不知道的可以私聊,我可以手把手教你。或者看本文的源码,地址在开篇。
2.2 依赖准备
基于maven,springboot开发的项目,重要的就是依赖,我们先添加需要的依赖。
主要依赖:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.0</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
复制代码
辅助开发的依赖,如果你不习惯使用可以自己修改成其他工具类:
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
</dependency>
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.7.19</version>
</dependency>
复制代码
2.3 准备velocity模板
不知道同学们用没用过velocity模板引擎,从这个名字就能看出来,它是通过模板的形式,定义我们需要的内容,然后通过指定字符变量去替换关键字。
其实Freemarker也是比较出名的模板引擎,以前前后端未分离时经常见到,结合mybatis-plus-generator同样能够做到本文需要的效果。
我在resources下面创建了一个文件夹template,用来存放我们需要的模板:
从上到下分别是:
Api.js.vm
vue中api.js对应的模板Client.java.vm
springCloud服务调用的ClientController.java.vm
控制器Convert.java.vm
实体类转换器,例如DTO <-> DODTO.java.vm
DTO 接口和页面传递Entity.java.vm
DO 服务层和数据库传递Groovy.vm
针对liquiBase用户,生成自动初始化数据库的Groovy文件(手写很烦)Html.vue.vm
vue的页面Mapper.java.vm
Mapper映射Service.java.vm
服务接口ServiceImpl.java.vm
接口实现
以上这些都是可以自定义的,需要多少就可以添加多少。
下面看下vue中Api.js
的内容:
import request from '@/utils/request'
var service_name = '/${serviceName}'
/**
* @description: 分页列表
*
* @author ${author}
* @date ${date}
*/
export function getPage${className}(data) {
return request({
url: service_name+ '/${classname}/pageList',
method: 'post',
data
})
}
/**
* @description: 新增
*
* @author ${author}
* @date ${date}
*/
export function create(data) {
return request({
url: service_name+ '/${classname}/save',
method: 'post',
data
})
}
/**
* @description: 更新
*
* @author ${author}
* @date ${date}
*/
export function update(data) {
return request({
url: service_name+ '/${classname}/update',
method: 'post',
data
})
}
复制代码
如上所示,${serviceName}
,${classname}
,${author}
等分别表示服务的驼峰名称,类的小写名称以及作者,代码生成是会根据选的表进行替换,这些替换符的名称也是自己进行指定的。
下面在随便看几个:
- Client.java.vm
package ${package}.api;
import com.cloud.bssp.util.R;
import ${package}.dto.${className}DTO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import java.util.Map;
/**
* Description: ${comments}
* Create Date: ${date}
* Modified By:<br>
* Modified Date:<br>
* Why & What is modified:<br>
*
* @author ${author}
* @version ${version}
*/
@FeignClient(name = "${serviceName}", path = "/${pathName}", contextId = "base")
public interface ${className}Client {
/**
* 分页列表
* @param params
* @return
*/
@PostMapping("/pageList")
R pageList(@RequestBody Map<String, Object> params);
/**
* list列表
* @param ${classname}DTO
* @return
*/
@PostMapping("/list")
R list(@RequestBody ${className}DTO ${classname}DTO);
/**
* 根据主键查询
* @param id
* @return
*/
@GetMapping("/info/getById")
R info(@RequestParam("id") Long id);
/**
* 新增
* @param ${classname}DTO
* @return
*/
@PostMapping("/save")
R save(@RequestBody ${className}DTO ${classname}DTO);
/**
* 更新
* @param ${classname}DTO
* @return
*/
@PostMapping("/update")
R update(@RequestBody ${className}DTO ${classname}DTO);
}
复制代码
- DTO.java.vm
package ${package}.dto;
import com.cloud.bssp.util.BaseDTO;
import com.fasterxml.jackson.annotation.JsonFormat;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
#foreach ($column in $columns)
#if($column.attrType == 'LocalDate')
import java.time.LocalDate;
#break
#end
#end
#foreach ($column in $columns)
#if($column.attrType == 'LocalDateTime')
import java.time.LocalDateTime;
#break
#end
#end
import lombok.Data;
/**
* Description: ${comments}
* Create Date: ${date}
* @author ${author}
* @version ${version}
*/
@Data
@ApiModel(value = "${className}DTO", description = "数据传输对象${className}DTO")
public class ${className}DTO extends BaseDTO {
#foreach ($column in $columns)
/**
* $column.comments
*/
@ApiModelProperty(notes = "$column.comments")
#if($column.attrname == 'id' || $column.attrname.indexOf('Id') != -1)
@JsonFormat(shape = JsonFormat.Shape.STRING)
#end
#if ("date" == $column.dataType)
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
#end
#if ("datetime" == $column.dataType)
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")
#end
private $column.attrType $column.attrname;
#end
}
复制代码
2.4 功能分析
下面简单分析下我的这套代码生成器的功能,从代码接口层面看主要有两个:
-
生成规则
简单来说就是生成代码时指定的一些内容,比如作者,包路径,是否去除表前缀等等。
这是一套完成的增删改查功能,前端可以直接接入。
实体类如下:
/** * Module: GenerateRulesDO.java * * @author weirx * @since JDK 1.8 * @version 1.0 * @date 2020-07-17T10:00:32.925 * @Descriptions: */ @Data @TableName(value = "bssp_generate_rules") public class GenerateRulesDO { /** * 主键 */ @TableId(value = "id", type = IdType.AUTO) private Long id; /** * 作者 */ private String author; /** * 包名 */ private String packageName; /** * 服务名 */ private String serviceName; /** * 是否忽略前缀 1是0否 */ private Integer isIgnorePrefix; /** * 表前缀 */ private String tablePrefix; /** * 创建时间 */ @TableField(fill = FieldFill.INSERT) @JSONField(format = "yyyy-MM-dd HH:mm:ss") private LocalDateTime createTime; /** * 更新时间 */ @TableField(fill = FieldFill.INSERT_UPDATE) @JSONField(format = "yyyy-MM-dd HH:mm:ss") private LocalDateTime updateTime; } 复制代码
-
生成代码
生成代码的主要过程如下所示:
此三种都有对应的接口实现。
2.5 代码逻辑分析
关于代码逻辑分析,我已生成本地zip
为例,简单讲解主要的逻辑。
-
定义本地代码生成位置
#代码生成路径 generator: code: path: rob-necessities-generator/src/main/resources/generate/code.zip 复制代码
引用:
@Value("${generator.code.path}") private String generatorCodePath; 复制代码
-
生成接口入口位置
/** * 代码生成-返回zip * * @param tableDTO * @return */ @ApiOperation(value = "代码生成-生成zip到项目") @PostMapping("/generateCodeZip") public void generateCodeZip(@RequestBody TableDTO tableDTO) { try { ByteArrayOutputStream outputStream = generateService.generateCode(TableDoConvert.dtoToDo(tableDTO)); FileOutputStream fos = new FileOutputStream(generatorCodePath); outputStream.writeTo(fos); fos.close(); outputStream.close(); } catch (IOException e) { e.printStackTrace(); } } 复制代码
此处的参数是TableDTO当中的表名数组,支持多个同时生成:
/** * 表名称数组 */ @ApiModelProperty(notes = "创建时间") private String[] tableNames; 复制代码
-
生成代码接口实现
@Override public ByteArrayOutputStream generateCode(TableDO tableDO) throws IOException { // 获取生成规则 List<GenerateRulesDO> list = generateRulesService.list(); if (CollectionUtils.isEmpty(list)) { return null; } ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); ZipOutputStream zip = new ZipOutputStream(outputStream); // 遍历表名 for (String tableName : tableDO.getTableNames()) { // 根据表名查询,获取表的结构 TableDO table = generateMapper.queryTable(tableName); // 获取表字段 List<TableColumnDO> columns = generateMapper.queryColumns(tableName); // 生成逻辑 this.generatorCode(table, list.get(0), columns, zip); } // 关闭流 IOUtils.closeQuietly(zip); return outputStream; } 复制代码
主要分为以下几个步骤:
-
获取生成规则
-
根据表名查询,获取表的结构
实际是通过如下的sql查询:
/** * Description: 根据表名获取表信息 * Created date: 2020/7/15 * @param tableName 表名 * @return java.util.Map<com.cloud.bssp.generator.entity.TableDO> * @author weirx */ @Select("select table_name tableName, engine, table_comment tableComment, create_time createTime from information_schema.tables where table_schema = (SELECT DATABASE()) and table_name = #{tableName}") TableDO queryTable(String tableName); 复制代码
-
获取表字段
通过下面的SQL获取:
/** * Description: 根据表名获取表字段 * Created date: 2020/7/15 * @param tableName 表名 * @return java.util.List<com.cloud.bssp.generator.entity.TableColumnDO> * @author weirx */ @Select("select column_name columnName, data_type dataType, column_comment columnComment, column_key columnKey,is_nullable,column_type,column_default, extra from information_schema.columns where table_name =#{tableName} and table_schema = (SELECT DATABASE()) order by ordinal_position") List<TableColumnDO> queryColumns(String tableName); 复制代码
-
生成逻辑
-
-
生成逻辑
这个代码很多,不贴代码了,给个流程吧,实现包含但是不限于这些:
关于代码大家自己去gitee上面看吧,文章不多说。
三、成果展示
-
前面做了那么多,都是为了成果,我们首先看下接口文档的接口,本文与Knife4j集成,想用的可以看我前面写的集成文章,或者直接看代码。
接口调用:
-
页面ui操作,本文提供的代码没有,不过我可以展示下以前完成的效果图:
预览:
-
生成的代码文件:
- java文件:
- vue文件
关于文章生成的Groovy是干什么用的,后面咱们专门一篇文章介绍liquibase
组件,你就明白了,数据库初始化的神器。
另外,如果需要使用的同学,在明白原理后需要自己去修改模板内容,以符合自己的编码风格。
关于整合的介绍就这么多,大家需要的去看源码,关于文章中涉及到的内容都有。不明白的可以结合本文和前面我写的文章去参考。
另外此仓库的源码会持续更新集成常用的、新兴的组件,欢迎大家关注学习。
本文项目代码gitee地址: gitee.com/wei_rong_xi…