Springboot2.0中处理自定义异常并返回json的方法是什么

在Spring Boot 2.0中，处理自定义异常并返回JSON格式的响应是一个常见的需求。通过这种方式，我们可以为客户端提供更加友好和结构化的错误信息。本文将详细介绍如何在Spring Boot 2.0中实现这一功能。

1. 为什么需要自定义异常处理？

在Web应用程序中，异常处理是一个非常重要的部分。默认情况下，Spring Boot会将未捕获的异常转换为HTTP 500错误，并返回一个简单的错误页面。然而，这种方式并不适合现代RESTful API，因为客户端通常期望得到一个结构化的JSON响应，而不是一个HTML页面。

通过自定义异常处理，我们可以：

• 为不同的异常类型返回不同的HTTP状态码。
• 返回结构化的错误信息，方便客户端解析和处理。
• 统一异常处理逻辑，减少重复代码。

2. 实现自定义异常处理

在Spring Boot 2.0中，我们可以通过以下几种方式来实现自定义异常处理并返回JSON响应：

2.1 使用@ControllerAdvice和@ExceptionHandler

@ControllerAdvice是一个全局异常处理注解，它可以捕获所有控制器中抛出的异常。结合@ExceptionHandler注解，我们可以为特定的异常类型定义处理方法。

2.1.1 创建自定义异常类

首先，我们需要定义一个自定义异常类。这个类可以继承RuntimeException，并包含一些额外的字段来存储错误信息。

public class CustomException extends RuntimeException {
    private int code;
    private String message;

    public CustomException(int code, String message) {
        super(message);
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }
}

2.1.2 创建全局异常处理器

接下来，我们创建一个全局异常处理器类，并使用@ControllerAdvice注解标记它。在这个类中，我们可以使用@ExceptionHandler注解来处理特定的异常类型。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    @ResponseBody
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse(500, "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

在这个例子中，我们定义了两个异常处理方法：

• handleCustomException：处理CustomException类型的异常，并返回一个包含错误代码和消息的ErrorResponse对象。
• handleException：处理所有其他类型的异常，并返回一个通用的错误响应。

2.1.3 创建错误响应类

ErrorResponse类用于封装错误信息，并将其转换为JSON格式。

public class ErrorResponse {
    private int code;
    private String message;

    public ErrorResponse(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }
}

2.2 使用@RestControllerAdvice

@RestControllerAdvice是@ControllerAdvice和@ResponseBody的组合注解，它可以直接返回JSON响应，而不需要额外的@ResponseBody注解。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<ErrorResponse> handleCustomException(CustomException ex) {
        ErrorResponse errorResponse = new ErrorResponse(ex.getCode(), ex.getMessage());
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse errorResponse = new ErrorResponse(500, "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

2.3 使用ErrorController

除了使用@ControllerAdvice和@ExceptionHandler，我们还可以通过实现ErrorController接口来自定义错误处理逻辑。

2.3.1 创建自定义ErrorController

import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;

@RestController
public class CustomErrorController implements ErrorController {

    @RequestMapping("/error")
    public ResponseEntity<ErrorResponse> handleError(HttpServletRequest request) {
        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
        Exception exception = (Exception) request.getAttribute("javax.servlet.error.exception");

        if (exception instanceof CustomException) {
            CustomException customException = (CustomException) exception;
            ErrorResponse errorResponse = new ErrorResponse(customException.getCode(), customException.getMessage());
            return new ResponseEntity<>(errorResponse, HttpStatus.valueOf(statusCode));
        }

        ErrorResponse errorResponse = new ErrorResponse(500, "Internal Server Error");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    @Override
    public String getErrorPath() {
        return "/error";
    }
}

在这个例子中，我们实现了ErrorController接口，并重写了getErrorPath方法。在handleError方法中，我们可以根据请求中的错误信息来生成相应的错误响应。

3. 测试自定义异常处理

为了测试我们的自定义异常处理逻辑，我们可以创建一个简单的控制器，并在其中抛出CustomException。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class TestController {

    @GetMapping("/test")
    public String test() {
        throw new CustomException(400, "This is a custom exception");
    }
}

当我们访问/api/test时，Spring Boot会捕获CustomException，并返回一个JSON格式的错误响应：

{
    "code": 400,
    "message": "This is a custom exception"
}

4. 总结

在Spring Boot 2.0中，处理自定义异常并返回JSON响应是一个相对简单的过程。通过使用@ControllerAdvice、@ExceptionHandler、@RestControllerAdvice或ErrorController，我们可以轻松地实现全局异常处理，并为客户端提供结构化的错误信息。

无论选择哪种方式，关键是要确保异常处理逻辑清晰、统一，并且能够为客户端提供有用的错误信息。通过这种方式，我们可以提高应用程序的健壮性和用户体验。