专栏首页小尘哥的专栏要“鱼”也要“渔”-java手写代码生成器

要“鱼”也要“渔”-java手写代码生成器

遇到重复工作一定想办法将其转化为自动化,我觉得这才是合格的程序猿。我们日常开发中遇到的80%的代码都是增删改查,当然,已经有一些插件,比如MP提供了一整套的代码生成方案,但是提供的基本都是java代码,因为模板语言有太多种,根据每个人每个项目的不同而不同,但是,模板中一样也基本是列表和表单提交,怎么来解决这个重复工作呢?

思路:依然依赖mp组件,因为mp已经提供了对应的BaseService,BaseMapper等,但是本文重点不在于“怎么用”,而在于“怎么写”。“怎么写”属于自己的代码生成器,方便自己随意扩展前端页面生成。

  1. 前提-数据库设计约定:表名、字段名多个单词时下划线分割
  2. 读取数据库,解析各个表字段及备注
  3. 实体类生成:根据字段名解析为对应实体类属性名,同时注释为属性注释
  4. 定义生成模板(xxx.ftl)
  5. 前端页面:数据库字段备注为表单中的字段名,根据字段类型设置输入项的html标签
  6. 分别生成实体类、Mapper、Service、前端页面等
  7. 替换(xxx.ftl)中的变量

一、TableInfo对象

一、JDBC读取数据库表结构

public Map<String, TableInfo> getTables() {
        try {
            DatabaseMetaData databaseMetaData = getConn().getMetaData();

            ResultSet resultSet = databaseMetaData.getColumns(null, "%", "%", "%");

            Map<String, TableInfo> tableInfoMap = new HashMap<>(8);
            while (resultSet.next()) {
                String tableName = resultSet.getString("TABLE_NAME");
                TableInfo tableInfo = tableInfoMap.get(tableName);
                if (tableInfo == null) {
                    tableInfo = new TableInfo(tableName, StringUtil.toHump(tableName,true));
                }

                String colName = resultSet.getString("COLUMN_NAME");
                String remark = resultSet.getString("REMARKS");
                String colType = resultSet.getString("TYPE_NAME");
                List<ColInfo> colInfos = tableInfo.getColInfos();
                if (colInfos == null || colInfos.size() == 0) {
                    colInfos = new ArrayList<>();
                }

                ColInfo colInfo = new ColInfo(colName, colType, remark);
                colInfos.add(colInfo);
                tableInfo.setColInfos(colInfos);

                tableInfoMap.put(tableName, tableInfo);
            }

            return tableInfoMap;
        } catch (SQLException e) {
            e.printStackTrace();
        }

        return null;
    }

二、生成实体类

dataMap 存放渲染ftl模板时的数据。

public void generateModel(String diskPath, TableInfo tableInfo) {
        String templateName = "model.ftl";
        String path = diskPath + File.separator + tableInfo.getModelName() + TableInfo.GEN_SUFFIX;
        Map<String, Object> dataMap = new HashMap<>();
        dataMap.put("ModelName", tableInfo.getModelName());
        dataMap.put("packageName", "com.mos.aaa");
        List<ColInfo> colInfos = tableInfo.getColInfos();
        dataMap.put("fields", colInfos);
        List<String> pcks = new ArrayList<>();
        for (ColInfo info : colInfos){
            if (StringUtil.isNotBlank(info.getFieldType().getPkg()) && !pcks.contains(info.getFieldType().getPkg())){
                pcks.add(info.getFieldType().getPkg());
            }
        }
        dataMap.put("pcks", pcks);
        generateFileByTemplate(templateName, path, dataMap);

    }

三、Model模板定义(用来生成Entity)

package ${packageName};

import com.baomidou.mybatisplus.activerecord.Model;
import java.io.Serializable;
<#if pcks??>
<#list pcks as pck>
import ${pck!};
</#list>
</#if>

public class ${ModelName} extends Model<${ModelName}> {
    private static final long serialVersionUID = 1L;

<#list fields as field>
    /**
    * ${field.remark!}
    */
    private ${field.fieldType.type} ${field.changedColNameLower};
</#list>

<#list fields as field>

    public ${field.fieldType.type} get${field.changedColName}(){
        return ${field.changedColNameLower};
    }

    public void set${field.changedColName}(${field.fieldType.type} ${field.changedColNameLower}){
        this.${field.changedColNameLower} = ${field.changedColNameLower};
    }
</#list>

    @Override
    protected Serializable pkVal() {
        return this.id;
    }

}

四、最终文件生成

private void generateFileByTemplate(final String templateName, String genPath, Map<String, Object> dataMap) {
        try {
            Template template = FreeMarkerTemplateUtils.getTemplate(templateName);
            FileOutputStream fos = new FileOutputStream(new File(genPath));
            Writer out = new BufferedWriter(new OutputStreamWriter(fos, "utf-8"), 10240);
            template.process(dataMap, out);
        } catch (Exception e) {
            System.out.println(e.getMessage());
        }

    }

五、生成结果

六、扩展

以上只是生成简单的Entity实体类示例。一般我们后台页面结构为左、上、下、中四部分,我们只需要生成“中”部分即可,可以根据一个已完成的页面,替换其中的变量即可,生成原理同上。

本文分享自微信公众号 - 陌与尘埃(grq100296),作者:小尘哥

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-10-01

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • springboot集成shiro

    是不是发现一般权限模块都是领导(或者技术大神)写的,你只管用就好了?不想当领导的程序猿不是好厨子。废话少说,先简单说下怎么用,黑猫白猫,会写权限才可能是高级猫,...

    小尘哥
  • 【springboot+easypoi】导出多个sheet页

    对,没有错,又是我,又是easyPOI,又是excel导出。每个程序猿都听说技术是为业务服务的,那么···当需求变了之后我们能做什么呢?

    小尘哥
  • 第10节 安装Goland开发工具

    IED:集成开发环境(integrated development environment)

    小尘哥
  • 设计模式之——组合模式 Composite Pattern

    精简之后的代码显得格外简洁,而且环境类只需要直接和抽象类 Corp 关联就可以了,代码如下:

    wsuo
  • 编程语言的基础——搞定JavaIO

    关键字:IO基础,JUnit生命周期,字节流,字符流,字符编码,对象流,序列化,反序列化 Java I/O 流是一组有顺序的,有起点和终点的字节集合。是对设...

    文彬
  • 关于通知的一些小问题

    最近做下载,有一个通知显示进度的需求。这个过程中碰到一些问题,这里总结下,方便大家排查。

    夏洛克的猫
  • 4.表格-HTML基础

    当然,对于表头单元格,我有可能会使用 td 来代替 th,但不建议这样做。 因为在HTML语义化中了解到:学习 HTML 的目的就是在需要的地方使用恰当的标...

    见贤思齊
  • .NET Core 使用 NZookeeper 连接 Zookeeper

    开源地址:https://github.com/stulzq/NZookeeper

    晓晨
  • 写了一个实用的图像放大缩小程序,但是动画GIF转换后不会显示了,只有第一帧

    写了一个实用的图像放大缩小程序,但是动画GIF转换后不会显示了,只有第一帧

    阿敏总司令
  • HTML table标签和其子标签如td,td等不同区域focus然后回车的行为差异

    试了一下,发现td获得不到焦点。网上查了一下,发现csdn这个帖子:说td获取不到焦点。

    Jerry Wang

扫码关注云+社区

领取腾讯云代金券