java自动生成代码原理_原来这就是Java代码生成器的原理啊,太简单了
前几天写了篇关于代码生成器的文章(可查看历史文章),不少同学私下问我这个代码生成器是如何运作的,为什么要用到一些模板引擎,所以今天来说明下代码生成器的流程。
2. 代码生成器的使用场景
我们在编码中存在很多样板代码,格式较为固定,结构随着项目的迭代也比较稳定,而且数量巨大,这种代码写多了也没有什么技术含量,在这种情况下代码生成器可以有效提高我们的效率,其它情况并不适于使用代码生成器。
3. 代码生成器的制作流程
首先我们要制作模板,把样板代码的固定格式抽出来。然后把动态属性绑定到模板中,就像做填空题一样。所以在这个流程中模板引擎是最合适的。我们通过使用模板引擎的语法将数据动态地解析到静态模板中去,然后导出为编程中对应的文件就行了。
另外模板引擎有着丰富的绑定数据的指令集,可以让我们根据条件动态的绑定数据到模板中去。以Freemarker为例:
三元表达式:
${true ? ‘checked‘: ‘‘}
还有我们等下要用的遍历列表:
private ${field.fieldType} ${field.fieldName};
#list>
在 Java 开发中我们常用的模板引擎有Freemarker、Velocity、Thymeleaf ,随着Web开发中前后端分离的流行模板引擎的使用场景正在被压缩,但是它依然是一门有用的技术。
4. 代码生成器演示
接下来,我们以Freemarker为例写一个简单的代码生成器,来生成POJO类。需要引入Freemarker的依赖。
org.freemarker
freemarker
2.3.28
4.1 模板制作
POJO的结构可以分为以下几部分:
Java类的基本结构
java.lang 包无需导入。
所以将这些规则封装到配置类中:
public class JavaProperties {
// 包名
private final String pkg;
// 类名
private final String entityName;
// 属性集合 需要改写 equals hash 保证名字可不重复 类型可重复
private final Set fields = new LinkedHashSet<>();
// 导入类的不重复集合
private final Set 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 getFields() {
return fields;
}
public Set 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};
import ${impt};
#list>
/**
* the ${entityName} type
* @author felord.cn
*/
public class ${entityName} {
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);
生成的效果是不是跟手写的差不多:
生成的Java POJO
5. 总结
这就是大部分代码生成器的机制,希望可以解答一些网友的疑问。
java自动生成代码原理_原来这就是Java代码生成器的原理啊,太简单了相关推荐
- java 自动生成mybatis文件_如何自动生成Mybatis的Mapper文件详解
前言 工作中使用mybatis时我们需要根据数据表字段创建pojo类.mapper文件以及dao类,并且需要配置它们之间的依赖关系,这样的工作很琐碎和重复,mybatis官方也发现了这个问题,因此给我 ...
- java 输出定位代码行_指定一个.java文件,输出其代码行数
CountList2.java//用来统计java代码行数 import java.io.BufferedReader; import java.io.File; import java.io.Fil ...
- java自动生成代码框架_DodoFramework- 一个基于代码生成引擎的Java Web系统自动化开发框架...
@DodoShowColumn(sortSeq = 0) @DodoField(name = "产品名称", sortSeq = 0, isRemoteCheck = true, ...
- java自动生成类_自动生成优化的Java类专业知识
java自动生成类 如果您今年访问过JavaOne,您可能已经参加了我的演讲"如何从数据库生成定制的Java 8代码". 在那次演讲中,我展示了如何使用Speedment Open ...
- Java进阶之 如何自动生成代码
一.前言:为什么要有代码的自动生成? 对于这个问题 最简洁直接的回答就是:代替手动编写代码.提高工作效率. 什么样的场景和代码适合用自动生成这种方式呢? 做过Java服务端的朋友一定都 ...
- 解决Mybatis Plus代码自动生成时报错: Caused by: java.lang.ClassNotFoundException: org.apache.velocity.context
解决Mybatis Plus代码自动生成时报错: Caused by: java.lang.ClassNotFoundException: org.apache.velocity.context.Co ...
- C#分析数据库结构,使用XSL模板自动生成代码
<html> <head> <TITLE>分析数据库结构,自动生成代码</TITLE> <meta http-equiv="Conten ...
- 简单的利用IDEA搭建SpringBoot+Maven+Mybatis+自动生成代码
最近在系统的学习SpringBoot框架,并且要用该框架做个项目--网上也大大小小看了很多教程,感觉很多写文章的人都不太负责任,只知道搬运,大概都没有实际操作过,问题也是有很多,所以自己写一篇文章记录 ...
- MyBatisPlus自动生成代码springboot+mybatis+mysql 以及动态sql生成方法(测试可用版)
用了一段时间的springboot,想着百度一下自动生成代码的方式,包括后面如何生成动态sql方法的方式. 摸索了几天,整理一下: ** 1 自动生成代码方式:com.baomidou.mybatis ...
最新文章
- excel 文档管理服务器,Excel Server Tutorial
- 如何在Java代码中使用SAP云平台CloudFoundry环境的环境变量
- Java 8:将匿名类转换为Lambda表达式
- 简述oracle数据库特殊状态,【OracleDB】 01 概述和基本操作
- syslog打印不带等级_syslog之一:Linux syslog日志系统详解
- 重温Android——调节屏幕亮度
- 操作系统—吸烟者问题
- 关于html5中a链接的download属性
- 亿佰特Wifi模块、蓝牙模块和Zigbee模块协议在物联网智能家居上的应用指南
- TalkingData的使用,iOS数据统计
- 尾气冒黑烟是什么问题_尾气冒黑烟是坏了?教你通过尾气辨别爱车是否故障!...
- 南大软院大神养成计划--HTML和CSS基础课程(二)
- 基金强力介入移动互联网板块
- [介绍]关于我与我的未来
- hive与Oracle数据库的相互同步
- Oracle的系统和对象权限 查看用户包含的各类权限
- 基于slurm框架的GPU服务器集群搭建方法
- 最强特殊字符、表情符号、Unicdeo字符串处理
- 深入理解Redis Cluster和Jedis Cluster
- Labview从入门到会用(一)——创建数据文件
热门文章
- java序列化 jar_使用序列化将对象传递给另一个JVM – 相同的Java版本和jar(都运行我们的应用程序)...
- 【控制】多智能体系统总结。1. 系统模型。2.控制目标。3.模型转换。
- 径向基RBF(radial basis function)函数、RBF神经网络、 反推(back-stepping)控制
- 【数理知识】《积分变换与场论》王振老师-第1章-傅里叶变换
- 2.4 使用来自不同分布的数据,进行训练和测试-深度学习第三课《结构化机器学习项目》-Stanford吴恩达教授
- 1.1 训练/开发/测试集-深度学习第二课《改善深层神经网络》-Stanford吴恩达教授
- STM32 基础系列教程 30 - 文件系统
- 【arduino】初测ESP32的DAC生成AV视频模拟信号项目:ESP32CompositeVideo
- 【PC工具】windows批处理脚本一键bat脚本编辑器,bat转exe工具使用方法,附helloworld参考例程...
- 对图像进行二维离散Fourier变换