【定制化代码生成项目】02-项目设计与学习阶段

需求分析

其实上面已经带大家了解了项目的基本信息、项目的意义和价值。在需求分析阶段，我们通常还要进行一些调研工作，帮助我们明确需求、为后面的设计做好充分的准备。

调研

网上有一些代码生成器项目，比如前端 Ant Design Pro 中后台项目脚手架，能够让用户交互式地创建指定的项目；还有后端 MyBatis X 插件，能够让用户通过界面来创建 CRUD 重复代码。但这些项目都是开发者提前制作好了代码生成器，然后让你 根据他们设置好的规则 生成代码（或者拉取特定位置的代码），生成后的代码通常还要再自己二次修改，不够灵活。

还有很多所谓的代码生成项目，其实本质上是一个现成的项目模板，让你通过编写对应的配置文件来使用项目，或者还是基于预设的程序来生成特定代码。比如 编程导航知识星球 的 Spring Boot 万用项目模板，或者网上很多知名的开源管理系统。

这和我们要做的事情不同，我们的目标是升级一个层次！打造一个帮助大家快速制作代码生成器的工具，也就是 “造轮子的轮子”。

然后再升级一个层次！允许用户像发布应用一样，在平台上发布和管理代码生成器，便于共享和协作！

技术选型

暂定的核心技术如下，实际开发中还会引入新技术

前端

  • React 开发框架 + 组件库 + 代码编辑器
  • 前端工程化：ESLint + Prettier + TypeScript

后端

  • Java Spring Boot + MySQL + MyBatis Plus（万用后端模板）
  • Java 命令行应用开发
  • FreeMarker 模板引擎
  • Vert.x 响应式编程
  • Caffeine + Redis 多级缓存
  • 分布式任务调度系统
  • 多种设计模式
  • 多种系统设计的巧思
  • 对象存储、

学习重点

其中：Java 命令行应用开发、FreeMarker 模板引擎、Vert.x 响应式编程、设计模式、系统设计的巧思、分布式任务调度系统都是本项目的学习重点，也是校招简历上很少有同学提到的知识实践，学完后能够大大增加简历的区分度！
比如 Vert.x 框架，并发连接处理能力吊打 Spring 几条街！

Web Framework Benchmarks 性能对比网站：

https://www.techempower.com/benchmarks/#section=data-r21&test=composite

image-20231113235845853

image-20231113235912317

项目设计

首先我们要理解代码生成的核心原理。

代码生成器的核心原理

一句话：参数 + 模板文件 = 生成的完整代码

比如参数：

1
作者 = 鱼皮

模板文件代码：

1
2
3
-----------
我是 ${作者}
-----------

将参数注入到模板文件中，得到生成的完整代码：

1
2
3
-----------
我是 鱼皮
-----------

如果想要使用这套模板生成其他的代码，只需要改变参数的值即可，而不需要改变模板文件。
理解了代码生成器的核心原理后，就可以开始思考项目的设计实现方案了。

项目总共分为 3 个阶段，让我们分别来进行设计。

第一阶段 - 本地代码生成器

这个阶段，我们的目标是做一个本地（离线）的代码生成器，实现一个简易的 Java ACM 模板项目的定制化生成。
本阶段不依赖复杂的开发框架，没学过任何开发框架也能学习。

业务流程

  1. 准备用于制作代码生成器的原始代码（比如 Java ACM 模板项目），用于后续生成
  2. 开发者基于原始代码，设置参数、编写动态模板
  3. 制作可交互的命令行工具，支持用户输入参数，得到代码生成器 jar 包
  4. 使用者得到代码生成器 jar 包，执行程序并输入参数，从而生成完整代码

流程图如下：

image-20231114000342815

实现思路

  1. 先根据本地项目，扫描文件树，实现同样的静态代码生成
  2. 根据本地的项目，预设部分动态参数、编写模板文件，能够传入配置对象进行生成
  3. 制作可交互的命令行工具，接受用户输入的参数，并动态生成代码
  4. 封装制作代码生成器 jar 包文件，并简化使用命令

