# SpringCodeGenFX

**Repository Path**: toosimple-tools/SpringCodeGenFX

## Basic Information

- **Project Name**: SpringCodeGenFX
- **Description**: 本工具用于从 满足下划线命名风格 的sql建表脚本生成全套增删改查Restful接口，且包括注释和swagger注解。

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-05-18
- **Last Updated**: 2021-04-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpingCodeGenFX介绍

本工具用于从 ***满足下划线命名风格*** 的sql建表脚本生成全套增删改查Restful接口，且包括注释和swagger注解。

## 安装说明

在任意非中文目录下解压SpringCodeGenFX-${version}.zip文件

找到根目录SpringCodeGenFX下的SpringCodeGenFX.exe 右键创建快捷方式，复制快捷方式到适当位置。

## 使用说明
### 1)
双击快捷方式打开SpringCodeGenFX.exe。

![SpringCodeGenFX_doc_0](https://img-blog.csdnimg.cn/20191223132327683.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1bmlvcl9wcm9ncmFtbWVy,size_16,color_FFFFFF,t_70)
新版操作：
![在这里插入图片描述](https://img-blog.csdnimg.cn/20200119215809118.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1bmlvcl9wcm9ncmFtbWVy,size_16,color_FFFFFF,t_70)
### 2)
为了避免提交插件生成的代码文件夹**需要在项目的.gitignore中 添加 \**/sqlgen**，忽略生成代码的文件夹。

### 3)
***自动生成的代码少不了冗余和错漏***，所以没有直接生成到项目的src/main/java路径下。

在当前的目录结构下，只要在Project Structrue设置中将src/main/sqlgen/code加入Module的Sources中即可直接启动项目进行接口功能测试。

测试修改完善代码后转移到按项目规范所属的package。

PS：可使用快捷键Ctrl+Alt+L对生成的代码进行格式自动调整；可使用快捷键Ctrl+Alt+O对多余的import进行自动清理。

![SpringCodeGenFX_doc_1](https://img-blog.csdnimg.cn/2019122313263576.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1bmlvcl9wcm9ncmFtbWVy,size_16,color_FFFFFF,t_70)

![SpringCodeGenFX_doc_2](https://img-blog.csdnimg.cn/20191223132700130.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2p1bmlvcl9wcm9ncmFtbWVy,size_16,color_FFFFFF,t_70)



### 4)
***升级***

低于2.0.1版本需要删除整个安装文件夹
2.0.1以上版本升级只需替换掉SpringCodeGenFX\app下的SpringCodeGenFX-jfx.jar文件

### 5)

***自定义模板***(如无特殊需求，不建议修改模板)

将安装目录SpringCodeGenFX\app\sqlgen文件夹复制到当前设置的工作目录下，按需修改sqlgen/config/templates/win/目录下的ftl文件。

稳定后直接替换SpringCodeGenFX-jfx.jar文件中的sqlgen文件夹即可