Java中 RESTful API 怎么将异常映射为标准 HTTP 状态码 (400, 404, 500)

星枫小哥_5741

星枫小哥_5741

2026-07-13

914人浏览

原创

java restful api通过@controlleradvice与@exceptionhandler统一映射异常为标准http状态码,并返回结构化apierror响应体;配合@valid实现自动参数校验触发400,且生产环境避免泄露敏感错误详情。

java中 restful api 怎么将异常映射为标准 http 状态码 (400, 404, 500)

Java 中 RESTful API 将异常映射为标准 HTTP 状态码,核心是用 @ControllerAdvice + @ExceptionHandler 统一处理异常,并返回对应状态码和结构化错误响应。

定义统一错误响应体

先设计一个通用的错误响应结构,便于前端解析:

public class ApiError {
    private int status;
    private String message;
    private LocalDateTime timestamp;

    public ApiError(HttpStatus status, String message) {
        this.status = status.value();
        this.message = message;
        this.timestamp = LocalDateTime.now();
    }
    // getter/setter 省略
}

这样能保证所有错误返回 JSON 格式一致,比如:{"status":404,"message":"用户不存在","timestamp":"2024-06-10T15:22:33"}

用 @ControllerAdvice 拦截特定异常

创建全局异常处理器,按异常类型匹配并设置对应状态码:

  • 业务异常(如参数校验失败)→ 400 Bad Request:捕获 MethodArgumentNotValidException 或自定义的 BadRequestException
  • 资源未找到 → 404 Not Found:捕获 EntityNotFoundException 或 NoSuchElementException
  • 系统内部错误 → 500 Internal Server Error:捕获 RuntimeException(兜底),但建议排除已明确处理的异常

示例:

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<apierror> handleValidationExceptions(
            MethodArgumentNotValidException ex) {
        String message = ex.getBindingResult()
                .getFieldErrors().stream()
                .map(FieldError::getDefaultMessage)
                .findFirst().orElse("参数校验失败");
        return ResponseEntity.badRequest().body(new ApiError(HttpStatus.BAD_REQUEST, message));
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<apierror> handleUserNotFound(UserNotFoundException ex) {
        return ResponseEntity.notFound().build(); // 或返回 new ApiError(HttpStatus.NOT_FOUND, ex.getMessage())
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<apierror> handleGenericException(Exception ex) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
                .body(new ApiError(HttpStatus.INTERNAL_SERVER_ERROR, "服务器处理出错"));
    }
}</apierror></apierror></apierror>

配合 Spring Validation 自动触发 400

在 Controller 方法参数上加 @Valid,配合实体类字段上的注解(如 @NotBlank、@Min),Spring 会自动抛 MethodArgumentNotValidException,无需手动 throw。

例如:

public class CreateUserRequest {
    @NotBlank(message = "用户名不能为空")
    private String username;
    @Min(value = 18, message = "年龄不能小于18")
    private int age;
    // getter/setter
}

@PostMapping("/users")
public User createUser(@Valid @RequestBody CreateUserRequest request) {
    return userService.create(request);
}

若请求中 username 为空,直接返回 400 和提示信息。

避免 500 泄露敏感信息

生产环境切勿把堆栈或数据库错误详情直接返回给前端:

  • 日志中记录完整异常(用 log.error("API error", ex))
  • 响应体只返回用户友好的提示,如“操作失败,请稍后重试”
  • 可对不同环境做区分:开发时返回简要原因,生产时固定模糊提示

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9577

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6722

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5972

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1044

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1256

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2509

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19851

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习