第二阶段 - 代码生成器制作工具

这个阶段，我们的目标是做一个本地的代码生成器制作工具，能够快速将一个项目制作为可以动态定制部分内容的代码生成器。并且以一个 Spring Boot 初始化项目模板（Maven 项目）为例，演示如何根据自己的需要动态生成 Java 后端初始化项目。
本阶段的学习需要一定的 Spring Boot 开发知识，最好先完成 星球的其他项目 ，推荐用户中心和聚合搜索。

业务流程

  1. 准备用于制作代码生成器的原始代码（比如 Spring Boot 项目模板），用于后续生成
  2. 开发者基于原始代码，使用代码生成器制作工具，来快速设置参数、生成动态模板
  3. 使用代码生成器制作工具，动态生成代码生成器 jar 包
  4. 使用者得到代码生成器 jar 包，执行程序并输入参数，从而生成完整代码

流程图如下：

image-20231114000638094

实现思路

  1. 使用独立空间来存储管理要生成的原始文件、动态模板文件等
  2. 使用配置文件来记录要生成的参数和模板文件信息、自定义配置等 元信息
  3. 代码生成器制作工具需要有多种可单独或组合使用的功能，比如从原始文件中抽取参数、动态生成命令行工具、打 jar 包等

关键问题

  1. 如何使用配置文件来记录参数和模板文件信息？何种结构？
  2. 怎么能够提高代码生成器的制作效率？工具应该提供哪些能力？
  3. 如何从原始文件中抽取参数？有哪些类型的参数？有哪些抽取规则？比如布尔类型参数（是否生成）、字符串类型参数（生成指定的值）等

image-20231114000808254

  1. 如何动态生成配置类？如何动态生成命令行工具？如何动态打 jar 包？

第三阶段 - 在线代码生成器平台

经过前两个阶段，我们已经能够使用本地的代码生成器制作工具来快速定制自己的代码生成器了。
但如果我们想和团队其他同学共同维护代码生成器、或者使用其他人的代码生成器，通过本地文件互传的方式肯定就很麻烦了。
所以本阶段我们要打造一个在线代码生成器平台，可以理解为代码生成器的 应用市场。所有人都能发布、使用、甚至是在线制作自己的代码生成器！
本阶段我们的终极目标是，在平台上制作和发布项目 “换皮” 工具，帮助小伙伴们一键给网络热门项目换皮！

业务流程

  1. 获取用于制作代码生成器的原始代码（手动准备或者远程拉取代码）
  2. 开发者基于原始代码，使用 在线代码生成器制作工具，来快速制作代码生成器
  3. 开发者发布代码生成器至平台
  4. 使用者在平台上搜索代码生成器，支持在线使用或者下载离线 jar 包（甚至还可以支持接口调用）、

完整业务流程图如下：

image-20231114001035892

实现思路

  1. 使用 Web 开发框架实现代码生成器信息的增删改查
  2. 将本地的配置和文件 上云，存储到数据库、对象存储等云服务。
  3. 通过可视化界面来操作第二阶段的代码生成器制作工具，复用阶段二的成果。

关键问题

  1. 怎么在云上存储管理代码生成器？
  2. 如何通过前端开发，提高代码生成器的制作效率？
  3. 如何通过后端优化，提高代码生成器的制作性能？
  4. 如何保证代码生成器的存储空间不超限、如何优化存储？

新建代码仓库

搭建仓库，点 star 的都是精神股东

鱼皮仓库：https://github.com/liyupi/yuzi-generator

我的仓库：https://github.com/Shiguang-coding/template-generator

本期作业

  1. 理解代码生成器项目三个阶段的区别，从中学习到拆解项目的思路和方法
  2. 尝试自己做项目时，像鱼皮本篇教程一样编写一个项目设计方案
  3. 思考上述关键问题的实现方案，欢迎大家交流讨论
  4. 在 GitHub 新建仓库（或者 fork 鱼皮的代码仓库），为下期项目开发做准备