1---
2name: springboot-patterns
3description: Spring Boot architecture patterns, REST API design, layered services, data access, caching, async processing, and logging. Use for Java Spring Boot backend work.
4---
5 
6# Spring Boot 開発パターン
7 
8スケーラブルで本番グレードのサービスのためのSpring BootアーキテクチャとAPIパターン。
9 
10## REST API構造
11 
12```java
13@RestController
14@RequestMapping("/api/markets")
15@Validated
16class MarketController {
17  private final MarketService marketService;
18 
19  MarketController(MarketService marketService) {
20    this.marketService = marketService;
21  }
22 
23  @GetMapping
24  ResponseEntity<Page<MarketResponse>> list(
25      @RequestParam(defaultValue = "0") int page,
26      @RequestParam(defaultValue = "20") int size) {
27    Page<Market> markets = marketService.list(PageRequest.of(page, size));
28    return ResponseEntity.ok(markets.map(MarketResponse::from));
29  }
30 
31  @PostMapping
32  ResponseEntity<MarketResponse> create(@Valid @RequestBody CreateMarketRequest request) {
33    Market market = marketService.create(request);
34    return ResponseEntity.status(HttpStatus.CREATED).body(MarketResponse::from(market));
35  }
36}
37```
38 
39## リポジトリパターン（Spring Data JPA）
40 
41```java
42public interface MarketRepository extends JpaRepository<MarketEntity, Long> {
43  @Query("select m from MarketEntity m where m.status = :status order by m.volume desc")
44  List<MarketEntity> findActive(@Param("status") MarketStatus status, Pageable pageable);
45}
46```
47 
48## トランザクション付きサービスレイヤー
49 
50```java
51@Service
52public class MarketService {
53  private final MarketRepository repo;
54 
55  public MarketService(MarketRepository repo) {
56    this.repo = repo;
57  }
58 
59  @Transactional
60  public Market create(CreateMarketRequest request) {
61    MarketEntity entity = MarketEntity.from(request);
62    MarketEntity saved = repo.save(entity);
63    return Market.from(saved);
64  }
65}
66```
67 
68## DTOと検証
69 
70```java
71public record CreateMarketRequest(
72    @NotBlank @Size(max = 200) String name,
73    @NotBlank @Size(max = 2000) String description,
74    @NotNull @FutureOrPresent Instant endDate,
75    @NotEmpty List<@NotBlank String> categories) {}
76 
77public record MarketResponse(Long id, String name, MarketStatus status) {
78  static MarketResponse from(Market market) {
79    return new MarketResponse(market.id(), market.name(), market.status());
80  }
81}
82```
83 
84## 例外ハンドリング
85 
86```java
87@ControllerAdvice
88class GlobalExceptionHandler {
89  @ExceptionHandler(MethodArgumentNotValidException.class)
90  ResponseEntity<ApiError> handleValidation(MethodArgumentNotValidException ex) {
91    String message = ex.getBindingResult().getFieldErrors().stream()
92        .map(e -> e.getField() + ": " + e.getDefaultMessage())
93        .collect(Collectors.joining(", "));
94    return ResponseEntity.badRequest().body(ApiError.validation(message));
95  }
96 
97  @ExceptionHandler(AccessDeniedException.class)
98  ResponseEntity<ApiError> handleAccessDenied() {
99    return ResponseEntity.status(HttpStatus.FORBIDDEN).body(ApiError.of("Forbidden"));
100  }
101 
102  @ExceptionHandler(Exception.class)
103  ResponseEntity<ApiError> handleGeneric(Exception ex) {
104    // スタックトレース付きで予期しないエラーをログ
105    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
106        .body(ApiError.of("Internal server error"));
107  }
108}
109```
110 
111## キャッシング
112 
113構成クラスで`@EnableCaching`が必要です。
114 
115```java
116@Service
117public class MarketCacheService {
118  private final MarketRepository repo;
119 
120  public MarketCacheService(MarketRepository repo) {
121    this.repo = repo;
122  }
123 
124  @Cacheable(value = "market", key = "#id")
125  public Market getById(Long id) {
126    return repo.findById(id)
127        .map(Market::from)
128        .orElseThrow(() -> new EntityNotFoundException("Market not found"));
129  }
130 
131  @CacheEvict(value = "market", key = "#id")
132  public void evict(Long id) {}
133}
134```
135 
136## 非同期処理
137 
138構成クラスで`@EnableAsync`が必要です。
139 
140```java
141@Service
142public class NotificationService {
143  @Async
144  public CompletableFuture<Void> sendAsync(Notification notification) {
145    // メール/SMS送信
146    return CompletableFuture.completedFuture(null);
147  }
148}
149```
150 
151## ロギング（SLF4J）
152 
153```java
154@Service
155public class ReportService {
156  private static final Logger log = LoggerFactory.getLogger(ReportService.class);
157 
158  public Report generate(Long marketId) {
159    log.info("generate_report marketId={}", marketId);
160    try {
161      // ロジック
162    } catch (Exception ex) {
163      log.error("generate_report_failed marketId={}", marketId, ex);
164      throw ex;
165    }
166    return new Report();
167  }
168}
169```
170 
171## ミドルウェア / フィルター
172 
173```java
174@Component
175public class RequestLoggingFilter extends OncePerRequestFilter {
176  private static final Logger log = LoggerFactory.getLogger(RequestLoggingFilter.class);
177 
178  @Override
179  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
180      FilterChain filterChain) throws ServletException, IOException {
181    long start = System.currentTimeMillis();
182    try {
183      filterChain.doFilter(request, response);
184    } finally {
185      long duration = System.currentTimeMillis() - start;
186      log.info("req method={} uri={} status={} durationMs={}",
187          request.getMethod(), request.getRequestURI(), response.getStatus(), duration);
188    }
189  }
190}
191```
192 
193## ページネーションとソート
194 
195```java
196PageRequest page = PageRequest.of(pageNumber, pageSize, Sort.by("createdAt").descending());
197Page<Market> results = marketService.list(page);
198```
199 
200## エラー回復力のある外部呼び出し
201 
202```java
203public <T> T withRetry(Supplier<T> supplier, int maxRetries) {
204  int attempts = 0;
205  while (true) {
206    try {
207      return supplier.get();
208    } catch (Exception ex) {
209      attempts++;
210      if (attempts >= maxRetries) {
211        throw ex;
212      }
213      try {
214        Thread.sleep((long) Math.pow(2, attempts) * 100L);
215      } catch (InterruptedException ie) {
216        Thread.currentThread().interrupt();
217        throw ex;
218      }
219    }
220  }
221}
222```
223 
224## レート制限（Filter + Bucket4j）
225 
226**セキュリティノート**: `X-Forwarded-For`ヘッダーはデフォルトでは信頼できません。クライアントがそれを偽装できるためです。
227転送ヘッダーは次の場合のみ使用してください:
2281. アプリが信頼できるリバースプロキシ（nginx、AWS ALBなど）の背後にある
2292. `ForwardedHeaderFilter`をBeanとして登録済み
2303. application propertiesで`server.forward-headers-strategy=NATIVE`または`FRAMEWORK`を設定済み
2314. プロキシが`X-Forwarded-For`ヘッダーを上書き（追加ではなく）するよう設定済み
232 
233`ForwardedHeaderFilter`が適切に構成されている場合、`request.getRemoteAddr()`は転送ヘッダーから正しいクライアントIPを自動的に返します。この構成がない場合は、`request.getRemoteAddr()`を直接使用してください。これは直接接続IPを返し、唯一信頼できる値です。
234 
235```java
236@Component
237public class RateLimitFilter extends OncePerRequestFilter {
238  private final Map<String, Bucket> buckets = new ConcurrentHashMap<>();
239 
240  /*
241   * セキュリティ: このフィルターはレート制限のためにクライアントを識別するために
242   * request.getRemoteAddr()を使用します。
243   *
244   * アプリケーションがリバースプロキシ（nginx、AWS ALBなど）の背後にある場合、
245   * 正確なクライアントIP検出のために転送ヘッダーを適切に処理するようSpringを
246   * 設定する必要があります:
247   *
248   * 1. application.properties/yamlで server.forward-headers-strategy=NATIVE
249   *    （クラウドプラットフォーム用）またはFRAMEWORKを設定
250   * 2. FRAMEWORK戦略を使用する場合、ForwardedHeaderFilterを登録:
251   *
252   *    @Bean
253   *    ForwardedHeaderFilter forwardedHeaderFilter() {
254   *        return new ForwardedHeaderFilter();
255   *    }
256   *
257   * 3. プロキシが偽装を防ぐためにX-Forwarded-Forヘッダーを上書き（追加ではなく）
258   *    することを確認
259   * 4. コンテナに応じてserver.tomcat.remoteip.trusted-proxiesまたは同等を設定
260   *
261   * この構成なしでは、request.getRemoteAddr()はクライアントIPではなくプロキシIPを返します。
262   * X-Forwarded-Forを直接読み取らないでください。信頼できるプロキシ処理なしでは簡単に偽装できます。
263   */
264  @Override
265  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
266      FilterChain filterChain) throws ServletException, IOException {
267    // ForwardedHeaderFilterが構成されている場合は正しいクライアントIPを返す
268    // getRemoteAddr()を使用。そうでなければ直接接続IPを返す。
269    // X-Forwarded-Forヘッダーを適切なプロキシ構成なしで直接信頼しない。
270    String clientIp = request.getRemoteAddr();
271 
272    Bucket bucket = buckets.computeIfAbsent(clientIp,
273        k -> Bucket.builder()
274            .addLimit(Bandwidth.classic(100, Refill.greedy(100, Duration.ofMinutes(1))))
275            .build());
276 
277    if (bucket.tryConsume(1)) {
278      filterChain.doFilter(request, response);
279    } else {
280      response.setStatus(HttpStatus.TOO_MANY_REQUESTS.value());
281    }
282  }
283}
284```
285 
286## バックグラウンドジョブ
287 
288Springの`@Scheduled`を使用するか、キュー（Kafka、SQS、RabbitMQなど）と統合します。ハンドラーをべき等かつ観測可能に保ちます。
289 
290## 可観測性
291 
292- 構造化ロギング（JSON）via Logbackエンコーダー
293- メトリクス: Micrometer + Prometheus/OTel
294- トレーシング: Micrometer TracingとOpenTelemetryまたはBraveバックエンド
295 
296## 本番デフォルト
297 
298- コンストラクタインジェクションを優先、フィールドインジェクションを避ける
299- RFC 7807エラーのために`spring.mvc.problemdetails.enabled=true`を有効化（Spring Boot 3+）
300- ワークロードに応じてHikariCPプールサイズを構成、タイムアウトを設定
301- クエリに`@Transactional(readOnly = true)`を使用
302- `@NonNull`と`Optional`で適切にnull安全性を強制
303 
304**覚えておいてください**: コントローラーは薄く、サービスは焦点を絞り、リポジトリはシンプルに、エラーは集中的に処理します。保守性とテスト可能性のために最適化してください。
305