spring-boot-application

Spring Boot アプリケーション

目次

• 概要
• 使用する場面
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

Spring の規約に従い、適切なアノテーションベースの設定、依存性注入、REST コントローラー、JPA によるデータ永続化、サービスレイヤー、セキュリティ実装を備えた、本番環境に対応できる Spring Boot アプリケーションを開発します。

使用する場面

• Spring Boot REST API の構築
• サービス指向アーキテクチャの実装
• JPA によるデータ永続化の設定
• 依存性注入の管理
• Spring Security の実装
• Spring Boot によるマイクロサービスの構築

クイックスタート

最小限の動作例：

<project>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.example</groupId>
    <artifactId>api-service</artifactId>
    <version>1.0.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.1.0</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
// ... (see reference guides for full implementation)

リファレンスガイド

references/ ディレクトリにある詳細な実装例：

ガイド	内容
Spring Boot プロジェクトのセットアップ	Spring Boot プロジェクトのセットアップ
JPA アノテーションを使ったエンティティモデル	JPA アノテーションを使ったエンティティモデル
Spring Data JPA を使ったリポジトリレイヤー	Spring Data JPA を使ったリポジトリレイヤー
ビジネスロジックを含むサービスレイヤー	ビジネスロジックを含むサービスレイヤー
リクエスト／レスポンスを処理する REST コントローラー	リクエスト／レスポンスを処理する REST コントローラー
Spring Security の設定	Spring Security の設定
アプリケーションの設定	アプリケーションの設定

ベストプラクティス

✅ 推奨事項

• 疎結合を実現するために依存性注入を使用する
• ビジネスロジックをサービスレイヤーに実装する
• データアクセスにはリポジトリを使用する
• 認証には Spring Security を活用する
• トランザクション管理には @Transactional を使用する
• コントローラーで入力を検証する
• 適切な HTTP ステータスコードを返す
• リクエスト／レスポンスのマッピングには DTO を使用する
• 適切な例外処理を実装する
• 非同期処理には Spring の @Async を使用する

❌ 禁止事項

• ビジネスロジックをコントローラーに記述する
• コントローラーからデータベースに直接アクセスする
• 設定ファイルにシークレットを保存する
• 大規模なリレーションシップに Eager Loading を使用する
• トランザクション境界を無視する
• API レスポンスでデータベースのエンティティを返す
• コントローラーに認証処理を実装する
• パラメーター化クエリを使わずに生の SQL を使用する
• ユーザー入力の検証を怠る