SuperAPI AI 工具集

exceptions-spring

编程与开发

查看项目

更新于 10-16 10:10

技能介绍

用途

Exceptions Spring Boot(标识为 apigen-exceptions)是一项面向 Spring Boot 项目的异常处理技能,用于建立统一的 API 错误响应机制。其核心围绕 @ControllerAdvice、ProblemDetail 与 GlobalExceptionHandler 展开,将应用中的各类异常规范化为结构化的错误响应。

主要能力

该技能提供了一套可继承的异常体系。ApiException 为抽象基类,继承自 RuntimeException,携带 errorCode、HttpStatus 和 context 上下文映射,并可转换为 ProblemDetail。在其基础上定义了多种具体异常类型:ValidationException(校验失败,含字段错误列表)、ResourceNotFoundException(资源未找到)、BusinessRuleException(业务规则违反)、ConflictException(资源冲突)。

GlobalExceptionHandler 使用 @RestControllerAdvice 与 @Order(Ordered.HIGHEST_PRECEDENCE) 注解,集中处理 ApiException、MethodArgumentNotValidException、ConstraintViolationException、DataIntegrityViolationException、OptimisticLockingFailureException 以及通用 Exception。处理器的输出为 ProblemDetail,包含 type、title、detail、instance 以及自定义属性。

此外还提供 FieldError 记录类型(含可选的 rejectedValue)、异常自动配置类 ExceptionAutoConfiguration(在 Servlet Web 应用中条件生效,注册 GlobalExceptionHandler 与 ProblemDetailExceptionHandler),以及 ExtendedProblemDetail 自定义扩展(含 code、timestamp、traceId)和基于 MockMvc 的异常测试示例。

使用方式

通过配置项 apigen.exceptions 控制行为,可设置项包括 include-stack-trace(默认取 DEBUG 环境变量,默认 false)、include-message、log-full-details、problem-base-uri(如 https://api.example.com/errors)。

使用时继承 ApiException 定义自定义异常,实现 getTitle() 方法,并通过构造器传入消息、错误码、HTTP 状态与上下文。全局异常处理器会自动将异常转换为 ProblemDetail;自动配置类会在缺失 GlobalExceptionHandler Bean 时自动注册。测试中可借助 @WebMvcTest 与 MockMvc 断言返回的状态码、内容类型与 JSON 路径。

适用场景

适用于基于 Spring Boot 构建 REST API、需要统一错误响应格式与错误码体系的项目,尤其适合需要区分校验错误、资源缺失、业务规则冲突、并发修改等不同错误语义的服务端应用。

限制

资料未提供该技能的收费、价格、支持的 Spring Boot 版本范围、与其他技能的依赖关系等具体信息,暂未提供。自动配置仅在 Servlet 类型的 Web 应用中生效(@ConditionalOnWebApplication 指定 SERVLET)。异常处理器默认不暴露数据库细节,堆栈信息仅在 include-stack-trace 开启时输出。