如何编写自己的代码生成器

我平常开发都会用到代码生成器，本文将介绍如何制作属于自己业务的代码生成工具

代码生成器的作用

一个新的需求开发涉及到的数据库表有可能有很多张，每个都需要去写增删改查后台管理页面有很多重复的工作并且浪费时间。
具体的作用大家在工作中也都使用过类似的代码生成工具就不在去详细的介绍了，主要有以下几个优点

代码风格统一，易维护
提高开发效率
降低bug率从而降低测试成本
无需浪费过多的精力在重复的工作上

代码生成器的原理

代码生成器原理其实非常简单，就是使用我们平常写的代码抽取出来一套模板，使用模板绑定数据生成我们需要的代码。

接下来一步步去实现一个我们经常用到前端增删改查的生成器

大家想下，没有页面代码生成工具我们是怎么做的？

首先是复制一个以前开发过的列表、新增页面将它复制过来
修改列表页面的标题、展示列、查询域
修改新增页面的表单信息，添加自己的字段
修改列表以及表单用到的增删改查接口
测试是否可用

有了工具一般我们是怎么做的？

运行工具
简单修改

如何制作生成工具

我们可以写个标准的页面来做我们的模板
将我们平常复制修改的地方修改为占位符
我们可以通过代码将数据（可以通过数据库、自定义等方式去获取）绑定到模板上生成一个新的页面

程序设计

涉及到几大块

制作模板
获取模板绑定的数据源
进行绑定
生成文件

代码实现

制作模板

原页面展示效果如下

源码

