springboot-patterns

Spring Boot Development Patterns

Architektur- und API-Muster für Spring Boot für skalierbare, produktionsreife Dienste.

Wann aktivieren

• Erstellen von REST-APIs mit Spring MVC oder WebFlux
• Strukturieren von Controller → Service → Repository Schichten
• Konfigurieren von Spring Data JPA, Caching oder asynchroner Verarbeitung
• Hinzufügen von Validierung, Fehlerbehandlung oder Paginierung
• Einrichten von Profilen für Entwicklung/Staging/Produktion
• Implementieren von ereignisgesteuerten Mustern mit Spring Events oder Kafka

REST-API-Struktur

@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));
  }
}

Repository-Muster (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-Schicht mit Transaktionen

@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);
  }
}

DTOs und Validierung

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());
  }
}

Fehlerbehandlung

@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) {
    // Protokolliere unerwartete Fehler mit Stack-Traces
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
        .body(ApiError.of("Internal server error"));
  }
}

Caching

Erfordert @EnableCaching auf einer Konfigurationsklasse.

@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) {}
}

Asynchrone Verarbeitung

Erfordert @EnableAsync auf einer Konfigurationsklasse.

@Service
public class NotificationService {
  @Async
  public CompletableFuture<Void> sendAsync(Notification notification) {
    // E-Mail/SMS senden
    return CompletableFuture.completedFuture(null);
  }
}

Logging (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 {
      // Logik
    } catch (Exception ex) {
      log.error("generate_report_failed marketId={}", marketId, ex);
      throw ex;
    }
    return new Report();
  }
}

Middleware / Filter

@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);
    }
  }
}

Paginierung und Sortierung

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

Fehlertolerante externe Aufrufe

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;
      }
    }
  }
}

Ratenbegrenzung (Filter + Bucket4j)

Sicherheitshinweis: Der X-Forwarded-For-Header ist standardmäßig nicht vertrauenswürdig, da Clients ihn fälschen können. Verwenden Sie Forwarded-Header nur, wenn:

1. Ihre Anwendung hinter einem vertrauenswürdigen Reverse-Proxy (nginx, AWS ALB, usw.) läuft
2. Sie ForwardedHeaderFilter als Bean registriert haben
3. Sie server.forward-headers-strategy=NATIVE oder FRAMEWORK in den Anwendungseigenschaften konfiguriert haben
4. Ihr Proxy so konfiguriert ist, dass er den X-Forwarded-For-Header überschreibt (nicht anhängt)

Wenn ForwardedHeaderFilter ordnungsgemäß konfiguriert ist, gibt request.getRemoteAddr() automatisch die korrekte Client-IP aus den Forwarded-Headern zurück. Ohne diese Konfiguration verwenden Sie direkt request.getRemoteAddr() – es gibt die IP der unmittelbaren Verbindung zurück, den einzigen vertrauenswürdigen Wert.

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

  /*
   * SICHERHEIT: Dieser Filter verwendet request.getRemoteAddr(), um Clients für die Ratenbegrenzung zu identifizieren.
   *
   * Wenn Ihre Anwendung hinter einem Reverse-Proxy (nginx, AWS ALB, usw.) läuft, MÜSSEN Sie
   * Spring für die ordnungsgemäße Handhabung von Forwarded-Headern konfigurieren, um die
   * korrekte Client-IP zu erkennen:
   *
   * 1. Setzen Sie server.forward-headers-strategy=NATIVE (für Cloud-Plattformen) oder FRAMEWORK in
   *    application.properties/yaml
   * 2. Bei Verwendung der FRAMEWORK-Strategie registrieren Sie ForwardedHeaderFilter:
   *
   *    @Bean
   *    ForwardedHeaderFilter forwardedHeaderFilter() {
   *        return new ForwardedHeaderFilter();
   *    }
   *
   * 3. Stellen Sie sicher, dass Ihr Proxy den X-Forwarded-For-Header überschreibt (nicht anhängt), um
   *    Fälschungen zu verhindern
   * 4. Konfigurieren Sie server.tomcat.remoteip.trusted-proxies oder entsprechendes für Ihren Container
   *
   * Ohne diese Konfiguration gibt request.getRemoteAddr() die Proxy-IP zurück, nicht die Client-IP.
   * Lesen Sie X-Forwarded-For NICHT direkt – es ist ohne vertrauenswürdige Proxy-Handhabung trivial fälschbar.
   */
  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
      FilterChain filterChain) throws ServletException, IOException {
    // Verwenden Sie getRemoteAddr(), das die korrekte Client-IP zurückgibt, wenn ForwardedHeaderFilter
    // konfiguriert ist, oder andernfalls die IP der direkten Verbindung. Vertrauen Sie nie direkt
    // X-Forwarded-For-Headern ohne ordnungsgemäße Proxy-Konfiguration.
    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());
    }
  }
}

Hintergrundaufgaben

Verwenden Sie Springs @Scheduled oder integrieren Sie Warteschlangen (z. B. Kafka, SQS, RabbitMQ). Halten Sie Handler idempotent und beobachtbar.

Beobachtbarkeit

• Strukturiertes Logging (JSON) über Logback-Encoder
• Metriken: Micrometer + Prometheus/OTel
• Tracing: Micrometer Tracing mit OpenTelemetry oder Brave Backend

Produktionsstandards

• Bevorzugen Sie Konstruktor-Injektion, vermeiden Sie Feldinjektion
• Aktivieren Sie spring.mvc.problemdetails.enabled=true für RFC 7807-Fehler (Spring Boot 3+)
• Konfigurieren Sie HikariCP-Poolgrößen für die Arbeitslast, setzen Sie Timeouts
• Verwenden Sie @Transactional(readOnly = true) für Abfragen
• Erzwingen Sie Null-Sicherheit durch @NonNull und Optional wo angemessen

Denken Sie daran: Halten Sie Controller dünn, Dienste fokussiert, Repositories einfach und behandeln Sie Fehler zentral. Optimieren Sie für Wartbarkeit und Testbarkeit.