其实Freemarker也是比较出名的模板引擎,以前前后端未分离时经常见到,结合mybatis-plus-generator同样能够做到本文需要的效果。
我在resources下面创建了一个文件夹template,用来存放我们需要的模板:
从上到下分别是:
-
Api.js.vm
vue中api.js对应的模板 -
Client.java.vm
springCloud服务调用的Client -
Controller.java.vm
控制器 -
Convert.java.vm
实体类转换器,例如DTO <-> DO -
DTO.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 p a c k a g e . d t o . {package}.dto. 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:
-
Modified Date:
-
Why & What is modified:
-
@author ${author}
-
@version ${version}
*/
@FeignClient(name = “ s e r v i c e N a m e " , p a t h = " / {serviceName}", path = "/ 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 = “ c l a s s N a m e D T O " , d e s c r i p t i o n = " 数据传输对象 {className}DTO", description = "数据传输对象 classNameDTO",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 list = generateRulesService.list();
最后
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长,自己不成体系的自学效果低效漫长且无助。
因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点!不论你是刚入门Android开发的新手,还是希望在技术上不断提升的资深开发者,这些资料都将为你打开新的学习之门!
如果你觉得这些内容对你有帮助,需要这份全套学习资料的朋友可以戳我获取!!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!
{
// 获取生成规则
List list = generateRulesService.list();
最后
自我介绍一下,小编13年上海交大毕业,曾经在小公司待过,也去过华为、OPPO等大厂,18年进入阿里一直到现在。
深知大多数初中级Android工程师,想要提升技能,往往是自己摸索成长,自己不成体系的自学效果低效漫长且无助。
因此收集整理了一份《2024年Web前端开发全套学习资料》,初衷也很简单,就是希望能够帮助到想自学提升又不知道该从何学起的朋友,同时减轻大家的负担。
[外链图片转存中…(img-yM8Uupt7-1715773235383)]
[外链图片转存中…(img-cD8XsybY-1715773235384)]
[外链图片转存中…(img-cHJ458KC-1715773235384)]
既有适合小白学习的零基础资料,也有适合3年以上经验的小伙伴深入学习提升的进阶课程,基本涵盖了95%以上Android开发知识点!不论你是刚入门Android开发的新手,还是希望在技术上不断提升的资深开发者,这些资料都将为你打开新的学习之门!
如果你觉得这些内容对你有帮助,需要这份全套学习资料的朋友可以戳我获取!!
由于文件比较大,这里只是将部分目录截图出来,每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频,并且会持续更新!