Communitygithub.com

Spring Boot 開発パターン

Spring Boot アーキテクチャパターン、REST API 設計、レイヤードサービス、データアクセス、キャッシング、非同期処理、ロギング。Java Spring Boot バックエンド作業時に使用します。REST レイヤ、サービス、データアクセス、キャッシング、非同期処理を含む Spring Boot バックエンドの構築・レビュー時に活用してください。

Spring Boot 開発パターン とは?

このスキルは、Spring Boot を使用したスケーラブルでプロダクショングレードのバックエンドサービスを構築するための包括的なアーキテクチャパターンと API 設計パターンを提供します。コントローラ、サービス、リポジトリのレイヤード構造から、Spring Data JPA を用いたリポジトリパターン、トランザクション管理、DTO とバリデーション、グローバル例外ハンドリング、キャッシング、非同期処理、SLF4J を使った構造化ロギングまでをカバーします。また、レート制限(Bucket4j を使用)、ページネーションとソート、外部呼び出しのリトライロジック、フィルターによるリクエストロギングなどの実用的なパターンも含まれています。セキュリティ面では、リバースプロキシ環境における X-Forwarded-For ヘッダの適切な扱い方や、信頼できるクライアント IP の取得方法について重要な注意事項を記載しています。このスキルは、Claude Code、Cursor、Codex などの AI エージェントが Spring Boot プロジェクトのコードレビューや新規開発の際に、ベストプラクティスに沿ったコードを生成・提案するために活用できます。生産環境でのデフォルト設定(コンストラクタインジェクション、HikariCP 設定、@Transactional(readOnly = true) など)も推奨されており、保守性とテスト容易性を重視した設計思想が反映されています。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/affaan-m/ECC/tree/main/skills/springboot-patterns

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

Spring Boot 開発パターン は何をしますか?

スケーラブルでプロダクショングレードのサービスのための Spring Boot アーキテクチャと API パターン

アクティブ化のタイミング

  • Spring MVC または WebFlux を使用した REST API の構築
  • コントローラ → サービス → リポジトリ層の構造化
  • Spring Data JPA、キャッシング、または非同期処理の設定
  • バリデーション、例外処理、またはページネーションの追加
  • 開発/ステージング/本番環境用のプロファイル設定
  • Spring Events または Kafka を使用したイベント駆動型パターンの実装

REST API 構造

@RestController
@RequestMapping("/api/markets")
@Validated
class MarketController {
  private final MarketService marketService;

  MarketController(MarketService marketService) {
    this.marketService = marketService;
  }

  @GetMapping
  ResponseEntity<Page<MarketResponse>> list(
      @RequestParam(defaultValue = "0") int page,
      @RequestParam(defaultValue = "20") int size) {
    Page<Market> markets = marketService.list(PageRequest.of(page, size));
    return ResponseEntity.ok(markets.map(MarketResponse::from));
  }

  @PostMapping
  ResponseEntity<MarketResponse> create(@Valid @RequestBody CreateMarketRequest request) {
    Market market = marketService.create(request);
    return ResponseEntity.status(HttpStatus.CREATED).body(MarketResponse.from(market));
  }
}

リポジトリパターン(Spring Data JPA)

public interface MarketRepository extends JpaRepository<MarketEntity, Long> {
  @Query("select m from MarketEntity m where m.status = :status order by m.volume desc")
  List<MarketEntity> findActive(@Param("status") MarketStatus status, Pageable pageable);
}

トランザクション管理を含むサービス層

@Service
public class MarketService {
  private final MarketRepository repo;

  public MarketService(MarketRepository repo) {
    this.repo = repo;
  }

  @Transactional
  public Market create(CreateMarketRequest request) {
    MarketEntity entity = MarketEntity.from(request);
    MarketEntity saved = repo.save(entity);
    return Market.from(saved);
  }
}

DTO とバリデーション

public record CreateMarketRequest(
    @NotBlank @Size(max = 200) String name,
    @NotBlank @Size(max = 2000) String description,
    @NotNull @FutureOrPresent Instant endDate,
    @NotEmpty List<@NotBlank String> categories) {}

public record MarketResponse(Long id, String name, MarketStatus status) {
  static MarketResponse from(Market market) {
    return new MarketResponse(market.id(), market.name(), market.status());
  }
}

