Java代码生成器的制作流程详解
1. 前言
前几天写了篇关于Mybatis Plus代码生成器的文章,不少同学私下问我这个代码生成器是如何运作的,为什么要用到一些模板引擎,所以今天来说明下代码生成器的流程。
2. 代码生成器的使用场景
我们在编码中存在很多样板代码,格式较为固定,结构随着项目的迭代也比较稳定,而且数量巨大,这种代码写多了也没有什么技术含量,在这种情况下代码生成器可以有效提高我们的效率,其它情况并不适于使用代码生成器。
3. 代码生成器的制作流程
首先我们要制作模板,把样板代码的固定格式抽出来。然后把动态属性绑定到模板中,就像做填空题一样。所以在这个流程中模板引擎是最合适的。我们通过使用模板引擎的语法将数据动态地解析到静态模板中去,然后导出为编程中对应的文件就行了。
另外模板引擎有着丰富的绑定数据的指令集,可以让我们根据条件动态的绑定数据到模板中去。以Freemarker为例:
三元表达式:
${true ? 'checked': ''}
还有我们等下要用的遍历列表:
<#list fields as field> private ${field.fieldType} ${field.fieldName}; </#list>
在Java开发中我们常用的模板引擎有Freemarker、Velocity、Thymeleaf ,随着Web开发中前后端分离的流行模板引擎的使用场景正在被压缩,但是它依然是一门有用的技术。
4. 代码生成器演示
接下来,我们以Freemarker为例写一个简单的代码生成器,来生成POJO类。需要引入Freemarker的依赖。
<dependency> <groupId>org.freemarker</groupId> <artifactId>freemarker</artifactId> <version>2.3.28</version> </dependency>
4.1 模板制作
POJO的结构可以分为以下几部分:
java.lang 包无需导入。
所以将这些规则封装到配置类中:
public class JavaProperties { // 包名 private final String pkg; // 类名 private final String entityName; // 属性集合 需要改写 equals hash 保证名字可不重复 类型可重复 private final Set<Field> fields = new LinkedHashSet<>(); // 导入类的不重复集合 private final Set<String> imports = new LinkedHashSet<>(); public JavaProperties(String entityName, String pkg) { this.entityName = entityName; this.pkg = pkg; } public void addField(Class<?> type, String fieldName) { // 处理 java.lang final String pattern = "java.lang"; String fieldType = type.getName(); if (!fieldType.startsWith(pattern)) { // 处理导包 imports.add(fieldType); } Field field = new Field(); // 处理成员属性的格式 int i = fieldType.lastIndexOf("."); field.setFieldType(fieldType.substring(i + 1)); field.setFieldName(fieldName); fields.add(field); } public String getPkg() { return pkg; } public String getEntityName() { return entityName; } public Set<Field> getFields() { return fields; } public Set<String> getImports() { return imports; } /** * 成员属性封装对象. */ public static class Field { // 成员属性类型 private String fieldType; // 成员属性名称 private String fieldName; public String getFieldType() { return fieldType; } public void setFieldType(String fieldType) { this.fieldType = fieldType; } public String getFieldName() { return fieldName; } public void setFieldName(String fieldName) { this.fieldName = fieldName; } /** * 一个类的成员属性 一个名称只能出现一次 * 我们可以通过覆写equals hash 方法 然后放入Set * * @param o 另一个成员属性 * @return 比较结果 */ @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; Field field = (Field) o; return Objects.equals(fieldName, field.fieldName); } @Override public int hashCode() { return Objects.hash(fieldType, fieldName); } } }
接着就是静态模板entity.ftl
package ${pkg}; <#list imports as impt> import ${impt}; </#list> /** * the ${entityName} type * @author felord.cn */ public class ${entityName} { <#list fields as field> private ${field.fieldType} ${field.fieldName}; </#list> }
这里用到了Freemarker绑定数据的语法,比如List迭代渲染。
4.2 生成器编写
Freemarker通过声明配置并获取模板对象freemarker.template,该对象的process方法可以将动态数据绑定到模板中并导出为文件,最终实现了代码生成器,核心代码如下:
/** * 简单的代码生成器. * * @param rootPath maven 的 java 目录 * @param templatePath 模板存放的文件夹 * @param templateName 模板的名称 * @param javaProperties 需要渲染对象的封装 * @throws IOException the io exception * @throws TemplateException the template exception */ public static void autoCodingJavaEntity(String rootPath, String templatePath, String templateName, JavaProperties javaProperties) throws IOException, TemplateException { // freemarker 配置 Configuration configuration = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS); configuration.setDefaultEncoding("UTF-8"); // 指定模板的路径 configuration.setDirectoryForTemplateLoading(new File(templatePath)); // 根据模板名称获取路径下的模板 Template template = configuration.getTemplate(templateName); // 处理路径问题 final String ext = ".java"; String javaName = javaProperties.getEntityName().concat(ext); String packageName = javaProperties.getPkg(); String out = rootPath.concat(Stream.of(packageName.split("\\.")) .collect(Collectors.joining("/", "/", "/" + javaName))); // 定义一个输出流来导出代码文件 OutputStreamWriter outputStreamWriter = new OutputStreamWriter(new FileOutputStream(out)); // freemarker 引擎将动态数据绑定的模板并导出为文件 template.process(javaProperties, outputStreamWriter); }
通过执行以下代码即可生成一个UserEntity的POJO:
// 路径根据自己项目的特点调整 String rootPath = "C:\\Users\\felord\\IdeaProjects\\codegenerator\\src\\main\\java"; String packageName = "cn.felord.code"; String templatePath = "C:\\Users\\felord\\IdeaProjects\\codegenerator\\src\\main\\resources\\templates"; String templateName = "entity.ftl"; JavaProperties userEntity = new JavaProperties("UserEntity", packageName); userEntity.addField(String.class, "username"); userEntity.addField(LocalDate.class, "birthday"); userEntity.addField(LocalDateTime.class, "addTime"); userEntity.addField(Integer.class, "gender"); userEntity.addField(Integer.class, "age"); autoCodingJavaEntity(rootPath, templatePath, templateName, userEntity);
生成的效果是不是跟手写的差不多:
5. 总结
这就是大部分代码生成器的机制,希望可以解答一些网友的疑问。多多关注:码农小胖哥 获取更多干货,相关的DEMO可通过公众号回复codegen获取。如果你有疑问可以通过微信MSW_623进行沟通。
到此这篇关于Java代码生成器的制作流程详解的文章就介绍到这了,更多相关Java代码生成器 制作内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
- 这篇文章主要介绍了如何利用java语言实现经典《复杂迷宫》游戏,文中采用了swing技术进行了界面化处理,感兴趣的小伙伴可以动手试一试...2022-02-01
java 运行报错has been compiled by a more recent version of the Java Runtime
java 运行报错has been compiled by a more recent version of the Java Runtime (class file version 54.0)...2021-04-01- 这篇文章主要介绍了在java中获取List集合中最大的日期时间操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-15
- 这篇文章主要介绍了教你怎么用Java获取国家法定节假日,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下...2021-04-23
- 有一种方法,可以不打开网站而直接查看到这个网站的源代码.. 这样可以有效地防止误入恶意网站... 在浏览器地址栏输入: view-source:http://...2016-09-20
- <?php require('path.inc.php'); header('content-Type: text/html; charset=utf-8'); $borough_id = intval($_GET['id']); if(!$borough_id){ echo ' ...2016-11-25
- 这篇文章主要介绍了Java如何发起http请求的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-03-31
pytorch::Dataloader中的迭代器和生成器应用详解
这篇文章主要介绍了pytorch::Dataloader中的迭代器和生成器应用详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2020-04-30- 本文实例讲述了JS基于Mootools实现的个性菜单效果代码。分享给大家供大家参考,具体如下:这里演示基于Mootools做的带动画的垂直型菜单,是一个初学者写的,用来学习Mootools的使用有帮助,下载时请注意要将外部引用的mootools...2015-10-23
- 说起C#和Java这两门语言(语法,数据类型 等),个人以为,大概有90%以上的相似,甚至可以认为几乎一样。但是在工作中,我也发现了一些细微的差别...2020-06-25
- 本文实例讲述了JS实现自定义简单网页软键盘效果。分享给大家供大家参考,具体如下:这是一款自定义的简单点的网页软键盘,没有使用任何控件,仅是为了练习JavaScript编写水平,安全性方面没有过多考虑,有顾虑的可以不用,目的是学...2015-11-08
- 本文实例讲述了JS+CSS实现分类动态选择及移动功能效果代码。分享给大家供大家参考,具体如下:这是一个类似选项卡功能的选择插件,与普通的TAb区别是加入了动画效果,多用于商品类网站,用作商品分类功能,不过其它网站也可以用,...2015-10-21
- php 取除连续空格与换行代码,这些我们都用到str_replace与正则函数 第一种: $content=str_replace("n","",$content); echo $content; 第二种: $content=preg_replac...2016-11-25
- php简单用户登陆程序代码 这些教程很对初学者来讲是很有用的哦,这款就下面这一点点代码了哦。 <center> <p> </p> <p> </p> <form name="form1...2016-11-25
- 这篇文章主要介绍了解决Java处理HTTP请求超时的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2021-03-29
- 公司一些wordpress网站由于下载的插件存在恶意代码,导致整个服务器所有网站PHP文件都存在恶意代码,就写了个简单的脚本清除。恶意代码示例...2015-10-23
- 本文实例讲述了JS实现双击屏幕滚动效果代码。分享给大家供大家参考,具体如下:这里演示双击滚屏效果代码的实现方法,不知道有觉得有用处的没,现在网上还有很多还在用这个特效的呢,代码分享给大家吧。运行效果截图如下:在线演...2015-10-30
- 其实挺简单的就是if(navigator.userAgent.indexOf('UCBrowser') > -1) {alert("uc浏览器");}else{//不是uc浏览器执行的操作}如果想测试某个浏览器的特征可以通过如下方法获取JS获取浏览器信息 浏览器代码名称:navigator...2015-11-08
- 一、日期减去天数等于第二个日期function cc(dd,dadd){//可以加上错误处理var a = new Date(dd)a = a.valueOf()a = a - dadd * 24 * 60 * 60 * 1000a = new Date(a)alert(a.getFullYear() + "年" + (a.getMonth() +...2015-11-08
- 这篇文章主要介绍了java 判断两个时间段是否重叠的案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧...2020-08-15