Spring Boot Project Creator

概要

Spring Initializr API を使用してゼロから完全に設定された Spring Boot プロジェクトを生成します。このスキルはユーザーをプロジェクトパラメータの選択、アーキテクチャスタイル (DDD またはレイヤーアーキテクチャ) の選択、データストアの設定、ローカル開発用 Docker Compose の設定に導きます。結果は標準化された構造、依存関係管理、設定を備えたビルド準備完了のプロジェクトです。

使用時機

• Spring Boot 3.x または 4.x プロジェクトを標準的な構造で新規ブートストラップする。
• JPA、SpringDoc OpenAPI、Docker Compose を使用してバックエンドマイクロサービスを初期化する。
• DDD (ドメイン駆動設計) またはレイヤー (Controller/Service/Repository/Model) アーキテクチャに従ってプロジェクトをスキャフォールドする。
• PostgreSQL、Redis、および/または MongoDB を Docker Compose で使用してローカル開発インフラを設定する。
• トリガー表現: 「spring boot プロジェクトを作成」、「新しい spring boot アプリ」、「java プロジェクトをブートストラップ」、「spring boot マイクロサービスをスキャフォールド」、「spring boot バックエンドを初期化」、「spring boot プロジェクトを生成」。

前提条件

開始する前に、以下のツールがインストールされていることを確認してください:

• Java Development Kit (JDK): バージョン 17 以上 (Spring Boot 3.x/4.x では Java 21 を推奨)
• Apache Maven: ビルドツール (Spring Initializr はデフォルトで Maven プロジェクトを生成)
• Docker と Docker Compose: ローカルインフラサービスを実行するため
• curl と unzip: Spring Initializr からプロジェクトをダウンロード・抽出するため

手順

新しい Spring Boot プロジェクトを作成するには、以下のステップに従ってください。

1. プロジェクト設定を収集

AskUserQuestion を使用して、ユーザーに以下のプロジェクトパラメータを尋ねます。適切なデフォルト値を提供してください:

パラメータ	デフォルト	オプション
Group ID	com.example	任意の有効な Java パッケージ名
Artifact ID	demo	ケバブケース識別子
Package Name	Group ID と同じ	有効な Java パッケージ
Spring Boot Version	3.4.5	3.4.x、4.0.x (最新については start.spring.io を確認)
Java Version	21	17、21
Architecture	ユーザーの選択	DDD または Layered
Docker Services	ユーザーの選択	PostgreSQL、Redis、MongoDB (複数選択)
Build Tool	maven	maven、gradle

2. Spring Initializr でプロジェクトを生成

curl を使用して start.spring.io からプロジェクトスケルトンをダウンロードします。

ベース依存関係 (常に含まれます):

• web — Spring Web MVC
• validation — Jakarta Bean Validation
• data-jpa — Spring Data JPA
• testcontainers — Testcontainers サポート

条件付き依存関係 (Docker Services 選択に基づく):

• PostgreSQL 選択 → postgresql を追加
• Redis 選択 → data-redis を追加
• MongoDB 選択 → data-mongodb を追加

# Spring Boot 3.4.5 (PostgreSQL のみ) の例
curl -s https://start.spring.io/starter.zip \
  -d type=maven-project \
  -d language=java \
  -d bootVersion=3.4.5 \
  -d groupId=com.example \
  -d artifactId=demo \
  -d packageName=com.example \
  -d javaVersion=21 \
  -d packaging=jar \
  -d dependencies=web,data-jpa,postgresql,validation,testcontainers \
  -o starter.zip

unzip -o starter.zip -d ./demo
rm starter.zip
cd demo

3. 追加依存関係を追加

pom.xml を編集して、SpringDoc OpenAPI と ArchUnit を追加します。

<!-- SpringDoc OpenAPI -->
<dependency>
    <groupId>org.springdoc</groupId>
    <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
    <version>2.8.15</version>
</dependency>

<!-- アーキテクチャテスト用 ArchUnit -->
<dependency>
    <groupId>com.tngtech.archunit</groupId>
    <artifactId>archunit-junit5</artifactId>
    <version>1.4.1</version>
    <scope>test</scope>
</dependency>

4. アーキテクチャ構造を作成

ユーザーの選択に基づいて、src/main/java/<packagePath>/ 配下にパッケージ構造を作成します。

オプション A: レイヤーアーキテクチャ

src/main/java/com/example/
├── controller/        # REST コントローラー (@RestController)
├── service/           # ビジネスロジック (@Service)
├── repository/        # データアクセス (@Repository、Spring Data インターフェース)
├── model/             # JPA エンティティ (@Entity)
│   └── dto/           # リクエスト/レスポンス DTO (Java records)
├── config/            # 設定クラス (@Configuration)
└── exception/         # カスタム例外と @ControllerAdvice