<!DOCTYPE html>
<html><head><meta charset="utf-8" /><link rel="stylesheet" type="text/css" href="https://www.layuicdn.com/layui/css/layui.css" /><script src="https://www.layuicdn.com/layui/layui.js"></script></head><body>         
<blockquote class="layui-elem-quote layui-text">
代码生成展示 
</blockquote><fieldset class="layui-elem-field layui-field-title" style="margin-top: 50px;"><legend>测试</legend>
</fieldset>
<form class="layui-form layui-form-pane" action=""><div class="layui-form-item"><label class="layui-form-label">输入框</label><div class="layui-input-inline"><input type="text" name="username" lay-verify="required" placeholder="请输入" autocomplete="off" class="layui-input"></div></div><div class="layui-form-item"><div class="layui-inline"><label class="layui-form-label">日期</label><div class="layui-input-inline"><input type="text" name="date" id="date1" autocomplete="off" class="layui-input"></div></div></div><div class="layui-form-item"><label class="layui-form-label">单行选择框</label><div class="layui-input-inline"><select name="interest" lay-filter="aihao"><option value=""></option><option value="0">写作</option><option value="1" selected="">阅读</option><option value="2">游戏</option><option value="3">音乐</option><option value="4">旅行</option></select></div></div><div class="layui-form-item" pane=""><label class="layui-form-label">单选框</label><div class="layui-input-block"><input type="radio" name="sex" value="男" title="男" checked=""><input type="radio" name="sex" value="女" title="女"><input type="radio" name="sex" value="禁" title="禁用" disabled=""></div></div><div class="layui-form-item layui-form-text"><label class="layui-form-label">文本域</label><div class="layui-input-block"><textarea placeholder="请输入内容" class="layui-textarea"></textarea></div></div><div class="layui-form-item"><button class="layui-btn" lay-submit="" lay-filter="submit">提交</button></div>
</form>    
<script>
layui.use(['form', 'layedit', 'laydate', 'layer'], function(){var form = layui.form,layer = layui.layer,layedit = layui.layedit,laydate = layui.laydate;laydate.render({elem: '#date1'});//监听提交form.on('submit(submit)', function(data){layer.alert(JSON.stringify(data.field), {title: '最终的提交信息'})return false;});});
</script></body>
</html>

将可以数据绑定的地方使用占位符代替制作成模板

<!DOCTYPE html>
<html><head><meta charset="utf-8" /><link rel="stylesheet" type="text/css" href="https://www.layuicdn.com/layui/css/layui.css" /><script src="https://www.layuicdn.com/layui/layui.js"></script>
</head>
<body>
<blockquote class="layui-elem-quote layui-text">代码生成展示
</blockquote><fieldset class="layui-elem-field layui-field-title" style="margin-top: 50px;"><legend>${title}</legend>
</fieldset>
<form class="layui-form layui-form-pane" action="" style="margin: 20px;">${ui}<div class="layui-form-item"><button class="layui-btn" lay-submit="" lay-filter="submit">提交</button></div>
</form>
<script>layui.use(['form', 'layedit', 'laydate', 'layer'], function(){var form = layui.form,layer = layui.layer,layedit = layui.layedit,laydate = layui.laydate;${script}//监听提交form.on('submit(submit)', function(data){layer.alert(JSON.stringify(data.field), {title: '最终的提交信息'})return false;});});
</script>
</body>
</html>

可以看到已经把能通过代码动态填充的部分用占位符替代

数据源

生成代码用到的数据表对象

public class TableBO {//标题private String title;//名称private String name;//是否可以删除private Integer canDelete;//是否能新增private Integer canAdd;//是否可编辑private Integer canEdit;//是否可查询private Integer canQuery;//列private List<ColumnBO> columns;
}

表具体的字段

public class ColumnBO {//标题private String title;//名称private String name;//字段长度private Integer length;//ui组件private FormUiEnum ui;//组件值private String uiValue;//是否必填private boolean isRequired;//是否是主键private boolean isId;//java类型private String javaType;//是否能在页面新增private Boolean canAdd;
}

数据绑定

下面为表单的数据绑定

public class FormTemplateDataBind implements ITemplateDataBind {@Overridepublic String bindDataToString(TableBO tableBO) {//封装模板使用的数据HashMap<String, Object> bindData = new HashMap<>();bindData.put("title",tableBO.getTitle());//表单字段组件内容获取bindData.put("ui",new UiTemplateContentHandler().get(tableBO));//表单需要的js脚本获取bindData.put("script",new ScriptTemplateContentHandler().get(tableBO));//绑定模板(这里可以使用三方插件，如 freemarker，beetl等模板工具)String formTemplate = BeetlTemplateGenUtils.bindToString(bindData, "formTemplate.html");//输出return formTemplate;}
}

根据字段组件类型获取不同的组件内容。

public class UiTemplateContentHandler implements ITemplateContentHandler {@Overridepublic String get(TableBO tableBO) {StringBuilder stringBuilder = new StringBuilder();List<ColumnBO> columns = tableBO.getColumns();for (ColumnBO column : columns) {if(column.getCanAdd()==true){switch (column.getUi()){case INPUT:stringBuilder.append(new InputUiHtmlHandler().get(column));break;case DIC:break;case DATE:break;case FILE:break;case RADIO:break;case IMAGE:break;case SELECT:stringBuilder.append(new SelectUiHtmlHandler().get(column));break;case TEXTAREA:stringBuilder.append(new TextAreaUiHtmlHandler().get(column));break;case HTML:break;default:stringBuilder.append(new InputUiHtmlHandler().get(column));break;}}}return stringBuilder.toString();}
}

演示文本框组件内容获取

public class InputUiHtmlHandler implements IUiHtmlHandelr {@Overridepublic String get(ColumnBO columnBO) {String required = "";if(columnBO.isRequired()){required = "required";}return "  <div class=\"layui-form-item\">\n" +"    <label class=\"layui-form-label\">"+columnBO.getTitle()+"</label>\n" +"    <div class=\"layui-input-inline\">\n" +"      <input type=\"text\" name=\""+columnBO.getName()+"\" lay-verify=\""+required+"\" placeholder=\"请输入\" autocomplete=\"off\" class=\"layui-input\">\n" +"    </div>\n" +"  </div>\n";}
}

编写测试用例

代码生成数据来源测试是使用自己定义的数据而没有读取数据库，可以读取数据库，将数据库的信息映射到我们的对象中

public static void main(String[] args) {//相当于添加一个数据库表 如：短信模板配置表TableBO tableBO = new TableBO();tableBO.setTitle("短信模板配置");tableBO.setName("smsTemplate");tableBO.setCanDelete(0);tableBO.setCanAdd(1);tableBO.setCanEdit(0);tableBO.setCanQuery(1);//数据库表有哪些字段List<ColumnBO> columns = Lists.newArrayList();//模板名称字段ColumnBO columnBO = new ColumnBO();columnBO.setCanAdd(true);columnBO.setTitle("模板名称");columnBO.setName("templateName");columnBO.setLength(20);columnBO.setUi(FormUiEnum.INPUT);columnBO.setUiValue("");columnBO.setRequired(true);columnBO.setId(true);columnBO.setJavaType("String");//模板内容字段ColumnBO columnBO2 = new ColumnBO();columnBO2.setCanAdd(true);columnBO2.setTitle("模板内容");columnBO2.setName("templateContent");columnBO2.setLength(300);columnBO2.setUi(FormUiEnum.TEXTAREA);columnBO2.setUiValue("");columnBO2.setRequired(true);columnBO2.setId(true);columnBO2.setJavaType("String");//模板类型字段ColumnBO columnBO3 = new ColumnBO();columnBO3.setCanAdd(true);columnBO3.setTitle("模板类型");columnBO3.setName("templateType");columnBO3.setLength(20);columnBO3.setUi(FormUiEnum.SELECT);columnBO3.setUiValue("{\"1\":\"短信通知\",\"2\":\"验证码\"}");columnBO3.setRequired(true);columnBO3.setId(true);columnBO3.setJavaType("String");columns.add(columnBO);columns.add(columnBO2);columns.add(columnBO3);tableBO.setColumns(columns);//将数据与模板绑定输出新的内容ITemplateDataBind templateDataBind = new FormTemplateDataBind();String template = templateDataBind.bindDataToString(tableBO);System.out.printf(template);}

运行程序输出内容为：

<!DOCTYPE html>
<html><head><meta charset="utf-8" /><link rel="stylesheet" type="text/css" href="https://www.layuicdn.com/layui/css/layui.css" /><script src="https://www.layuicdn.com/layui/layui.js"></script>
</head>
<body>
<blockquote class="layui-elem-quote layui-text">代码生成展示
</blockquote><fieldset class="layui-elem-field layui-field-title" style="margin-top: 50px;"><legend>短信模板配置</legend>
</fieldset>
<form class="layui-form layui-form-pane" action="" style="margin: 20px;"><div class="layui-form-item"><label class="layui-form-label">模板名称</label><div class="layui-input-inline"><input type="text" name="templateName" lay-verify="required" placeholder="请输入" autocomplete="off" class="layui-input"></div></div><div class="layui-form-item layui-form-text"><label class="layui-form-label">模板内容</label><div class="layui-input-block"><textarea name="templateContent" placeholder="请输入内容" class="layui-textarea"></textarea></div></div><div class="layui-form-item"><label class="layui-form-label">单行选择框</label><div class="layui-input-inline"><select name="templateType" lay-filter="templateType"><option value=""></option><option value="1">短信通知</option><option value="2">验证码</option></select></div></div><div class="layui-form-item"><button class="layui-btn" lay-submit="" lay-filter="submit">提交</button></div>
</form>
<script>layui.use(['form', 'layedit', 'laydate', 'layer'], function(){var form = layui.form,layer = layui.layer,layedit = layui.layedit,laydate = layui.laydate;//监听提交form.on('submit(submit)', function(data){layer.alert(JSON.stringify(data.field), {title: '最终的提交信息'})return false;});});
</script>
</body>
</html>