例外処理

@ControllerAdvice
class GlobalExceptionHandler {
  @ExceptionHandler(MethodArgumentNotValidException.class)
  ResponseEntity<ApiError> handleValidation(MethodArgumentNotValidException ex) {
    String message = ex.getBindingResult().getFieldErrors().stream()
        .map(e -> e.getField() + ": " + e.getDefaultMessage())
        .collect(Collectors.joining(", "));
    return ResponseEntity.badRequest().body(ApiError.validation(message));
  }

  @ExceptionHandler(AccessDeniedException.class)
  ResponseEntity<ApiError> handleAccessDenied() {
    return ResponseEntity.status(HttpStatus.FORBIDDEN).body(ApiError.of("Forbidden"));
  }

  @ExceptionHandler(Exception.class)
  ResponseEntity<ApiError> handleGeneric(Exception ex) {
    // 予期しないエラーはスタックトレース付きでログ出力
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
        .body(ApiError.of("Internal server error"));
  }
}

キャッシング

設定クラスに @EnableCaching が必要です。

@Service
public class MarketCacheService {
  private final MarketRepository repo;

  public MarketCacheService(MarketRepository repo) {
    this.repo = repo;
  }

  @Cacheable(value = "market", key = "#id")
  public Market getById(Long id) {
    return repo.findById(id)
        .map(Market::from)
        .orElseThrow(() -> new EntityNotFoundException("Market not found"));
  }

  @CacheEvict(value = "market", key = "#id")
  public void evict(Long id) {}
}

非同期処理

設定クラスに @EnableAsync が必要です。

@Service
public class NotificationService {
  @Async
  public CompletableFuture<Void> sendAsync(Notification notification) {
    // メール/SMS送信
    return CompletableFuture.completedFuture(null);
  }
}

ロギング(SLF4J)

@Service
public class ReportService {
  private static final Logger log = LoggerFactory.getLogger(ReportService.class);

  public Report generate(Long marketId) {
    log.info("generate_report marketId={}", marketId);
    try {
      // ロジック
    } catch (Exception ex) {
      log.error("generate_report_failed marketId={}", marketId, ex);
      throw ex;
    }
    return new Report();
  }
}

ミドルウェア / フィルター

@Component
public class RequestLoggingFilter extends OncePerRequestFilter {
  private static final Logger log = LoggerFactory.getLogger(RequestLoggingFilter.class);

  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
      FilterChain filterChain) throws ServletException, IOException {
    long start = System.currentTimeMillis();
    try {
      filterChain.doFilter(request, response);
    } finally {
      long duration = System.currentTimeMillis() - start;
      log.info("req method={} uri={} status={} durationMs={}",
          request.getMethod(), request.getRequestURI(), response.getStatus(), duration);
    }
  }
}

ページネーションとソート

PageRequest page = PageRequest.of(pageNumber, pageSize, Sort.by("createdAt").descending());
Page<Market> results = marketService.list(page);

エラー耐性のある外部呼び出し

public <T> T withRetry(Supplier<T> supplier, int maxRetries) {
  int attempts = 0;
  while (true) {
    try {
      return supplier.get();
    } catch (Exception ex) {
      attempts++;
      if (attempts >= maxRetries) {
        throw ex;
      }
      try {
        Thread.sleep((long) Math.pow(2, attempts) * 100L);
      } catch (InterruptedException ie) {
        Thread.currentThread().interrupt();
        throw ex;
      }
    }
  }
}

レート制限(フィルター + Bucket4j)

セキュリティ注意: X-Forwarded-For ヘッダはデフォルトでは信頼できません。クライアントが偽装できるためです。 転送ヘッダは以下の場合にのみ使用してください。

  1. アプリケーションが信頼できるリバースプロキシ(nginx、AWS ALB など)の背後にある場合
  2. ForwardedHeaderFilter を Bean として登録している場合
  3. application.properties で server.forward-headers-strategy=NATIVE または FRAMEWORK を設定している場合
  4. プロキシが X-Forwarded-For ヘッダを追加(append)ではなく上書き(overwrite)するように設定されている場合

ForwardedHeaderFilter が適切に設定されている場合、request.getRemoteAddr() は転送ヘッダから自動的に正しいクライアント IP を返します。この設定がない場合は、request.getRemoteAddr() を直接使用してください。これは直接接続 IP を返し、それが唯一の信頼できる値です。

@Component
public class RateLimitFilter extends OncePerRequestFilter {
  private final Map<String, Bucket> buckets = new ConcurrentHashMap<>();

  /*
   * セキュリティ: このフィルターはレート制限のクライアント識別に request.getRemoteAddr() を使用します。
   *
   * アプリケーションがリバースプロキシ(nginx、AWS ALB など)の背後にある場合、正確なクライアント IP を
   * 取得するには、Spring で転送ヘッダを適切に処理するよう設定する必要があります。
   *
   * 1. application.properties/yaml に server.forward-headers-strategy=NATIVE(クラウドプラットフォーム向け)
   *    または FRAMEWORK を設定
   * 2. FRAMEWORK 戦略を使用する場合は、ForwardedHeaderFilter を登録:
   *
   *    @Bean
   *    ForwardedHeaderFilter forwardedHeaderFilter() {
   *        return new ForwardedHeaderFilter();
   *    }
   *
   * 3. プロキシが X-Forwarded-For ヘッダを追加(append)ではなく上書き(overwrite)することを確認(偽装防止)
   * 4. 使用しているコンテナに応じて server.tomcat.remoteip.trusted-proxies などを設定
   *
   * この設定がない場合、request.getRemoteAddr() はクライアント IP ではなくプロキシ IP を返します。
   * X-Forwarded-For を直接読み取らないでください。信頼できるプロキシ処理なしでは簡単に偽装できます。
   */
  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
      FilterChain filterChain) throws ServletException, IOException {
    // ForwardedHeaderFilter が設定されている場合は正しいクライアント IP を、
    // そうでない場合は直接接続 IP を返す getRemoteAddr() を使用。
    // 適切なプロキシ設定なしに X-Forwarded-For ヘッダを直接信頼しないでください。
    String clientIp = request.getRemoteAddr();

    Bucket bucket = buckets.computeIfAbsent(clientIp,
        k -> Bucket.builder()
            .addLimit(Bandwidth.classic(100, Refill.greedy(100, Duration.ofMinutes(1))))
            .build());

    if (bucket.tryConsume(1)) {
      filterChain.doFilter(request, response);
    } else {
      response.setStatus(HttpStatus.TOO_MANY_REQUESTS.value());
    }
  }
}

バックグラウンドジョブ

Spring の @Scheduled を使用するか、キュー(Kafka、SQS、RabbitMQ など)と統合します。ハンドラーは冪等で監視可能に保ちます。

可観測性

  • 構造化ロギング(JSON): Logback エンコーダー
  • メトリクス: Micrometer + Prometheus/OTel
  • トレーシング: OpenTelemetry または Brave バックエンドを使用した Micrometer Tracing

プロダクションのデフォルト設定

  • コンストラクタインジェクションを推奨、フィールドインジェクションは避ける
  • Spring Boot 3+ で RFC 7807 エラーを有効にするには spring.mvc.problemdetails.enabled=true を設定
  • ワークロードに合わせて HikariCP プールサイズを設定し、タイムアウトを設定
  • クエリには @Transactional(readOnly = true) を使用
  • 適切な箇所で @NonNull と Optional を使用して null 安全性を確保

注意: コントローラは薄く、サービスは集中的に、リポジトリはシンプルに、エラーは中央で処理してください。保守性とテスト容易性を最適化しましょう。

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

accessibility

Design, implement, and audit inclusive digital products using WCAG 2.2 Level AA. Use when building or auditing UI that must meet WCAG 2.2 Level AA, or when reviewing a change for keyboard, contrast, or screen-reader support.

affaan-m/content-engine

Create platform-native content systems for X, LinkedIn, TikTok, YouTube, newsletters, and repurposed multi-platform campaigns. Use when the user wants social posts, threads, scripts, content calendars, or one source asset adapted cleanly across platforms.

affaan-m/ECC

Multi-platform content distribution across X, LinkedIn, Threads, and Bluesky. Adapts content per platform using content-engine patterns. Never posts identical content cross-platform. Use when the user wants to distribute content across social platforms.

affaan-m/fal-ai-media

