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 ヘッダはデフォルトでは信頼できません。クライアントが偽装できるためです。
転送ヘッダは以下の場合にのみ使用してください。
- アプリケーションが信頼できるリバースプロキシ(nginx、AWS ALB など)の背後にある場合
ForwardedHeaderFilterを Bean として登録している場合application.propertiesでserver.forward-headers-strategy=NATIVEまたはFRAMEWORKを設定している場合- プロキシが
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 安全性を確保
注意: コントローラは薄く、サービスは集中的に、リポジトリはシンプルに、エラーは中央で処理してください。保守性とテスト容易性を最適化しましょう。