Spring Boot RESTful API Reviewer

Description

Spring Boot 3.5系を使用したRESTful APIプロジェクトの包括的なコードレビューを支援するスキルです。プロジェクトで使用されているStarterを自動検出し、適切なベストプラクティスに基づいてレビューを実施します。

Trigger Conditions

以下のいずれかに該当する場合、このスキルを使用してください:

• ユーザーがSpring BootプロジェクトのレビューやCode reviewを依頼した場合
• pom.xmlまたはbuild.gradleファイルがアップロードされ、Spring Boot関連の分析が必要な場合
• RESTful API、Spring MVC、Spring Data JPA、Spring Securityなどのコードレビューを依頼された場合
• Spring Bootアプリケーションのベストプラクティス確認を求められた場合
• 「Spring Bootのコードをチェックして」「APIのレビューして」などの依頼

Core Workflow

1. プロジェクト構成の検出

まず、プロジェクトで使用されているStarterを検出します:

# pom.xml、build.gradle、またはbuild.gradle.ktsを読み込んで依存関係を抽出
detect_starters() {
    local build_file="$1"
    # シェルスクリプトで実装
}

または

# pom.xml、build.gradle、またはbuild.gradle.ktsを読み込んで依存関係を抽出
def detect_starters(build_file_content):
    """
    ビルドファイルからSpring Boot Starterを検出
    
    Returns:
        dict: {
            'validation': bool,
            'jpa': bool,
            'postgresql': bool,
            'redis': bool,
            'security': bool,
            'actuator': bool,
            'test': bool,
            'version': str  # Spring Bootのバージョン (例: 3.5.2)
        }
    """
    starters = {
        'validation': False,
        'jpa': False,
        'postgresql': False,
        'redis': False,
        'security': False,
        'actuator': False,
        'test': False,
        'version': None
    }
    
    # Maven (pom.xml) の場合
    if '<dependencies>' in build_file_content:
        starters['validation'] = 'spring-boot-starter-validation' in build_file_content
        starters['jpa'] = 'spring-boot-starter-data-jpa' in build_file_content
        starters['postgresql'] = 'postgresql' in build_file_content
        starters['redis'] = 'spring-boot-starter-data-redis' in build_file_content
        starters['security'] = 'spring-boot-starter-security' in build_file_content
        starters['actuator'] = 'spring-boot-starter-actuator' in build_file_content
        starters['test'] = 'spring-boot-starter-test' in build_file_content
        
        # バージョン検出
        import re
        version_match = re.search(r'<spring-boot\.version>([^<]+)</spring-boot\.version>', build_file_content)
        if not version_match:
            version_match = re.search(r'<version>([^<]+)</version>', build_file_content)
        if version_match:
            starters['version'] = version_match.group(1)
    
    # Gradle (build.gradle / build.gradle.kts) の場合
    else:
        starters['validation'] = 'spring-boot-starter-validation' in build_file_content
        starters['jpa'] = 'spring-boot-starter-data-jpa' in build_file_content
        starters['postgresql'] = 'postgresql' in build_file_content
        starters['redis'] = 'spring-boot-starter-data-redis' in build_file_content
        starters['security'] = 'spring-boot-starter-security' in build_file_content
        starters['actuator'] = 'spring-boot-starter-actuator' in build_file_content
        starters['test'] = 'spring-boot-starter-test' in build_file_content
        
        # バージョン検出
        import re
        version_match = re.search(r"springBootVersion\s*=\s*['\"]([^'\"]+)['\"]", build_file_content)
        if version_match:
            starters['version'] = version_match.group(1)
    
    return starters

2. 適切なリファレンスの読み込み

検出されたStarterに応じて、対応するリファレンスファイルを読み込みます:

使用中のStarter → 読み込むリファレンス
- validation → references/validation.md
- jpa → references/jpa.md
- postgresql → references/postgresql.md
- redis → references/redis.md
- security → references/security.md
- actuator → references/actuator.md
- test → references/test.md

3. レビュー観点の選択

レビュー内容に応じて、適切なエージェントを選択します:

• architecture-reviewer.md: アーキテクチャ、パッケージ構成、レイヤー分離
• security-reviewer.md: セキュリティ、認証・認可、脆弱性
• performance-reviewer.md: パフォーマンス、N+1問題、キャッシング
• code-quality-reviewer.md: コード品質、命名規則、テストカバレッジ

