molicode生成工程代码实战
背景描述
这是一个molicode工具的经典案例场景,即利用molicode通过数据库表模型,生成大量的业务代码。通常意义上讲,目前我们的代码模板是偏向于简单化的增删改查功能。
业务代码的丰富程度取决于数据model的丰富 + 代码模板的丰富。 如果这两个模型足够丰富,理论上是能够生产任意的业务代码。市面上其它代码生成器每个都有自己的优点,其长处主要体现在以上 model+ template 的丰富及适用程度。故而某种意义上讲,能用其它代码工具生成的业务代码,建议继续使用,主要体现在其已经开发了适合您使用的数据模型+代码模板。 除非其做了molicode的适配,或者您有兴趣对其做本工具的适配和模板调整,这样才能使用本工具生成其已经实现的功能。
自动生成代码的基本要求
a. 有一套满足需求的基本脚手架,如springboot已经搭建好的干净的工程。
一般是将我们平时所使用的业务系统,业务代码删除干净,只留一个基本的框架和常用的工具类,用于作为base project备用。
b. 通过molicode工具【全文替换工具】进行 base project转化。
【全文替换工具】的主要作用是,修改工程的名称,修改代码的包路径。
可以进行包路径的延长或者缩短,进行全局文件替换匹配的字符串。
示例:com/apache/hello=com/mycompany/group/myprj 路径延长;
base-project=hello-project 文件目录名称替换;
d. 获取代码模板
如果您是一个模板使用者,这是比较简单的,您可以和模板开发人员联系,让其告知您git仓库地址,然后下载或者直接配置git地址即可使用。
为了实时追踪最新的代码模板,建议使用git仓库来下载代码模板。
D. 项目配置
项目配置是为了在不同项目之间能够快速切换,项目配置记录了本项目以下相关信息:
数据库连接信息;(如果不需要数据库相关功能,可以不配);
工程目录设置;如果是输出到本地设置本地输出目录,使用git模板仓库的请填写模板的git地址,分支等信息;
业务代码设置;
设置代码相关的配置信息,后期期望是提供一个入口,可以提供更多的用户可配置项目;
E. 代码生成
好了,总算来到最后一步,惊不惊喜意不意外。经过以上的设置后,即可直接生成业务代码了,让代码飞一会儿。
- 选择适配的数据模型:tableModel(其它的请参考其它文章);
- 输入源类型;可以通过数据库连接拉取表列表,然后对表模型进行微调后再输出代码;
- 其它配置略;
- 模板列表,选择需要生成的代码模板;
- 点击【生成代码】按钮即可。
以上几个步骤就是生成代码需要的所有步骤,请务必按要求进行操作。
更详细的使用说明,可以参考:
https://cn2oo8.github.io/molicode_doc/
吐槽
配置这么多,是不是太麻烦了??
从某种意义上来讲,配置主要集中在第一次使用时,等您配置了第一次之后,其实您只需要每次使用:c, f 步骤即可自动生成业务代码了。 万事开头难,后面的好简单!
实际操作
**目标: ** 生成基础工程,然后使用一个表生成基本的增删改查功能。
step 1: 通过表达式构建自己的工程
打开molicode, 并点击【自动代码工具】-> 【全文替换工具】
配置01,配置基础工程git地址等,并从仓库拉取数据(如果SSH无法成功,可以改成http或者https模式拉取仓库代码)。其中丢弃表达式,主要是丢弃如.git, 或者target等非工程相关的文件。这些应该是原来工程私有的,新建的工程完全不需要。
表达式&执行
进行一些必要的替换配置,然后生成相关的新工程。
这里我需要生成一个 用户中心, maven的前缀改为:usercenter, 而包名则调整为:com.shareyi.user.center。如下所示:
替换表达式:
baseproject-springboot=usercenter
com.shareyi.basespringboot=com.shareyi.user.center
目录转换表达式
com/shareyi/basespringboot=com/shareyi/user/center
完成以上两部分配置之后,点击【保存配置信息】,然后再【执行替换】。即可完成基础工程的生成。这样我们即可得到一个可以使用的新工程。
step 3: 配置项目
新增一个项目,如下,并设置为默认项目进行配置;
配置【数据库设置】,目前只支持MySQL,其实是很容易支持其它数据库的,但是当前没有时间做相应的开发,期望您join并实现您需要的数据库类型。
配置【工程目录设置】,如果非本地工程目录,你可以直接配置git地址,并拉取模板到本地: 保存配置信息,并拉取git相关代码到本地;拉取成功后再进行下一步...
配置【业务代码设置】
step 5: 生成代码
a. 如果代码模板已经从git仓库成功拉取,那么点击【刷新模板列表】就可以看到最新的模板信息;
b. 如果是数据库表生成代码,可以直接配置数据连接后,点击【获取table列表】即可拉取数据库的表信息;
c. 在需要生成的表结构后面点击【配置生成代码】,弹出编辑生成代码窗口;进行相关信息配置后,即可点击按钮【执行代码生成】来生成代码。
d. 查看结果,可以点击下载代码压缩包,或者直接预览代码。需要特别说明的是,如果你是本地启动的代码生成工具,你可以配置直接输出到本地文件夹,这样可直接去文件夹下查看相关输出。
happy ending
查看生成的项目和代码:domain -> mybatis mapper(dao) -> manager -> service -> controller + Vue界面。
2019-04-14 00:48:24,049 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [domain类]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-domain/src/main/java/com/shareyi/user/center/domain/config/AcConfig.java
2019-04-14 00:48:24,050 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [builder类]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-domain/src/main/java/com/shareyi/user/center/builder/impl/AcConfigBuilder.java
2019-04-14 00:48:24,053 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [column 枚举]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-common/src/main/java/com/shareyi/user/center/common/enums/columns/AcConfigColumn.java
2019-04-14 00:48:24,054 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [dao接口]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-dao/src/main/java/com/shareyi/user/center/dao/config/AcConfigDao.java
2019-04-14 00:48:24,055 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [mybatisMapper]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-dao/src/main/resources/mapper/AcConfig.xml
2019-04-14 00:48:24,057 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [manager 接口]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-manager/src/main/java/com/shareyi/user/center/manager/config/AcConfigManager.java
2019-04-14 00:48:24,058 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [manager接口 实现]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-manager/src/main/java/com/shareyi/user/center/manager/config/impl/AcConfigManagerImpl.java
2019-04-14 00:48:24,060 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [service SDK 接口]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-service/src/main/java/com/shareyi/user/center/service/config/AcConfigService.java
2019-04-14 00:48:24,061 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [service SDK 接口 实现]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-service/src/main/java/com/shareyi/user/center/service/config/impl/AcConfigServiceImpl.java
2019-04-14 00:48:24,063 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [validator SDK验证]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-service/src/main/java/com/shareyi/user/center/validate/provide/AcConfigValidator.java
2019-04-14 00:48:24,064 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [controller]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-web/src/main/java/com/shareyi/user/center/controller/config/AcConfigController.java
2019-04-14 00:48:24,066 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [add页面]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/ui-starter/src/views/config/acConfig/add.vue
2019-04-14 00:48:24,067 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [edit页面]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/ui-starter/src/views/config/acConfig/edit.vue
2019-04-14 00:48:24,072 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [list页面]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/ui-starter/src/views/config/acConfig/list.vue
2019-04-14 00:48:24,073 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [operate页面]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/ui-starter/src/views/config/acConfig/operate.vue
2019-04-14 00:48:24,075 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [tableDefineVue]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/ui-starter/src/views/config/acConfig/tableDefine.js
2019-04-14 00:48:24,077 [http-nio-8098-exec-2] INFO (frontConsole:-1) - [表结构]模板执行成功,生成文件在:/Users/zhangshibin/github_output/springboot-base-prj/usercenter-web/src/main/resources/temp/AcConfigTableInfo.txt
UI: 使用的是基于 Vue的 iview UI, 使用起来比较定制化,可能需要您去适用,您也可以完全不使用这套UI,采用bootstrap获取其它UI亦可。 这个时候,您就需要选择一款适合您工程开发的整体模板即可。
aceadmin解决方案
也提供了基于aceadmin bootstrap相关的前端UI解决方案,请访问以下文档搜索: