Java Quarkus 開発のベストプラクティス

コアプリンシパル

• Quarkus のベストプラクティスに従い、クリーンで効率的、かつよく文書化された Java コードを記述する
• GraalVM ネイティブビルドによる高速スタートアップと最小限のメモリフットプリントに注力する
• 一般的な機能には Quarkus エクステンションを活用する
• コンテナ化とサーバーレス デプロイメント用に設計する
• SOLID 原則とマイクロサービスアーキテクチャパターンに従う

開発ワークフロー

Quarkus Dev モード

• ライブリロード機能を備えた高速反復開発には quarkus dev を使用する
• 開発中に継続的テストを活用する
• デバッグと設定検査には Dev UI を使用する
• ローカル開発用の Dev Services を活用する

設定

タイプセーフな設定

• タイプセーフな設定インジェクションには @ConfigProperty を使用する
• @ConfigMapping インターフェースで関連設定をグループ化する
• スタートアップ時に設定を検証する
• 設定プロパティをドキュメント化する

プロファイルベースの設定

• 環境固有の設定には %dev、%test、%prod プレフィックスを使用する
• 本番環境では環境変数で設定をオーバーライドする
• ソースコントロール内に機密値を保持しない
• ローカル開発用に .env ファイルを使用する

依存性注入

CDI アノテーション

• 依存性注入には @Inject を使用する
• 実装の修飾には @Named を使用する
• @Singleton、@ApplicationScoped、@RequestScoped を適切に使用する
• 必須の依存性にはコンストラクタインジェクションを優先する

Bean ディスカバリー

• Quarkus ビルド時 bean ディスカバリーを理解する
• 条件付き bean には @IfBuildProfile を使用する
• ネイティブビルド用にリフレクション多用パターンを回避する

REST API 開発

RESTEasy Reactive

• エンドポイント定義には @Path、@GET、@POST などを使用する
• 適切な HTTP ステータスコードを返す
• 入力検証には @Valid を使用する
• 一貫したエラーレスポンス用に例外マッパーを実装する

リアクティブパターン

• リアクティブプログラミングには Mutiny を使用する
• 非同期操作には Uni と Multi を活用する
• 必要に応じてリアクティブと命令型コードを結合する

データアクセス

Hibernate ORM with Panache

• 簡略化された JPA パターンに Panache を使用する
• Active Record またはリポジトリパターンを活用する
• 組み込み操作には PanacheEntity を使用する
• find と list メソッドでカスタムクエリを実装する

データベース操作

• マイグレーションに Flyway または Liquibase を使用する
• Agroal でコネクションプーリングを設定する
• ノンブロッキング I/O には反応型データベースクライアントを使用する

テスト

JUnit 5 統合

• 統合テストには @QuarkusTest を使用する
• ネイティブイメージテストには @QuarkusIntegrationTest を使用する
• 異なる設定用にテストプロファイルを活用する

REST エンドポイントテスト

• エンドポイントテストには rest-assured を使用する
• 成功とエラーの両シナリオをテストする
• レスポンスボディとステータスコードを検証する
• 認証と認可をテストする

パフォーマンス最適化

ネイティブイメージ最適化

• 本番環境用に GraalVM でネイティブイメージをビルドする
• 開発中に定期的にネイティブビルドをテストする
• 必要に応じて @RegisterForReflection を使用する
• リフレクションの使用を最小化する

メモリとスタートアップ

• コンテナ内のメモリ使用量を監視する
• サーバーレス コールドスタート用に最適化する
• 適切な箇所で遅延初期化を使用する

観測性

ヘルスチェック

• liveness および readiness プローブに MicroProfile Health を使用する
• 依存関係の カスタムヘルスチェックを実装する
• ヘルスエンドポイントに基づいて Kubernetes プローブを設定する

メトリクス

• アプリケーションメトリクスに MicroProfile Metrics を使用する
• メトリクスを Prometheus 形式でエクスポートする
• ビジネス操作用にカスタムメトリクスを追加する

分散トレーシング

• OpenTracing/OpenTelemetry 統合を使用する
• サービス間でトレースコンテキストを伝播させる
• 本番環境用にサンプリングを適切に設定する

セキュリティ

• Quarkus Security エクステンションを使用する
• OIDC または JWT での認証を実装する
• Web クライアント用に CORS を設定する
• すべての入力を検証およびサニタイズする
• 本番環境では HTTPS を使用する

コンテナ化

• Quarkus コンテナイメージ エクステンションを使用する
• ネイティブイメージ用にマルチステージ Dockerfile をビルドする
• リソース制限を適切に設定する
• distroless または最小限のベースイメージを使用する