天画-codeMaker低代码平台设计与实现(上)

天画-codeMaker低代码平台设计与实现(上)

一、背景

1.1 总体背景

我在业余时间构建了一个租房平台，采用springboot微服务的架构模式，同时结合服务化思想进行代码实践，但是由于存在很多重复且低效的变更导致业余时间对这个租房平台的进度产生影响。作为开发人员长期维护一个业余项目产生了很多进度延迟和效率问题会导致项目项目被遗弃的概率增大，对开发者来说也是一个非常沮丧的事情。为了避免这种事情发生，我一方面鼓励自己尽量每天贡献代码，并在合适的时间构建提高开发效率的使用平台。另一方面也是为了借助这个租房平台进行微服务+分库分表+DDD领域实践。因此最初的目标就是为了构建大规模微服务应用，这就需要大量构建很多微服务工程。

目前这个平台的业务API主要还是以CURD类的接口为主，所以构建一个支持微服务架构生态支持分库分表，支持sql生成管理，支持所构建即所得，所操作即所得的低代码生成平台是优于业务开发的。在这个构建过程中业务开发和组件平台开发大部分时间是串行的，所以迭代不是一直持续的，而是优先解决业务开发过程中存在的效率问题。

以上是对codeMaker的一些背景介绍，由于我最近大半年的时间都在研究DDD，产出了一系列文章，目前已经到了实战环节，所以需要写大量的实战项目代码。但是时间和精力有限，所以想到了通过codemMaker来提高效率。

1.2 需求描述

1.支持单库，分库分表sql生成&管理（PS:业余玩分库分表也很轻松，持续迭代更容易）2.支持基于单库，分库分表的全量代码生成3.支持基于单库，分库分表的增量代码生成4.支持按模块的代码生成（如只生成某个表的service层，或者mapper层）5.基于spring,mybatis纯原生框架，生成的代码不依赖任何经过包装的中间件代码（如mybatis-plus）6.基于springboot工程的模式进行构建7.主要基于mysql数据库

二、需求调研

2.1 技术调研

虽然没有试用，经过慎重的调研上面的平台工具依然不是我理想中的或者我想要的那种，主要有以下几点理由：

1.代码生成模块功能不够丰富2.深度绑定某框架（如mybatis-plus），或者限定某spring版本3.有可视化界面缺缺乏表结构构建，表sql生成，包括分库分表sql的生成，管理4.深度依赖编辑器（如只支持idea）当然还有一些其他专门做低代码的高端平台，这里就不再列了，感兴趣的可以翻我朋友圈，内容很丰富哦。

2.2 技术选型

经过评估之后，我决定自己实现一个低代码平台，在技术选型上也确实参考了一些其他代码生成器的思路，这里给出我前期在构建这个平台的时候依赖的一些技术框架：数据库持久层：mysql 持久化框架：mybatis 微服务框架：springboot 代码文件模板：freemarker

2.3 核心功能和需求

1.支持基于数据库表结构的代码生成，

2.支持springboot框架应用的代码生成

3.支持全量和增量式的代码模块生成

4.支持controller,do,bo,service,serviceimpl,mapper,mapper,entity,test的代码元素的生成

5.支持基于数据库表txt配置文件生成DDL的sql语句

6.支持分库分表下的数据库和表DDL的sql语句

7.生成的代码demo单独存储在独立的工程模块下

三、工程架构

3.1 设计方案

1.通过Mybatis 链接数据库获取指定数据库中的表结构描述，主要包括表名，表描述，字段名，字段描述，字段类型

2.编写freemarker代码模板

3.通过freemarker将数据库表元数据渲染到代码模板中，生成目标代码

3.2 项目工程介绍

整个代码生成平台最初有三个模块组成，后面参考了团队的数据库表设计习惯将数据库表e-r图生成功能引入代码生成器里面，形成单独的模块：codermaker-dberPicture。后面被集成到codermaker-core工程项目中。

1.codermaker-core:根据数据库表结构和配置的代码模板生成项目代码2.codermaker-dberPicture:根据数据库表结构或者按照指定数据接口生成对应数据模型e-r图(基于plantUML)，是个工具jar包工程3.codermaker-dbops:数据库表结构运维工具,根据配置的sql字段内容生成单表或者多表或者分库分表的sql脚本，对各个应用的各个数据库的DDL语句进行管理，包括分库分表配置，但是不依赖数据源和中间件，是最简单的springboot工程。4.codermaker-web:这个工程是个空壳工程，根据codermaker-core项目生成的代码会在这个工程里展示,所见即所得,所操作即所得。

四、设计与实现

4.1 项目配置

整个代码生成项目分为三种配置：1.代码模板配置template.ftl2.项目的核心配置application.properties3.项目生成代码的个性化配置，projecttemplate.properties

4.2 架构图

4.3 接口api

4.3.1 表结构生成接口(codemaker-dbops[1])

/** * 生成运维分库分表变更语句 * 对应resources sql文件夹下目录名 * @param appName 应用名称 * @param dbName 数据库名称 * @param opsName 操作 * @return */ @GetMapping(value = "/dbops")

/** * 初始化应用表结构 * * @param appName 应用名称 * @param dbName 数据库名称 * @return */ @GetMapping(value = "/initshardingdb")

4.3.2 代码生成接口(codemaker-core[2])

/** * 生成模块的entity类 * @return */ @GetMapping("/getproject/entity")

/** * 生成模块的vo类 * @return */ @GetMapping("/getproject/vo")

/** * 生成模块的mapper类 * @return */ @GetMapping("/getproject/mapper")

/** * 生成模块的service类 * @return */ @GetMapping("/getproject/service")

/** * 生成模块的serviceimpl类 * @return */ @GetMapping("/getproject/serviceimpl")

/** * 生成模块的mapperxml类 * @return */ @GetMapping("/getproject/mapperxml")

/** * 生成模块的controller类 * @return */ @GetMapping("/getproject/controller")

/** * 生成项目的test类 * @return */ @GetMapping("/getproject/test")

4.4 极简模式介绍

这里的极简模式生成的代码是最为纯净的代码,主要体现在下面几个方面：

1.vo,entity自动生成get/set方法–不依赖lombok2.controller,service,mapper层之间没有调用关系3.日志类自动集成slf4j–不依赖lombok

4.5 极速模式介绍

这里的极速模式生成的代码是可以直接运行的，同时在已有代码上进行字段更新，迭代更快捷：

vo,entity自动带有lombok注解

2. controller,service,mapper层之间有默认调用关系

3.日志类自动lombok注解slf4j

4.6 使用流程图

五、未来规划

5.1 版本发布历史

1.实现codermaker-core代码生成功能 1.0.02.实现数据库表sql生成功能 1.0.03.实现数据库表e-r图生成功能 1.0.14.实现代码生成极速模式 1.0.2

5.2 迭代路线

1.codemaker-core增加代码生成快照功能

2.codemaker-core全面梳理其他文件的生成依赖数据

3.增加cola架构代码生成器功能

4.增加可视化页面配置 + 下载代码功能

6.增加dubbo框架的代码生成功能

六、后续

codeMaker经过多轮迭代在后端java代码生成已经相对成熟了，本章讲解的主要是codeMaker的早期设计和实现，下一篇将重点介绍codeMaker最近的一些迭代版本和特性，以及如何实现一套API支撑三大框架和动态ddd代码生成的。敬请期待。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。