各レイヤーのプレースホルダークラスを作成します:

• config/OpenApiConfig.java — SpringDoc OpenAPI 設定ビーン
• exception/GlobalExceptionHandler.java — @RestControllerAdvice 標準エラーハンドリング
• model/dto/ErrorResponse.java — 標準エラーレスポンスレコード

オプション B: DDD (ドメイン駆動設計) アーキテクチャ

src/main/java/com/example/
├── domain/                 # コアドメイン (フレームワークフリー)
│   ├── model/              # エンティティ、値オブジェクト、集約
│   ├── repository/         # リポジトリインターフェース (ポート)
│   └── exception/          # ドメイン例外
├── application/            # ユースケース / アプリケーションサービス
│   ├── service/            # @Service オーケストレーション
│   └── dto/                # 入出力 DTO (records)
├── infrastructure/         # 外部アダプター
│   ├── persistence/        # JPA エンティティ、Spring Data リポジトリ
│   └── config/             # Spring @Configuration
└── presentation/           # REST API レイヤー
    ├── controller/         # @RestController
    └── exception/          # @RestControllerAdvice

各レイヤーのプレースホルダークラスを作成します:

• infrastructure/config/OpenApiConfig.java — SpringDoc OpenAPI 設定ビーン
• presentation/exception/GlobalExceptionHandler.java — @RestControllerAdvice 標準エラーハンドリング
• application/dto/ErrorResponse.java — 標準エラーレスポンスレコード

5. アプリケーションプロパティを設定

src/main/resources/application.properties を作成して、選択したサービスを設定します。

常に含まれる設定:

# Application
spring.application.name=${artifactId}

# SpringDoc OpenAPI
springdoc.swagger-ui.doc-expansion=none
springdoc.swagger-ui.operations-sorter=alpha
springdoc.swagger-ui.tags-sorter=alpha

PostgreSQL が選択された場合:

# PostgreSQL / JPA
spring.datasource.driver-class-name=org.postgresql.Driver
spring.datasource.url=jdbc:postgresql://localhost:5432/${POSTGRES_DB:postgres}
spring.datasource.username=${POSTGRES_USER:postgres}
spring.datasource.password=${POSTGRES_PASSWORD:changeme}
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.format_sql=true

Redis が選択された場合:

# Redis
spring.data.redis.host=localhost
spring.data.redis.port=6379
spring.data.redis.password=${REDIS_PASSWORD:changeme}

MongoDB が選択された場合:

# MongoDB
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=${MONGO_USER:root}
spring.data.mongodb.password=${MONGO_PASSWORD:changeme}
spring.data.mongodb.database=${MONGO_DB:test}

6. Docker Compose をセットアップ

プロジェクトルートに docker-compose.yaml を作成し、ユーザーが選択したサービスのみを含めます。

services:
  # PostgreSQL が選択された場合は含める
  postgresql:
    image: postgres:17
    ports:
      - "5432:5432"
    environment:
      POSTGRES_USER: ${POSTGRES_USER:-postgres}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-changeme}
      POSTGRES_DB: ${POSTGRES_DB:-postgres}
    volumes:
      - ./postgres_data:/var/lib/postgresql/data

  # Redis が選択された場合は含める
  redis:
    image: redis:7
    ports:
      - "6379:6379"
    command: redis-server --requirepass ${REDIS_PASSWORD:-changeme}
    volumes:
      - ./redis_data:/data

  # MongoDB が選択された場合は含める
  mongodb:
    image: mongo:8
    ports:
      - "27017:27017"
    environment:
      MONGO_INITDB_ROOT_USERNAME: ${MONGO_USER:-root}
      MONGO_INITDB_ROOT_PASSWORD: ${MONGO_PASSWORD:-changeme}
    volumes:
      - ./mongo_data:/data/db

7. Docker Compose 用の .env ファイルを作成

プロジェクトルートに .env ファイルを作成し、ローカル開発用のデフォルト認証情報を設定します:

# PostgreSQL
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changeme
POSTGRES_DB=postgres

# Redis
REDIS_PASSWORD=changeme

# MongoDB
MONGO_USER=root
MONGO_PASSWORD=changeme
MONGO_DB=test

ユーザーが選択したサービスの変数のみを含めます。Docker Compose は自動的にこのファイルをロードします。

8. .gitignore を更新

Docker Compose ボリュームディレクトリと .env ファイルを .gitignore に追加します:

# Docker Compose
.env
postgres_data/
redis_data/
mongo_data/

9. ビルドを検証

Maven ビルドを実行してプロジェクトがコンパイルされテストが成功することを確認します:

./mvnw clean verify

ビルドが成功した場合はユーザーに通知します。失敗した場合は、進める前に問題を診断し修正します。

10. ユーザーにサマリーを表示

作成されたプロジェクトのサマリーを表示します:

Project Created Successfully

  Artifact:      <artifactId>
  Spring Boot:   <version>
  Java:          <javaVersion>
  Architecture:  <DDD | Layered>
  Build Tool:    Maven
  Docker:        <services list>

  Directory:     ./<artifactId>/

  Next Steps:
    1. cd <artifactId>
    2. docker compose up -d
    3. ./mvnw spring-boot:run
    4. Open http://localhost:8080/swagger-ui.html

アーキテクチャパターン

レイヤーアーキテクチャ

関心の明確な分離を備えた従来の三層アーキテクチャ:

レイヤー	パッケージ	責務
Presentation	controller/	HTTP エンドポイント、リクエスト/レスポンスマッピング
Business	service/	ビジネスロジック、トランザクション管理
Data Access	repository/	Spring Data を通じたデータベース操作
Domain	model/	JPA エンティティと DTO

最適な用途: シンプルな CRUD アプリケーション、小～中規模サービス、Spring Boot が初めてのチーム。

DDD アーキテクチャ

ドメイン駆動設計と六角形アーキテクチャ:

レイヤー	パッケージ	責務
Domain	domain/	エンティティ、値オブジェクト、ドメインサービス (フレームワークフリー)
Application	application/	ユースケース、オーケストレーション、DTO マッピング
Infrastructure	infrastructure/	JPA アダプター、外部統合、設定
Presentation	presentation/	REST コントローラー、エラーハンドリング

最適な用途: 複雑なビジネスドメイン、豊富なロジックを持つマイクロサービス、長期運用プロジェクト。

例

例 1: PostgreSQL を使用したシンプル REST API (レイヤーアーキテクチャ)

ユーザーリクエスト: 「PostgreSQL を使用した REST API 用 Spring Boot プロジェクトを作成」

curl -s https://start.spring.io/starter.zip \
  -d type=maven-project \
  -d bootVersion=3.4.5 \
  -d groupId=com.example \
  -d artifactId=my-api \
  -d packageName=com.example.myapi \
  -d javaVersion=21 \
  -d dependencies=web,data-jpa,postgresql,validation,testcontainers \
  -o starter.zip

結果: controller/、service/、repository/、model/ パッケージを備えたレイヤープロジェクト、PostgreSQL Docker Compose、SpringDoc OpenAPI。

例 2: DDD と複数ストアを使用したマイクロサービス

ユーザーリクエスト: 「DDD、PostgreSQL、Redis を使用した Spring Boot 3 マイクロサービスをブートストラップ」

curl -s https://start.spring.io/starter.zip \
  -d type=maven-project \
  -d bootVersion=3.4.5 \
  -d groupId=com.acme \
  -d artifactId=order-service \
  -d packageName=com.acme.order \
  -d javaVersion=21 \
  -d dependencies=web,data-jpa,postgresql,data-redis,validation,testcontainers \
  -o starter.zip

結果: domain/、application/、infrastructure/、presentation/ パッケージを備えた DDD プロジェクト、PostgreSQL + Redis Docker Compose、SpringDoc OpenAPI。

ベストプラクティス

• 常に Spring Initializr を使用 してプロジェクトを生成し、正確な依存関係管理と親 POM を取得します。
• DTO には Java records を使用 — 不変であり簡潔です。
• DDD アーキテクチャでドメインレイヤーをフレームワークフリーに保つ — domain/ に Spring アノテーションを含めないでください。
• 本番環境では環境変数を使用 してセンシティブな設定 (データベースパスワードなど) を管理してください。
• Docker Compose の Docker イメージバージョンをピン留め して予期しない破壊的変更を回避します。
• セットアップ後に ./mvnw clean verify を実行 してすべてがコンパイルされテストが成功することを確認します。
• Docker Compose の代わりに Testcontainers を使用 して統合テストを実行してください。

制約と警告

• Spring Initializr はインターネットアクセスが必要です — このスキルはオフラインで動作できません。
• Spring Boot 4.x の利用可能性は現在のリリースサイクルに依存します — 最新バージョンについて start.spring.io を確認してください。
• Docker Compose 認証情報は .env ファイルからロードされます (git-ignore) — シークレットをバージョン管理にコミットしないでください。
• spring.jpa.hibernate.ddl-auto=update 設定は開発専用です — 本番環境では Flyway または Liquibase を使用してください。
• ArchUnit バージョンは Spring Boot にバンドルされている JUnit 5 バージョンと互換性がある必要があります。