Unified media generation via fal.ai MCP — image, video, and audio. Covers text-to-image (Nano Banana), text/image-to-video (Seedance, Kling, Veo 3), text-to-speech (CSM-1B), and video-to-audio (ThinkSound). Use when the user wants to generate images, videos, or audio with AI.

affaan-m/manim-video

日本語翻訳:このファイルは manim-video 用の日本語翻訳が必要です

affaan-m/remotion-video-creation

Remotion のベストプラクティス - React で動画を作成する。3D、アニメーション、音声、字幕、チャート、トランジションなどをカバーするドメイン固有の29のルール。

affaan-m/video-editing

AI-assisted video editing workflows for cutting, structuring, and augmenting real footage. Covers the full pipeline from raw capture through FFmpeg, Remotion, ElevenLabs, fal.ai, and final polish in Descript or CapCut. Use when the user wants to edit video, cut footage, create vlogs, or build video content.

agent-architecture-audit

Full-stack diagnostic for agent and LLM applications. Audits the 12-layer agent stack for wrapper regression, memory pollution, tool discipline failures, hidden repair loops, and rendering corruption. Produces severity-ranked findings with code-first fixes. Essential for developers building agent applications, autonomous loops, or any LLM-powered feature. Use when an agent or LLM feature misbehaves and the failing layer is unknown, or before shipping an agent stack.

agent-eval

Head-to-head comparison of coding agents (Claude Code, Aider, Codex, etc.) on custom tasks with pass rate, cost, time, and consistency metrics. Use when choosing between coding agents, or when a change to an agent setup needs measured pass rate, cost, and time rather than an impression.

agent-harness-construction

Design and optimize AI agent action spaces, tool definitions, and observation formatting for higher completion rates. Use when defining or revising an agent

agentic-engineering

Operate as an agentic engineer using eval-first execution, decomposition, and cost-aware model routing. Use when planning or executing engineering work that agents will carry out end to end.

agentic-os

Build persistent multi-agent operating systems on Claude Code. Covers kernel architecture, specialist agents, slash commands, file-based memory, scheduled automation, and state management without external databases. Use when building a persistent multi-agent system on Claude Code with its own memory, commands, and scheduling.

agent-introspection-debugging

Structured self-debugging workflow for AI agent failures using capture, diagnosis, contained recovery, and introspection reports. Use when an agent run fails and you need a reproducible diagnosis instead of a retry.

agent-payment-x402

Add x402 payment execution to AI agents with per-task budgets, spending controls, and non-custodial wallets. Supports Base through agentwallet-sdk and X Layer through OKX Payments / OKX Agent Payments Protocol. Use when an agent must pay for something itself and needs per-task budgets, spending controls, and a non-custodial wallet.

agent-self-evaluation

Use after completing any non-trivial task. The agent self-rates its output on 5 axes — accuracy, completeness, clarity, actionability, conciseness — with concrete evidence per criterion. Produces a structured 1-5 scorecard with specific improvement suggestions.

agent-sort

Build an evidence-backed ECC install plan for a specific repo by sorting skills, commands, rules, hooks, and extras into DAILY vs LIBRARY buckets using parallel repo-aware review passes. Use when ECC should be trimmed to what a project actually needs instead of loading the full bundle.

ai-first-engineering

Engineering operating model for teams where AI agents generate a large share of implementation output. Use when setting team process, review gates, or ownership rules for a codebase largely written by agents.

ai-regression-testing

Regression testing strategies for AI-assisted development. Sandbox-mode API testing without database dependencies, automated bug-check workflows, and patterns to catch AI blind spots where the same model writes and reviews code. Use when adding regression coverage to AI-assisted code, or when the same model both wrote and reviewed a change.

android-clean-architecture

Clean Architecture patterns for Android and Kotlin Multiplatform projects — module structure, dependency rules, UseCases, Repositories, and data layer patterns. Use when structuring modules, layers, or data flow in an Android or KMP project.

angular-developer

Generates Angular code and provides architectural guidance. Trigger when creating projects, components, or services, or for best practices on reactivity (signals, linkedSignal, resource), forms, dependency injection, routing, SSR, accessibility (ARIA), animations, styling (component styles, Tailwind CSS), testing, or CLI tooling.

関連スキル