Spring-generator 使用指南

Spring-generator 使用指南

1. 项目目录结构及介绍

Spring-generator 是一款基于 JavaFX 8 开发的图形界面工具，旨在快速生成 Spring 项目的代码。以下是项目的基本目录结构及其简要说明：

Spring-generator/
├── src                            # 源代码目录
│   ├── main                        # 主要源码
│       ├── javafx                 # JavaFX 相关的GUI组件
│       ├── java                    # Java业务逻辑代码
│       ├── resources               # 资源文件，包括配置文件、图片、模板等
│           └── templates          # FreeMarker模板存放目录，用于生成代码
│   └── test                        # 测试代码
├── pom.xml                         # Maven构建配置文件
├── README.md                       # 项目说明文档
├── .gitignore                      # Git忽略文件配置
└── LICENSE                         # 许可证信息

2. 项目的启动文件介绍

启动Spring-generator应用有两个主要方法，取决于你需要的是哪种部署形式：

2.1 打包为JAR文件

在项目根目录下执行以下Maven命令来生成可执行的JAR文件：

mvn jfx:jar

完成后，会在 target/jfx/app/ 目录下找到 Spring-Generator.jar。直接双击或通过Java命令行运行：

java -jar target/jfx/app/Spring-Generator.jar

2.2 打包为原生安装程序

同样，在项目根目录执行Maven命令，但这次是打包为对应系统的原生安装包（例如Windows的.exe或Mac的.dmg）：

mvn jfx:native

这将会生成对应平台的应用安装文件，按照提示完成安装后即可启动。

3. 项目的配置文件介绍

Spring-generator的配置更多依赖于FreeMarker模板的设定以及潜在的数据库连接配置。尽管项目本身可能没有一个显式的应用配置文件（如application.properties），其核心配置在于FreeMarker的模板文件夹中的模板设定，这些模板决定了生成代码的结构和风格。

• FreeMarker模板 (src/main/resources/templates)：这里存储了用于生成各种代码片段的FreeMarker模板文件，包括实体类、DAO层、Service层、Controller层等。用户可以根据需要修改这些模板来自定义代码生成的风格。

• 数据库连接：项目运行时可能会要求提供数据库连接信息，这些通常在首次运行或配置阶段以图形界面的形式输入，而不是通过传统的配置文件读取。不过，用户可以通过修改或创建特定的配置类或使用环境变量来预设一些默认的数据库连接信息。

由于项目依赖于外部数据库和Maven的插件进行构建，确保JDK版本符合要求（至少1.8.66，推荐使用更高版本），并且已经正确配置了Maven环境。

请注意，对于更详细的配置细节，建议查阅项目内的官方文档或者README文件，以获取最新和最准确的信息。