详解使用Spring MVC统一异常处理实战

下面我将为您讲解一下使用 Spring MVC 统一异常处理的完整攻略。

一、概述

在开发过程中，我们经常会遇到各种异常情况，如空指针、数据库连接超时、网络异常等。如果不加处理直接让这些异常直接抛出，会给用户带来不好的用户体验。因此，我们需要对这些异常进行统一处理，以便更好的提示给用户。

Spring MVC 提供了一种统一处理异常的方式，即通过定义一个异常处理器来处理所有的异常。这个处理器可以捕获所有的异常，然后返回一个特定的错误信息给客户端。本文将对如何使用 Spring MVC 进行统一异常处理进行详解。

二、实现步骤

1. 定义一个全局异常处理器类

我们需要定义一个类，继承 ResponseEntityExceptionHandler 类。这个类中包含了一些默认的处理方法，我们可以重写它们。其中，最常用的是 handleExceptionInternal 方法。这个方法包含了所有的异常信息，我们可以在这里进行全局的异常处理。

@ControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(Throwable.class)
    public ResponseEntity<Object> handleExceptionInternal(Throwable ex, Object body, HttpHeaders headers, HttpStatus status, WebRequest request) {
        return new ResponseEntity<>(new ErrorResponse(ex.getMessage()), status);
    }

}

2. 创建一个异常响应类

我们需要创建一个包含异常信息的类，用来返回给客户端。在这个类中，我们可以定义一些具体的错误码、错误信息以及当前时间等信息。

public class ErrorResponse {
    private String error;
    private String message;
    private String timestamp;

    public ErrorResponse(String message) {
        this.error = "Server error";
        this.message = message;
        this.timestamp = new Date().toString();
    }

    //...
}

3. 在 web.xml 中配置异常处理器

我们需要在 web.xml 中配置我们的异常处理器。这样 Spring MVC 才能自动扫描到我们定义的异常处理器类，从而进行全局异常处理。

<context-param>
    <param-name>contextClass</param-name>
    <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
</context-param>

<context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>com.example</param-value>
</context-param>

<servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextClass</param-name>
        <param-value>org.springframework.web.context.support.AnnotationConfigWebApplicationContext</param-value>
    </init-param>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>com.example.config.MyWebMvcConfig</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

<!-- 配置全局异常处理器 -->
<error-page>
    <location>/error</location>
</error-page>

4. 编写一个控制器

最后，我们编写一个简单的控制器来测试全局异常处理器。

@Controller
public class MyController {

    @RequestMapping("/exception")
    public void exceptionTest() {
        throw new RuntimeException("This is a runtime exception.");
    }

    //...
}

三、实例应用

下面为您介绍两个具体的实例应用。

1. 自定义异常处理

我们可以自定义一个异常类，并把它抛出。然后在全局异常处理器中捕获这个异常，返回一个特定的错误码和错误信息。

public class MyException extends RuntimeException {

    private String code;
    private String message;

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

    //...
}

@ControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    @ExceptionHandler(value = MyException.class)
    public ResponseEntity<Object> handleMyException(MyException ex, WebRequest request) {
        return new ResponseEntity<>(new ErrorResponse(ex.getMessage()), HttpStatus.INTERNAL_SERVER_ERROR);
    }

    //...
}

@Controller
public class MyController {

    @RequestMapping("/myException")
    public void myExceptionTest() {
        throw new MyException("001", "This is a self-defined exception.");
    }

    //...

}

2. 使用统一的返回格式

在实际项目中，我们可能需要统一的返回格式。在这种情况下，我们可以使用一个基本的响应类。这个响应类中包含了所有需要返回的信息，如请求返回码、错误信息、当前时间等。

public class BaseResponse<T> {
    private int code;
    private String message;
    private T data;
    private String timestamp;

    public BaseResponse(T data) {
        this.code = HttpStatus.OK.value();
        this.message = "success";
        this.data = data;
        this.timestamp = new Date().toString();
    }

    //...
}

@ControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    /**
     * 自定义异常处理
     */
    @ExceptionHandler(value = MyException.class)
    public ResponseEntity<BaseResponse<Object>> handleMyException(MyException ex, WebRequest request) {
        BaseResponse<Object> response = new BaseResponse<>(null);
        response.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value());
        response.setMessage(ex.getMessage());
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }

    /**
     * 全局异常处理
     */
    @ExceptionHandler(Throwable.class)
    public ResponseEntity<BaseResponse<Object>> handleExceptionInternal(Throwable ex, Object body, HttpHeaders headers, HttpStatus status, WebRequest request) {
        BaseResponse<Object> response = new BaseResponse<>(null);
        response.setCode(HttpStatus.INTERNAL_SERVER_ERROR.value());
        response.setMessage(ex.getMessage());
        return new ResponseEntity<>(response, status);
    }

    //...
}

@Controller
public class MyController {

    @RequestMapping("/myException")
    @ResponseBody
    public BaseResponse<Object> myExceptionTest() {
        throw new MyException("001", "This is a self-defined exception.");
    }

    //...

}

四、总结

通过对 Spring MVC 统一异常处理的详细讲解，我们了解到了如何使用 Spring MVC 实现全局异常处理。我们可以自定义异常类，并把它抛出，在全局异常处理器中捕获这个异常，返回一个特定的错误码和错误信息，实现统一的异常处理。此外，我们还可以使用统一的返回格式，让我们的代码更加规范、可维护。