ディレクトリ構成と各要素の説明
Spring-generatorはJavaFX 8を用いて開発されたGUIアプリケーションであり、Springフレームワーク向けのプロジェクトコードを迅速に生成することを目的としています。以下に、このツールの基本的なディレクトリ構造とその役割を示します。
Spring-generator/ ├── src │ ├── main │ │ ├── javafx # ユーザーインターフェース部分(JavaFX) │ │ ├── java # アプリケーションのロジック実装クラス │ │ └── resources │ │ └── templates # コード生成用テンプレート(FreeMarker形式) │ └── test # 単体テスト・統合テストコード ├── pom.xml # Mavenによるビルドおよび依存関係管理ファイル ├── README.md # 基本的な使用手順や注意事項の記載 ├── .gitignore # Git管理外とするファイルの指定 └── LICENSE # 使用許諾に関する情報
アプリケーションの起動方法
このツールは主に2つの形式で実行可能です。用途に応じて適切な方法を選択してください。
1. JARファイルとして実行
Mavenコマンドを使用して、実行可能なJARファイルを生成します。
mvn jfx:jar
処理が完了すると、target/jfx/app/ ディレクトリ内に Spring-Generator.jar が作成されます。以下のコマンドで実行できます。
java -jar target/jfx/app/Spring-Generator.jar
2. ネイティブインストーラーとしてビルド
対象OSに合わせたインストールパッケージ(例:Windowsでは.exe、macOSでは.dmg)を作成する場合、次のコマンドを実行します。
mvn jfx:native
ビルド後、プラットフォーム固有のインストーラーが生成され、通常のアプリケーションのようにインストールおよび起動が可能になります。
設定に関する詳細
本ツールの動作は、外部設定ファイルよりもテンプレートと実行時入力に大きく依存しています。
テンプレートファイル(FreeMarker)
コード生成の基盤となるテンプレートは、src/main/resources/templates ディレクトリに格納されています。主なテンプレートには以下が含まれます:
- Entity.ftl:エンティティクラスの雛形
- Dao.ftl:データアクセス層のインターフェース
- Service.ftl:ビジネスロジック層の定義
- Controller.ftl:REST API制御用コントローラー
これらのファイルは自由に編集可能であり、チームのコーディング規約に合わせたカスタマイズが可能です。
データベース接続情報
実際のスキーマからコードを生成するために、アプリケーション起動後にGUI上でデータベース接続情報を入力する必要があります。一般的にはJDBC URL、ユーザ名、パスワードの提供を求められます。一部の環境では、デフォルト値をJavaクラス内にハードコードしたり、環境変数経由で渡すことで初期設定を省略することもできます。
開発環境の前提条件
- JDKバージョン:最低でも1.8.0_66以上(推奨はJava 11以降)
- ビルドツール:Mavenの正しく設定された環境
- 追加要件:JavaFXランタイムが利用可能な状態であること(OpenJDK + OpenJFXなど)
最新のセットアップ手順については、プロジェクト内のREADME.mdを参照することをおすすめします。