# PUPA-代码生成器
**Repository Path**: nimang/pupa
## Basic Information
- **Project Name**: PUPA-代码生成器
- **Description**: 一款基于数据库表生成各种语言代码的在线代码生成器；支持多种模板语言，支持多数据源；高自由度自定义扩展参数，良好的参数查看交互，良好的在线模板编辑交互；具备多项目管理、团队化管理功能，助力约束团队内代码规范；所有配置均在线可调，即时生效。
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 26
- **Forks**: 8
- **Created**: 2023-10-08
- **Last Updated**: 2025-07-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: 程序开发, 代码生成器, 模板
## README
## PUPA
#### 蛹，蜕变的开始
一款基于数据库，通过在线模板生成内容的代码生成工具，具备多项目管理、团队化管理、多数据源管理、自定义配置等功能。
#### 演示地址
出于数据安全考虑，演示地址admin账号不对外开放，可通过注册账号进行体验，注册信息仅需用户名密码，不涉及敏感信息。
http://pupa.nimang.org.cn
## PUPA介绍
环境、框架、组件：
> - JDK版本：JDK 1.8
> - 数据库：Mysql 5.7.3
> - 框架：Spring-boot-web
> - 登录控制：sa-token 1.34.0
> - 前端UI框架：Layuimini 2.5.5 单页模式（jQuery + Html5）
> - 编辑器控件：Monaco Editor
特点：
> - 平台化，可管理多个项目，一次部署长期使用
> - 轻量级，mvc单体项目结构，无需依赖额外环境，部署更简单
> - 支持团队内共享，规范代码
> - 支持多数据源，支持多种类型数据库（Mysql、Maria、SqlServer、Oracle、PostgreSql，支持扩展）
> - 支持多种模板引擎（Enjoy、Freemarker、Vilocity，支持扩展）
> - 支持同时生成多语言数据类型映射，如同时生成匹配Java和TypeScript数据类型的代码
> - 在线模板编辑器使用Monaco控件，使用体验同Visual Studio Code相差无几
> - 支持在项目、成员、数据源、表、字段等维度进行自定义参数的扩展配置，即配即用
> - 可用参数随时查看，清晰了然
> - 可直接克隆项目、配置，快速个性化定制
> - 支持项目、配置导入导出，移植无压力
## 部署
> 1. 确保服务器已安装 Java 1.8+、Mysql 数据库，在数据库内运行项目目录下的 resources/sql/pupa.sql 初始化数据；
> 2. 修改项目配置文件 resources/application.yml 中的 datasource 数据库连接配置；
> 3. 构建项目；
> 4. 复制项目目录下的 target/pupa-1.0-SNAPSHOT.java 到服务器自定目录；
> 5. 至此可直接通过服务器指令启动服务，也可使用提供的脚本启动运行，操作如下：
>> 1. 修改jar文件名为 pupa.jar；
>> 2. 复制项目目录下的 resources/run/start.sh 到服务器，与jar文件同一目录；
>> 3. 进入服务器项目目录，执行 ./start.sh 命令启动项目，如 start.sh 未授权，则执行 chmod u+x start.sh 命令进行授权，再启动项目；
>> 4. 在浏览器输入实际项目地址进行访问，例：http://192.168.0.1:7384。
> 默认管理员账号、密码： admin 123456
## 功能说明
### 系统结构
### 项目管理
#### 项目
展示用户创建或加入的所有项目，可添加新项目，对已有项目进行操作。
> - **添加**：创建新项目
> - **导出全部**：导出所有权属项目至数据文件，含关联配置
> - **导出选中**：导出选中的项目至数据文件，含关联配置
> - **导入**：将数据文件导入为可操作数据，导入项目的所有者为当前用户
> - **编辑**：修改项目相关信息及扩展配置，仅项目所有者可用
> - **删除**：删除整个项目，包括成员、数据源、表单、字段等内容，谨慎使用，仅项目所有者可用
> - **成员**：项目成员管理，添加、删除项目成员，修改相关扩展配置
> - **数据源**：添加源数据库，同一项目内可添加多个数据源
> - **拷贝**：快速拷贝当前项目，新项目所有者为当前用户，对新项目的操作不影响原有项目
创建项目时必须选择一个配置，可选配置包括公共配置和用户自己的私有配置，均可在“配置管理”中进行维护；
#### 成员
> - **管理**：项目所有者为项目管理授权用户，可选用户为所有非当前项目成员的注册用户，被添加的用户将获得本项目的相关权限，仅项目所有者可用
> - **编辑**：可修改署名及扩展配置，署名默认为注册时的用户名，建议及时修改
> - **删除**：删除成员，除去此成员对于本项目的相关权属，仅项目所有者可用
> - **转让**：将本项目所有权转让给指定成员，转让成功后，原所有者将立即剔除对本项目的相应管理权限，谨慎使用，仅项目所有者可用
#### 数据源
> - **添加**：添加数据源，用于连接目标数据库，仅项目所有者可用
> - **编辑**：修改数据源配置信息，仅项目所有者可用
> - **删除**：删除数据源，包括表单、字段等内容，谨慎使用，仅项目所有者可用
> - **库表**：通过数据库获取表、字段数据，进行代码生成操作，字段查阅等
维护数据源信息时，根据所选数据库，需要额外配置数据类型映射，默认采用系统预设的映射关系，如需要添加新的映射项，可登录管理员账号，在数据映射管理中进行设置。
由于是通过读取数据库的信息库获取表、字段信息，因此在数据源中填写的数据库用户必须拥有足够的权限，否则无法同步数据。
#### 库表
> - **添加**：手动添加表，暂不支持sql生成，仅项目所有者可用
> - **编辑**：手动编辑表，修改扩展配置，仅项目所有者可用
> - **删除**：删除表，包括下属关联字段，谨慎使用，仅项目所有者可用
> - **数据同步**：通过数据源配置，连接数据库，将数据库上的表、字段数据同步至系统，仅项目所有者可用
> - **生成全部**：根据配置，生成当前数据源下属所有表的代码，压缩为zip并下载
> - **生成选中**：根据配置，生成选中表的代码，压缩为zip并下载
> - **字段**：查看当前表的下属字段
> - **预览**：预览当前表生成的代码
数据同步时，只会将上游数据库的数据同步至系统，不做逆向同步，不会影响数据库原有内容；获取的数据根据表名、字段名匹配，对系统中不存在的数据执行新增操作，对系统中已存在的同名数据执行修改操作（不覆盖扩展配置内容），对于系统中存在而数据源中不存在的数据，将此数据的“是否存在于数据库”一列设置为“不存在”。
首次打开预览界面时，由于下载Monaco控件需要些许时间，可能无法正常展示，多刷新几次或返回上一级再进入一般就可以正常显示。
#### 字段
> - **添加**：手动添加字段，仅项目所有者可用
> - **编辑**：手动编辑字段，修改扩展配置，仅项目所有者可用
> - **删除**：删除字段，仅项目所有者可用
项目、成员、数据源、表单、字段均可设置扩展配置，扩展配置项在“配置管理>扩展”中进行维护，扩展配置作为自定义参数，可在模板中的使用。
### 配置管理
#### 配置
> - **添加**：创建新配置
> - **导出全部**：导出所有权属配置至数据文件
> - **导出选中**：导出选中的配置至数据文件
> - **导入**：将数据文件导入为可操作数据，导入配置的所有者为当前用户
> - **编辑**：修改配置，可变更当前设置的所有者，仅配置所有者可用
> - **删除**：删除整个配置，包括扩展、模板等内容，谨慎使用，仅配置所有者可用
> - **映射**：维护数据库列与指定语言的属性类型映射关系
> - **扩展**：扩展配置管理
> - **模板**：模板管理
> - **拷贝**：快速拷贝当前配置，新配置所有者为当前用户，对新配置的操作不影响原有配置
#### 映射
> - **添加**：添加映射配置项，仅配置所有者可用
> - **编辑**：编辑映射配置项，仅配置所有者可用
> - **删除**：删除映射配置项，仅配置所有者可用
映射配置，支持不同数据库对不同程序语言的数据类型映射配置。
生成代码时将根据所选语言进行数据类型映射。
#### 扩展
> - **添加**：添加扩展配置项，仅配置所有者可用
> - **编辑**：编辑扩展配置项，仅配置所有者可用
> - **删除**：删除扩展配置项，仅配置所有者可用
扩展配置可满足用户添加自定义参数的需求，应用于模板维护中，生成代码时将根据项目中的具体配置填入模板的相应位置。
扩展配置根据作用域进行区分，分别作用于项目、成员、数据源、表单、字段等维度。
#### 模板
> - **添加**：添加模板，仅配置所有者可用
> - **编辑**：编辑模板，仅配置所有者可用
> - **删除**：删除模板，仅配置所有者可用
> - **查看**：非配置所有者不可编辑模板，但可查看
模板名称不影响代码生成，文件生成地址允许使用模板，必需与选择的模板引擎一致，生成的文件将根据填写的地址进行命名，因此生成地址必须末尾必须指定文件名及文件类型，且同一个配置中，不允许存在多个生成地址相同的模板。
错误示例：business/controller/#(table.classNameUp)Controller
正确示例：business/controller/#(table.classNameUp)Controller.java
系统集成了主流的三种模板引擎，即Enjoy、Freemarker、Vilocity，可根据自己的喜好选择，允许不同模板分别采用不同的模板语言，但同一模板内不允许混用多种模板语言。
Monaco Editor 编辑器根据所选语言调整代码规范，生成代码时将根据所选语言进行数据类型映射，为了更好的编辑体验，也为了数据类型映射的准确性，请务必选择正确的语言。
编辑模板时，可通过左侧“参数”按钮查看所有可用参数，参数根据作用域分块展示，并用不同颜色标识系统
内置参数及自定义扩展配置，可点击参数快速复制。
### 列类型管理
仅管理员可用，维护不同数据库中的常用列类型，用于配置映射关系时，根据指定库获取列类型清单并维护与程序语言的映射关系。
### 人员管理
仅管理员可用，管理系统用户，可进行手动添加新用户，重置用户密码，启用、禁用账户等操作。
## 规范
获取表、字段数据时，系统会进行一些加工处理，如获取表名、字段名、字段注释、关联枚举、字段取值限制等，为了使获取的数据更加统一，建议遵循以下数据库设计规范：
> 1. 字符串类型字段建议标明长度，默认填充空字符；
> 2. 整数类型建议标明长度，如不可能为负数，则设置为无符号，默认0；
例：int 4 即表示取值范围为-9999—9999，设置为无符号后表示取值范围为0—9999
> 3. 浮点类型建议标明长度、精度，如不可能为负数，则设置为无符号，默认0；
例：decimal 4,2 即表示取值范围为-99.99—99.99，设置为无符号后表示取值范围为0.00—99.99
> 4. ★ 表注释、字段注释必填；
> 5. ★ 表注释格式为“所属模块/.../表中文名”，如不设置模块，可直接填写表中文名；
例：门户中心/账户管理/用户信息
> 6. ★ 字段注释格式为“[字段中文名]{枚举类名}额外说明”，如没有枚举及额外说明，可不加“[ ]”直接填写字段中文名；
例：[类型]{ProConfigTypeEnum}0:公共,1:私人
> 7. 本规范适用于mysql、maria数据库，其它品牌数据库视其规则调整；
## 扩展
### 编辑器语言
- Monaco Editor 编辑器目前只添加了部分常用语言，如需扩展，需改动项目中的枚举类：
com/jinyuan/pupa/common/enums/proTemp/ProTempLangEnum.java
- 可参考以下目录内容添加相应语言的枚举项：
static/js/monaco/vs/basic-languages
### 数据库
PUPA目前支持Mysql、MariaDB、SqlServer、Oracle、PostgreSql等数据库，可根据需求自行添加对其它数据库的扩展，方式如下：
- 在 pom.xml 中引入相应数据库驱动依赖；
- 在 com/jinyuan/pupa/dbExtends 创建相应数据库包，如mysql；
- 在包内添加相应的表、列数据对象entity及mapper，添加 service 实现类，必须实现 IMetadataService.java；
- 在 resources/mapper 中添加相应数据映射文件；
- 在 DatasourceBrandEnum.java 中添加相应枚举数据；
### 模板引擎
- 在 pom.xml 中引入相应模板引擎依赖；
- 在 com/jinyuan/pupa/common/tool/render 中添加相应render渲染类，该类必须继承 Render.java，并实现其抽象方法；
- 修改 com/jinyuan/pupa/common/enums/proTemp/ProTempTypeEnum.java，添加相应枚举项；
- 修改 com/jinyuan/pupa/business/service/impl/BizGenServiceImpl.java，在 getRenderMap 方法中，初始化渲染类，并添加进map；
