コンテンツにスキップ

プロジェクトの雛型作成⚓︎

Spring Initializr の利用⚓︎

各 Gradle Groovy DSL プロジェクトの雛型は、 Spring Initializr を利用して作成します。 Spring Initializr は Spring Boot を利用するプロジェクトの雛型を簡潔に作成できるツールです。 Web サービス を利用する方法や、各種 IDE にプラグインや拡張機能を導入することで IDE 上でも利用できます。 Visual Studio Code の場合、 Spring Boot Extension Pack が導入済みであれば利用できます。

ここでは Web サービスでの作成を前提に説明します。

ルートプロジェクトの作成⚓︎

ルートプロジェクトの雛型を Spring Initializr を利用して作成します。 Web 画面上の各種設定項目は以下の通りです。

  • Project

    プロジェクトのビルドツールを Gradle - Groovy 、 Gradle - Kotlin 、 Maven から選択します。 AlesInfiny Maia OSS Edition ではデフォルトのビルドツールを Gradle Groovy DSL としているため、　Spring Initializr では Gradle - Groovy を選択しています。 以降の説明でも Gradle - Groovy でビルドすることを前提として解説していますが、 Gradle - Kotlin や Maven も選択できます。

  • Language

    開発言語として Java を選択します。

  • Spring Boot

    利用する Spring Boot のバージョンを選択します。 ベースとなる JDK や Spring Framework のバージョンを考慮して選択します。 特に考慮点がなければ最新の GA 版を選択することを推奨します。 選択できる Spring Boot のバージョンは、 OSS サポート期限内のバージョン に限られ、古いバージョンは指定できません。

  • Project Metadata：Artifact

    プロジェクトの基点のフォルダー名となるプロジェクト名を設定します。

  • Project Metadata : Java

    利用する環境の Java のバージョンを選択します。

  • Project Metadata：その他

    ルートプロジェクトの雛型作成では設定不要 ( 任意 ) です。

  • Dependencies

    各サブプロジェクト全体で利用するパッケージがあれば登録します。 本ガイドでは後続手順の プロジェクトの共通設定 にて追加するため設定不要 ( 任意 ) です。

サブプロジェクトの作成⚓︎

ルートプロジェクトと同様に、サブプロジェクトの雛型を Spring Initializr を利用して作成します。 AlesInfiny Maia OSS Edition では、アプリケーションコア層、プレゼンテーション層、インフラストラクチャ層の各層およびシステム共通機能を 1 つのサブプロジェクトとして対応させることを推奨します。

推奨するサブプロジェクト 推奨するサブプロジェクト

以下、サブプロジェクト毎に異なる設定項目について説明します。 その他の項目はルートプロジェクトと同様に設定してください。

  • Project Metadata：Group

    対象プロジェクトが含まれるグループ名を設定します。 対象プロジェクトのパッケージ名は、このグループ名から始まることが想定されます。 ハイフンなど、パッケージ名に利用不可の文字を指定した場合、パッケージ名としては取り除かれますが、元々使わないことが望ましいです。

  • Project Metadata：Artifact

    サブプロジェクトの基点のフォルダー名となるプロジェクト名を設定します。

  • Project Metadata：Name

    アプリケーション名を設定します。 この名前は Spring Boot 実行クラス ( Main クラス ) のクラス名やパッケージした際の war や jar 名に利用されます。

  • Project Metadata：Package Name

    パッケージ名を設定します。 通常変更の必要はありませんが、 Artifact 名にハイフンを利用している場合は、自動入力されているパッケージ名からハイフンを削除してください。例えば、 com.example.application-core というパッケージ名であれば、 com.example.applicationcore のように修正してください。

  • Dependencies

    プロジェクトで利用するパッケージがあれば設定します。 本ガイドでは後続手順の サブプロジェクトの個別設定 にて追加するため設定不要 ( 任意 ) です。

ルートプロジェクトとサブプロジェクトの配置⚓︎

ルートプロジェクトと各サブプロジェクトの雛型を作成したら、 これらを展開し適切に配置します。

各雛型は zip 形式で生成されるため、まずは全ての雛型を展開します。 次にルートプロジェクト内の src フォルダーを削除します。 その後、ルートプロジェクトのフォルダー直下に各サブプロジェクトのフォルダーを配置します。 これらの手順を行った後のフォルダーの構成は以下の通りです。

SpringBootプロジェクトのフォルダー構成 SpringBootプロジェクトのフォルダー構成