SpringBoot整合freemarker实现代码生成器
作者:Java极客技术 发布时间:2023-07-17 20:31:08
一、介绍
在实际的软件项目开发过程中,我可以很负责任的跟大家说,如果你真的实际写代码的时间超过5年,你对增删改查这类简单的功能需求开发,可以说已经完全写吐了,至少我就是这种类型的。
但是呢,不可否认,绝大多数的软件功能,向下追随到最基本的单元,也基本都是单表的增、删、改、查!
只是随着用户需求不断增多,原来可能一个张单表就可以搞定的事情,现在可能需要多张表,或者多个库才能搞定,代码层就像堆积木一样,越堆越复杂。
我记得早期做项目的时候,项目每新加一张单表,我都需要在代码层,按照MVC
框架的思想,重新编写一套CURD
的代码,写完所有的基础的增删改查,至少需要20分钟,手快的情况下,最快也要10分钟。
假如某个新开发的功能,要新增10张表,按照这个时间计算,至少要100分钟,仔细想想,其实你会发现大部分的时间都浪费在这些简单而又重复的编程圈子中去了。
那有没有一个办法,将这些简单的CURD
代码,全部都标准化、公共化呢?这样我们的可以省下很多时间来投入业务场景的开发。
答案是肯定的,有!
我记得早期我最先接触的是MybatisGenertor
工具包,通过这个工具包,我们可以省去大部分的mybaits
中xml
文件的curd
编写工作。
还有我们所熟悉的JPA
,里面有一套公共的持久层 * 类,它可以自动根据名称生成SQL
语句,能为开发省下不少的事情。
但是我这个人比较懒,我想搞一个工具,从controller
、service
、entity
、dao
层,全部的crud
代码,包括单元测试类,通过工具自动生成好。
像这样的工具,现在网上也有不少,例如我们所熟悉的Mybatis-plus
插件,它就可以做到这一点,也是非常好用。
但是有的公司就不喜欢它,原因也很简单,里面的很多公共方法封装的过于深入,而且很多crud
的sql
全部都是动态生成,你根本看不到。
总之啊就是一句,不在自己掌控之内的,很多程序员总是带着各种疑虑~~
当然,还有一个明显的疑虑,就是对微服务的开发,不能全面支持,比如你项目采用的是SpringBoot +Dubbo
组合来开发,这个时候生成的controller
,完全没啥用处,而且还很鸡肋。
因此在这种情况下,你得基于当前的项目软件开发规则,自己开发一套代码生成器,以满足快速开发的需要。
下面我就简单的介绍一下,如何自行开发一套代码生成器,过程如下!
二、代码实践
其实开发一套代码生成器,真没大家想象中的那么复杂,其中用的最重要一项技术,就是利用模板来生成代码,例如我们经常使用的模板引擎freemarker
,它就可以帮助我们实现这一点。
2.1、首先我们添加 freemarker 依赖包
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.23</version>
</dependency>
2.2、然后创建一个代码模版
下面我们以动态创建实体类为例,编写一个实体类的模板entity.java.ftl
,其中${}
里面定义的是动态变量。
package ${package};
import java.io.Serializable;
/**
* <p>
* ${tableComment}
* </p>
*
* @author ${author}
* @since ${date}
*/
public class ${entityClass} implements Serializable {
private static final long serialVersionUID = 1L;
<#--属性遍历-->
<#list columns as pro>
/**
* ${pro.comment}
*/
private ${pro.propertyType} ${pro.propertyName};
</#list>
<#--属性get||set方法-->
<#list columns as pro>
public ${pro.propertyType} get${pro.propertyName?cap_first}() {
return this.${pro.propertyName};
}
public ${entityClass} set${pro.propertyName?cap_first}(${pro.propertyType} ${pro.propertyName}) {
this.${pro.propertyName} = ${pro.propertyName};
return this;
}
</#list>
}
2.3、最后生成目标代码
最后我们基于freemarker
编写一个测试类!
public class CodeGeneratorDemo {
public static void main(String[] args) throws IOException, TemplateException {
Map<String, Object> objectMap = new HashMap<>();
//定义包路径
objectMap.put("package", "com.example.test");
//定义实体类
objectMap.put("entityClass", "Student");
//定义实体类属性
List<Map<String, Object>> columns = new ArrayList<>();
//姓名字段
Map<String, Object> column1 = new HashMap<>();
column1.put("propertyType", "String");
column1.put("propertyName", "name");
column1.put("comment", "姓名");
columns.add(column1);
//年龄字段
Map<String, Object> column2 = new HashMap<>();
column2.put("propertyType", "Integer");
column2.put("propertyName", "age");
column2.put("comment", "年龄");
columns.add(column2);
//定义类的属性
objectMap.put("columns", columns);
//定义作者
objectMap.put("author", "张三");
//定义创建时间
objectMap.put("date", new SimpleDateFormat("yyyy-MM-dd").format(new Date()));
//定义类描述
objectMap.put("tableComment", "学生信息");
//生产目标代码
Configuration configuration = new Configuration(Configuration.VERSION_2_3_23);
configuration.setDefaultEncoding(Charset.forName("UTF-8").name());
configuration.setClassForTemplateLoading(CodeGeneratorDemo.class, "/");
Template template = configuration.getTemplate("/templates/entity.java.ftl");
FileOutputStream fileOutputStream = new FileOutputStream(new File("../src/main/java/com/example/generator/Student.java"));
template.process(objectMap, new OutputStreamWriter(fileOutputStream, Charset.forName("UTF-8").name()));
fileOutputStream.close();
System.out.println("文件创建成功");
}
}
运行程序,输出的文件结果如下!
package com.example.test;
import java.io.Serializable;
/**
* <p>
* 学生信息
* </p>
*
* @author 张三
* @since 2021-08-22
*/
public class Student implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 姓名
*/
private String name;
/**
* 年龄
*/
private Integer age;
public String getName() {
return this.name;
}
public Student setName(String name) {
this.name = name;
return this;
}
public Integer getAge() {
return this.age;
}
public Student setAge(Integer age) {
this.age = age;
return this;
}
}
与预期的效果一致,成功生成!
例如小编我就是采用这种方式,首先把要通过工具生成的代码,全部通过模板方式定义好。
然后通过连接数据库的方式,把需要自动生成的表结构查询出来,封装成数据渲染参数,最后传入到freemarker
中去,非常简单、快速的生成与自己预期想要的代码,所有单表的crud
全部一步到位!
下面这个就是小编,基于当前项目定制开发的一款代码生成器,项目采用SpringBoot + Dubbo
框架开发,没有Controller
层,截图中所有的代码全部都是采用代码生成器生成的,直接通过单元测试就可以运行,开发的时候非常快!
由于开发的代码生成器工具,代码有点过多,因此不便于通过文章分享给大家,有需要的朋友,可以访问如下链接获取:https://github.com/justdojava/springboot-example-generator
三、小结
代码生成器,对于擅长以业务开发为主的程序员来说,绝对是一个巨大的福利,它能很明显的减轻开发人员的工作量,并且提升开发效率,能腾出更多的时间专注业务开发。
实际上,目前网上已经有很多的成熟、稳定的代码生成器,mybatis-plus
就是其中一个使用非常广泛的代码生成器,对于以单体web
开发为主的项目,它完全满足要求。
当然,如果当下你没有合适的代码生成器,不妨自己试试开发一款属于自己的代码生成器,同样也可以加倍提升开发效率。
来源:https://mp.weixin.qq.com/s/4-ScyCqqy-KTNMJLBKCt5A
猜你喜欢
- Android中的Selector的用法 <?xml version="1.0" encoding=&q
- dom4j是一个Java的XML API,类似于jdom,用来读写XML文件的。dom4j是一个非常非常优秀的Java XML API,具有
- 一、相关介绍Gradle是一个好用的构建工具 ,使用它的原因是:配置相关依赖代码量少,不会像maven一样xml过多 打包编译测试
- 目录Spring事件驱动源码实战在项目实际开发过程中,我们有很多这样的业务场景:一个事务中处理完一个业务逻辑后需要跟着处理另外一个业务逻辑,
- 问题描述:N个人围成一圈,从第一个人开始报数,报到m的人出圈,剩下的人继续从1开始报数,报到m的人出圈;如此往复,直到所有人出圈很多实现是使
- 1.限定字符串用 @ 符号加在字符串前面表示其中的转义字符“不”被处理。 如果我们写一个文件的路径,例如"D:/文本文件"
- @Value获取application.properties配置无效问题无效的原因主要是要注意@Value使用的注意事项:1、不能作用于静态
- 前言今天给大家分享是如何在RecyclerView实现全选,ItemTouchHelper实现侧滑删除,拖拽功能。比较基础。关于Recycl
- 本文实例讲述了Android编程实现wifi扫描及连接的方法。分享给大家供大家参考,具体如下:主界面,搜索附近WIFI信息/** * Sea
- C#支持的位逻辑运算符如表2.9所示。运算符号意义运算对象类型运算结果类型对象数实例~位逻辑非运算整型,字符型整型1~a&位逻辑与运
- C#配置文件操作类,供大家参考,具体内容如 * 意添加引用:System.Configuration;using System; using
- 本文实例为大家分享了C#遍历文件夹获取指定后缀名文件的具体代码,供大家参考,具体内容如下问题描述:项目需要,要进行某文件夹下所有shp数据的
- 1. 前言Android LayerDrawble 包含一个Drawable数组,系统将会按照这些Drawable对象的数组顺序来绘制他们,
- 经过数字签名的文档,能够使作者之外的人无法对其进行修改。因此,在PDF文档中添加数字签名可以保证其安全性和真实性。同时根据添加内容的差异性,
- java遍历json字符串,取得相应KV值时,各种麻烦,比如将json中的list取出来转为JSONArray,再将list中的object
- 引言JVM进程消失可能有哪些原因?这个问题也是面试中经常出现的,如下图所示ps:由于两年多没写crud了,所以忘记mybatis怎么用了,所
- 1 前言单例模式是我们经常使用的一种模式,一般来说很多资料都建议我们写成如下的模式:/** * Created by qiyei2015 o
- 方式1. 使用HashtableMap<String,Object> hashtable=new Hashtable
- Android独有的安全机制,除了权限机制外,另外一个就是签名机制了。签名机制主要用在以下两个主要场合起到其作用:升级App和权限检查。升级
- 之前代码有一个逻辑,是在初始化时读取某个包下的所有class文件,放入到一个HashMap里。代码运行过程中,通过Key获取到对应class