spring-boot-patterns

name	spring-boot-patterns
description	Spring Boot 架构模式、REST API 设计、分层服务、数据访问、缓存、异步处理和日志。适用于 Java Spring Boot 后端开发。
origin	FancyLiu

Spring Boot 开发模式

用于构建可扩展、生产级服务的 Spring Boot 架构与 API 模式。

何时激活

• 使用 Spring MVC 或 WebFlux 构建 REST API
• 构建 Controller → Service → Repository 分层架构
• 配置 Spring Data JPA、缓存或异步处理
• 添加参数校验、异常处理或分页功能
• 为 dev/staging/production 环境设置 Profile
• 使用 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));
  }
}

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

带事务的 Service 层

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

限流（Filter + 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）。保持处理器的幂等性和可观测性。

可观测性

• 结构化日志（JSON），通过 Logback encoder 实现
• 指标监控：Micrometer + Prometheus/OTel
• 链路追踪：Micrometer Tracing 搭配 OpenTelemetry 或 Brave 后端

生产环境默认配置

• 优先使用构造函数注入，避免字段注入
• 启用 spring.mvc.problemdetails.enabled=true 以支持 RFC 7807 错误格式（Spring Boot 3+）
• 根据工作负载配置 HikariCP 连接池大小，设置超时时间
• 对查询操作使用 @Transactional(readOnly = true)
• 在适当的位置通过 @NonNull 和 Optional 确保空安全

请记住：保持 Controller 简洁、Service 职责单一、Repository 简单，异常统一集中处理。以可维护性和可测试性为优化目标。