デフォルトでは全エージェントを使用しますが、ユーザーの要求に応じて特定の観点のみに絞ることも可能です。

4. レビューの実行

以下の順序でレビューを実施します:

1. プロジェクト構成の確認
   • ビルドファイルを解析
   • 使用中のStarterを特定
   • Spring Bootバージョンを確認
2. コードの静的解析
   • アップロードされたファイルを確認
   • パッケージ構造を分析
   • 各レイヤーの責務を確認
3. Starter別のレビュー
   • 検出された各Starterについて、対応するリファレンスに基づいてレビュー
   • ベストプラクティスとの比較
   • 潜在的な問題の検出
4. 統合レビュー
   • 各観点からの総合評価
   • 優先度付けされた改善提案
   • 具体的なコード例の提示

Output Format

レビュー結果は以下の形式で出力します:

# Spring Boot RESTful APIレビュー結果

## プロジェクト概要
- Spring Bootバージョン: 3.5.x
- 検出されたStarter:
  - ✓ spring-boot-starter-validation
  - ✓ spring-boot-starter-data-jpa
  - ✓ postgresql
  - ✓ spring-boot-starter-data-redis
  - ✓ spring-boot-starter-security
  - ✓ spring-boot-starter-actuator
  - ✓ spring-boot-starter-test

## 🔴 Critical Issues (優先度: 高)
[重大な問題点とその修正方法]

## 🟡 Warnings (優先度: 中)
[改善が望ましい点]

## 🟢 Suggestions (優先度: 低)
[推奨事項]

## ✅ Good Practices
[良い実装例]

## 📝 Detailed Review by Category

### Architecture & Design
[アーキテクチャレビュー結果]

### Security
[セキュリティレビュー結果]

### Performance
[パフォーマンスレビュー結果]

### Code Quality
[コード品質レビュー結果]

## 📋 Action Items
[優先順位付けされた対応項目リスト]

Best Practices Enforcement

Spring Boot 3.5系の主要な考慮事項

1. Jakarta EE移行: javax.* → jakarta.* パッケージの使用を確認
2. ネイティブイメージ対応: GraalVM Native Imageの対応状況
3. Observability: Micrometer Observationの活用
4. 仮想スレッド: Virtual Threads (Project Loom) の活用可能性

共通チェック項目

• ✓ 適切なHTTPステータスコードの使用
• ✓ 例外ハンドリングの統一 (@ControllerAdvice)
• ✓ DTOとEntityの分離
• ✓ バリデーションの適切な実装
• ✓ ログ出力の適切性
• ✓ トランザクション境界の正確性
• ✓ APIドキュメント (OpenAPI/Swagger) の有無

Integration with Other Skills

このスキルは以下のスキルと組み合わせて使用できます:

• docx: レビュー結果をWord文書として出力
• xlsx: 問題点トラッキング用のスプレッドシート作成
• pdf: レビューレポートのPDF生成

Usage Examples

Example 1: 基本的なレビュー

User: Spring Bootプロジェクトのコードレビューをお願いします
[pom.xmlとソースコードをアップロード]
Claude: [Starter検出スクリプト実行]
プロジェクトを分析しました。以下のStarterが検出されました:
- spring-boot-starter-web
- spring-boot-starter-data-jpa
- spring-boot-starter-validation
- postgresql

レビューを開始します...
[包括的なレビュー結果を出力]

Example 2: セキュリティに焦点を当てたレビュー

User: Spring Securityの実装をレビューしてください

Claude: [security-reviewer.mdを読み込み]
セキュリティ観点からレビューします...

Example 3: パフォーマンスレビュー

User: APIのパフォーマンスに問題がないかチェックして

Claude: [performance-reviewer.mdとjpa.md、redis.mdを読み込み]
パフォーマンスの観点からレビューします...

Notes

• Spring Boot 3.5系は現在まだリリースされていないバージョンですが、このスキルは3.x系の一般的なベストプラクティスに基づいています
• 4.0系への移行時には、Breaking Changesに対応した新しいリファレンスが必要になります
• プロジェクト固有の要件やアーキテクチャパターンについては、ユーザーとの対話を通じて確認することが重要です