Spring Boot ベストプラクティス

確立されたベストプラクティスに従い、高品質な Spring Boot アプリケーションの開発をお手伝いするのが目標です。

プロジェクトセットアップ & 構造

• ビルドツール: 依存関係管理に Maven (pom.xml) または Gradle (build.gradle) を使用してください。
• スターター: Spring Boot スターター (例: spring-boot-starter-web、spring-boot-starter-data-jpa) を使用して、依存関係管理をシンプルにしてください。
• パッケージ構成: コードはレイヤー (例: com.example.app.controller、com.example.app.service) ではなく、機能/ドメイン (例: com.example.app.order、com.example.app.user) で整理してください。

依存性の注入 & コンポーネント

• コンストラクタインジェクション: 必須の依存関係には常にコンストラクタベースのインジェクションを使用してください。これによってコンポーネントがテストしやすくなり、依存関係が明示的になります。
• イミュータビリティ: 依存関係フィールドを private final で宣言してください。
• コンポーネントステレオタイプ: @Component、@Service、@Repository、@Controller/@RestController アノテーションを適切に使用して bean を定義してください。

設定

• 外部化設定: 設定には application.yml (または application.properties) を使用してください。YAML は読みやすさと階層構造のため、しばしば推奨されます。
• 型安全なプロパティ: @ConfigurationProperties を使用して、設定を厳密に型指定された Java オブジェクトにバインドしてください。
• プロファイル: Spring Profiles (application-dev.yml、application-prod.yml) を使用して、環境固有の設定を管理してください。
• シークレット管理: シークレットをハードコーディングしないでください。環境変数を使用するか、HashiCorp Vault や AWS Secrets Manager のような専用のシークレット管理ツールを使用してください。

Web レイヤー (コントローラー)

• RESTful API: 明確で一貫性のある RESTful エンドポイントを設計してください。
• DTO (データ転送オブジェクト): API レイヤーでデータを公開・消費する際には DTO を使用してください。JPA エンティティをクライアントに直接公開しないでください。
• バリデーション: Java Bean Validation (JSR 380) とアノテーション (@Valid、@NotNull、@Size) を DTO に使用して、リクエストペイロードを検証してください。
• エラーハンドリング: @ControllerAdvice と @ExceptionHandler を使用してグローバル例外ハンドラーを実装し、一貫したエラーレスポンスを提供してください。

サービスレイヤー

• ビジネスロジック: すべてのビジネスロジックを @Service クラスにカプセル化してください。
• ステートレス性: サービスはステートレスであるべきです。
• トランザクション管理: サービスメソッドに @Transactional を使用して、データベーストランザクションを宣言的に管理してください。必要最小限の粒度で適用してください。

データレイヤー (リポジトリ)

• Spring Data JPA: JpaRepository または CrudRepository を拡張して Spring Data JPA リポジトリを使用し、標準的なデータベース操作を行ってください。
• カスタムクエリ: 複雑なクエリの場合は、@Query または JPA Criteria API を使用してください。
• プロジェクション: DTO プロジェクションを使用して、データベースから必要なデータのみを取得してください。

ログ記録

• SLF4J: ログにはSLF4J API を使用してください。
• ロガー宣言: private static final Logger logger = LoggerFactory.getLogger(MyClass.class);
• パラメータ化ログ: 文字列連結ではなく、パラメータ化メッセージ (logger.info("Processing user {}...", userId);) を使用してパフォーマンスを向上させてください。

テスト

• ユニットテスト: JUnit 5 と Mockito のようなモッキングフレームワークを使用して、サービスとコンポーネントのユニットテストを作成してください。
• 統合テスト: @SpringBootTest を使用して、Spring アプリケーションコンテキストをロードする統合テストを行ってください。
• テストスライス: @WebMvcTest (コントローラー用) や @DataJpaTest (リポジトリ用) などのテストスライスアノテーションを使用して、アプリケーションの特定部分を分離してテストしてください。
• Testcontainers: 実際のデータベース、メッセージブローカーなどを使用した信頼性の高い統合テストのために、Testcontainers の使用を検討してください。

セキュリティ

• Spring Security: 認証と認可に Spring Security を使用してください。
• パスワードエンコード: BCrypt のような強力なハッシュアルゴリズムを使用して、常にパスワードをエンコードしてください。
• 入力サニタイズ: Spring Data JPA またはパラメータ化クエリを使用して SQL インジェクションを防止してください。出力を適切にエンコードして、クロスサイトスクリプティング (XSS) を防止してください。