springboot-patterns

Patrons de Développement Spring Boot

Patrons d'architecture et d'API Spring Boot pour des services évolutifs et de qualité production.

Quand Activer

• Construction d'API REST avec Spring MVC ou WebFlux
• Structuration des couches contrôleur → service → repository
• Configuration de Spring Data JPA, mise en cache ou traitement asynchrone
• Ajout de validation, gestion des exceptions ou pagination
• Mise en place de profils pour les environnements de développement, staging et production
• Implémentation de patrons orientés événements avec Spring Events ou Kafka

Structure d'une API REST

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

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

Couche Service avec Transactions

@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 et Validation

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

Gestion des Exceptions

@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) {
    // Enregistrer les erreurs inattendues avec les piles d'appels
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
        .body(ApiError.of("Erreur interne du serveur"));
  }
}

Mise en Cache

Nécessite @EnableCaching sur une classe de configuration.

@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("Marché non trouvé"));
  }

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

Traitement Asynchrone

Nécessite @EnableAsync sur une classe de configuration.

@Service
public class NotificationService {
  @Async
  public CompletableFuture<Void> sendAsync(Notification notification) {
    // envoyer un email/SMS
    return CompletableFuture.completedFuture(null);
  }
}

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

Middleware / Filtres

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

Pagination et Tri

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

Appels Externes Résilients aux Erreurs

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

Limitation de Débit (Filtre + Bucket4j)

Note de Sécurité : L'en-tête X-Forwarded-For n'est pas fiable par défaut car les clients peuvent l'usurper. Utilisez les en-têtes transmis uniquement lorsque :

1. Votre application se trouve derrière un proxy inverse de confiance (nginx, AWS ALB, etc.)
2. Vous avez enregistré ForwardedHeaderFilter en tant que bean
3. Vous avez configuré server.forward-headers-strategy=NATIVE ou FRAMEWORK dans les propriétés de l'application
4. Votre proxy est configuré pour écraser (et non ajouter) l'en-tête X-Forwarded-For

Lorsque ForwardedHeaderFilter est correctement configuré, request.getRemoteAddr() retournera automatiquement l'adresse IP client correcte à partir des en-têtes transmis. Sans cette configuration, utilisez request.getRemoteAddr() directement — elle retourne l'adresse IP de la connexion immédiate, qui est la seule valeur digne de confiance.

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

  /*
   * SÉCURITÉ : Ce filtre utilise request.getRemoteAddr() pour identifier les clients
   * à des fins de limitation de débit.
   *
   * Si votre application se trouve derrière un proxy inverse (nginx, AWS ALB, etc.),
   * vous DEVEZ configurer Spring pour gérer correctement les en-têtes transmis afin
   * d'obtenir une détection IP client précise :
   *
   * 1. Définir server.forward-headers-strategy=NATIVE (pour les plateformes cloud) ou
   *    FRAMEWORK dans application.properties/yaml
   * 2. Si vous utilisez la stratégie FRAMEWORK, enregistrer ForwardedHeaderFilter :
   *
   *    @Bean
   *    ForwardedHeaderFilter forwardedHeaderFilter() {
   *        return new ForwardedHeaderFilter();
   *    }
   *
   * 3. Assurez-vous que votre proxy écrase (et n'ajoute pas) l'en-tête X-Forwarded-For
   *    pour empêcher l'usurpation
   * 4. Configurez server.tomcat.remoteip.trusted-proxies ou l'équivalent pour votre
   *    conteneur
   *
   * Sans cette configuration, request.getRemoteAddr() retourne l'adresse IP du proxy,
   * et non celle du client. Ne lisez PAS X-Forwarded-For directement — il est
   * trivialement usurpable sans gestion de proxy de confiance.
   */
  @Override
  protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
      FilterChain filterChain) throws ServletException, IOException {
    // Utilisez getRemoteAddr() qui retourne l'adresse IP correcte du client lorsque
    // ForwardedHeaderFilter est configuré, ou l'adresse IP de la connexion directe
    // sinon. Ne faites jamais confiance aux en-têtes X-Forwarded-For directement sans
    // configuration de proxy appropriée.
    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());
    }
  }
}

Tâches de Fond

Utilisez @Scheduled de Spring ou intégrez des files d'attente (par exemple, Kafka, SQS, RabbitMQ). Gardez les gestionnaires idempotents et observables.

Observabilité

• Journalisation structurée (JSON) via un encoder Logback
• Métriques : Micrometer + Prometheus/OTel
• Traçage : Micrometer Tracing avec backend OpenTelemetry ou Brave

Valeurs par Défaut de Production

• Préférez l'injection par constructeur, évitez l'injection de champ
• Activez spring.mvc.problemdetails.enabled=true pour les erreurs RFC 7807 (Spring Boot 3+)
• Configurez les tailles de pool HikariCP pour la charge de travail, définissez des délais d'attente
• Utilisez @Transactional(readOnly = true) pour les requêtes
• Appliquez la null-safety via @NonNull et Optional lorsque c'est approprié

Rappelez-vous : Gardez les contrôleurs légers, les services ciblés, les repositories simples et les erreurs gérées de manière centralisée. Optimisez pour la maintenabilité et la testabilité.