天画项目-低代码平台-总体设计与实现

一、背景&需求

1.1 总体背景

我在业余时间构建了一个租房平台，采用springboot微服务的架构模式，同时结合服务化思想进行代码实践，但是由于存在很多重复且低效的变更导致业余时间对这个租房平台的进度产生影响。作为开发人员长期维护一个业余项目产生了很多进度延迟和效率问题会导致项目项目被遗弃的概率增大，对开发者来说也是一个非常沮丧的事情。为了避免这种事情发生，我一方面鼓励自己尽量每天贡献代码，并在合适的时间构建提高开发效率的使用平台。另一方面也是为了借助这个租房平台进行微服务+分库分表+DDD领域实践。因此最初的目标就是为了构建大规模微服务应用，这就需要大量构建很多微服务工程。目前这个平台的业务API主要还是以CURD类的接口为主，所以构建一个支持微服务架构生态支持分库分表，支持sql生成管理，支持所构建即所得，所操作即所得的低代码生成平台是优于业务开发的。在这个构建过程中业务开发和组件平台开发大部分时间是串行的，所以迭代不是一直持续的，而是优先解决业务开发过程中存在的效率问题。

1.2 需求描述

1.支持单库，分库分表sql生成&管理（PS:业余玩分库分表也很轻松，持续迭代更容易）

2.支持基于单库，分库分表的全量代码生成

3.支持基于单库，分库分表的增量代码生成

4.支持按模块的代码生成（如只生成某个表的service层，或者mapper层）

5.基于spring,mybatis纯原生框架，生成的代码不依赖任何经过包装的中间件代码（如mybatis-plus）

6.基于springboot工程的模式进行构建

7.主要基于mysql数据库

二、技术选型

2.1 技术调研

当我意识到我的大部分微服务工程都可以用低代码平台进行构建的时候我开始进行了一些技术调研，对一些已有的低代码平台或者脚手架进行评估。主要看了下面的一些开源产品：

https://gitee.com/jeecg/jeecg-boot

https://gitee.com/makejava/EasyCode.git

https://gitee.com/renrenio/renren-generator.git

https://gitee.com/zhouleib1412/jfinal-code-online.git

mybatis-generator插件

 

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

1.代码生成模块功能不够丰富

2.深度绑定某框架（如mybatis-plus），或者限定某spring版本

3.有可视化界面缺缺乏表结构构建，表sql生成，包括分库分表sql的生成，管理

4.深度依赖编辑器（如只支持idea）

2.2 技术选型

经过评估之后，我决定自己实现一个低代码平台，在技术选型上也确实参考了一些其他代码生成器的思路，这里给出我前期在构建这个平台的时候依赖的一些技术框架：

数据库持久层：mysql

持久化框架：mybatis

微服务框架：springboot

代码文件模板：freemarker

三、设计方案

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项目生成的代码会在这个工程里展示,所见即所得,所操作即所得。

3.3 项目配置

codemaker.global.package=com.lightsnail.app.user.crm.core   //目标工程根包名称
codemaker.global.author=fanchunshuai  //作者
codemaker.global.dbName=snail_app_user_crm  //数据库名称
codemaker.pom.projectName=lightsnail-app-user-crm  //项目应用名称
codemaker.pom.groupId=com.lightsnail.app.user.crm.core //GAV
codemaker.pom.artifactId=lightsnail-app-user-crm
codemaker.pom.version=1.0.0.SNAPSHOT
codemaker.code.outpath=E:\\workspace\\newWorkspace\\codeMaker\\codemaker-web //目标工程输出目录
codemaker.spring.parentversion=2.3.1.RELEASE  //引用的springboot版本

3.4 接口设计

3.4.1 表结构生成接口(codemaker-dbops)

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

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

3.4.2 代码生成接口(codemaker-core)

   /**
     * 生成模块的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")

   /**
     * 生成项目表结构的e-r图 plantUML文件
     * @return
     */
    @GetMapping("/getproject/erpicture")

   /**
     * 生成所有表对应的项目代码--极简模式
     * @return
     */
    @GetMapping("/makeall")

   /**
     * 生成所有表对应的项目代码--极速模式
     * @return
     */
    @GetMapping("/makeallfast")

   /**
     * 生成指定的表对应的项目代码--极简模式
     * @param tableNames 表名称，多个逗号分割
     * @return
     */
    @GetMapping("/makemodules")

   /**
     * 生成指定的表对应的项目代码--极速模式
     * @param tableNames 表名称，多个逗号分割
     * @return
     */
    @GetMapping("/makemodulesfast")

3.5 架构图

以上架构图是发布了几个特性之后进行整理的，下面重点解释一下极简模式和极速模式的区别。

3.6 代码生成-极简模式

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

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

3.7 代码生成-极速模式

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

1. vo,entity自动带有lombok注解
2. controller,service,mapper层之间有默认调用关系
3. 日志类自动lombok注解slf4j

四、接入使用

4.1 使用流程

 

五、未来规划

5.1 版本发布历史

1. 实现codermaker-core代码生成功能 1.0.0
2. 实现数据库表sql生成功能 1.0.0
3. 实现数据库表e-r图生成功能 1.0.1
4. 实现代码生成极速模式 1.0.2

5.2 roadMap路线

1. codemaker-core增加代码生成快照功能
2. codemaker-core全面梳理其他文件的生成依赖数据
3. 增加cola架构代码生成器功能
4. 增加可视化页面配置 + 下载代码功能
5. 集成https://github.com/pingfangushi/screw 的数据库文档能力
6. 生成dubbo服务接口代码