springboot-patterns

Spring Boot 開發模式

適用於可擴展、生產級別服務的 Spring Boot 架構與 API 模式。

啟用時機

• 使用 Spring MVC 或 WebFlux 建構 REST API
• 組織 controller → service → repository 分層架構
• 配置 Spring Data JPA、快取或非同步處理
• 加入驗證、例外處理或分頁功能
• 設定開發/測試/正式環境的設定檔 (profiles)
• 使用 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) {
    // 發送電子郵件/簡訊
    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 標頭

當 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 等）之後，您必須
   * 配置 Spring 正確處理轉發的標頭，以獲得準確的用戶端 IP 檢測：
   *
   * 1. 在 application.properties/yaml 中設定 server.forward-headers-strategy=NATIVE（適用於雲端平台）或 FRAMEWORK
   * 2. 如果使用 FRAMEWORK 策略，請註冊 ForwardedHeaderFilter：
   *
   *    @Bean
   *    ForwardedHeaderFilter forwardedHeaderFilter() {
   *        return new ForwardedHeaderFilter();
   *    }
   *
   * 3. 確保您的代理伺服器覆蓋（而非附加）X-Forwarded-For 標頭以防止偽造
   * 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 {
    // 使用 getRemoteAddr()，當配置了 ForwardedHeaderFilter 時，它返回正確的用戶端 IP，
    // 否則返回直接連線的 IP。在沒有正確的代理伺服器配置的情況下，切勿直接信任 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）整合。保持處理器的冪等性與可觀察性。

可觀測性

• 透過 Logback 編碼器進行結構化日誌記錄 (JSON)
• 指標：Micrometer + Prometheus/OTel
• 追蹤：使用 OpenTelemetry 或 Brave 後端的 Micrometer Tracing

生產環境預設配置

• 優先使用建構子注入，避免字段注入
• 啟用 spring.mvc.problemdetails.enabled=true 以使用 RFC 7807 錯誤（Spring Boot 3+）
• 根據工作負載配置 HikariCP 連線池大小，設定超時時間
• 對查詢使用 @Transactional(readOnly = true)
• 在適當的地方透過 @NonNull 和 Optional 來強制執行空值安全性

記住：保持控制器精簡、服務專注、儲存庫簡單，並集中處理錯誤。以可維護性和可測試性為最佳化目標。