Spring Boot中Web应用的统一异常处理

最新推荐文章于 2024-08-13 10:48:29 发布

天蓝Skyline

最新推荐文章于 2024-08-13 10:48:29 发布

阅读量3.4k

点赞数

分类专栏： spring 文章标签： spring-boot 异常处理

spring 专栏收录该内容

16 篇文章 0 订阅

订阅专栏

我们在做Web应用的时候，请求处理过程中发生错误是非常常见的情况。Spring Boot提供了一个默认的映射：/error，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容。

选择一个之前实现过的Web应用（Chapter3-1-2）为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如：

@RequestMapping("/hello")
public String hello() throws Exception {
    throw new Exception("发生错误");
}

此时，可以看到类似下面的报错页面，该页面就是Spring Boot提供的默认error映射页面。

alt=默认的错误页面

统一异常处理

虽然，Spring Boot中实现了默认的error映射，但是在实际应用中，上面你的错误页面对用户来说并不够友好，我们通常需要去实现我们自己的异常提示。

下面我们以之前的Web应用例子为基础（Chapter3-1-2），进行统一异常处理的改造。

创建全局异常处理类：通过使用@ControllerAdvice定义统一的异常处理类，而不是在每个Controller中逐个定义。@ExceptionHandler用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到error.html中

@ControllerAdvice
class GlobalExceptionHandler {

    public static final String DEFAULT_ERROR_VIEW = "error";

    @ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        ModelAndView mav = new ModelAndView();
        mav.addObject("exception", e);
        mav.addObject("url", req.getRequestURL());
        mav.setViewName(DEFAULT_ERROR_VIEW);
        return mav;
    }

}

实现error.html页面展示：在templates目录下创建error.html，将请求的URL和Exception对象的message输出。

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title>统一异常处理</title>
</head>
<body>
    <h1>Error Handler</h1>
    <div th:text="${url}"></div>
    <div th:text="${exception.message}"></div>
</body>
</html>

启动该应用，访问：http://localhost:8080/hello，可以看到如下错误提示页面。

alt=自定义的错误页面

通过实现上述内容之后，我们只需要在Controller中抛出Exception，当然我们可能会有多种不同的Exception。然后在@ControllerAdvice类中，根据抛出的具体Exception类型匹配@ExceptionHandler中配置的异常类型来匹配错误映射和处理。

返回JSON格式

在上述例子中，通过@ControllerAdvice统一定义不同Exception映射到不同错误处理页面。而当我们要实现RESTful API时，返回的错误是JSON格式的数据，而不是HTML页面，这时候我们也能轻松支持。

本质上，只需在@ExceptionHandler之后加入@ResponseBody，就能让处理函数return的内容转换为JSON格式。

下面以一个具体示例来实现返回JSON格式的异常处理。

创建统一的JSON返回对象，code：消息类型，message：消息内容，url：请求的url，data：请求返回的数据

public class ErrorInfo<T> {

    public static final Integer OK = 0;
    public static final Integer ERROR = 100;

    private Integer code;
    private String message;
    private String url;
    private T data;

    // 省略getter和setter

}

创建一个自定义异常，用来实验捕获该异常，并返回json

public class MyException extends Exception {

    public MyException(String message) {
        super(message);
    }

}

Controller中增加json映射，抛出MyException异常

@Controller
public class HelloController {

    @RequestMapping("/json")
    public String json() throws MyException {
        throw new MyException("发生错误2");
    }

}

为MyException异常创建对应的处理

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = MyException.class)
    @ResponseBody
    public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
        ErrorInfo<String> r = new ErrorInfo<>();
        r.setMessage(e.getMessage());
        r.setCode(ErrorInfo.ERROR);
        r.setData("Some Data");
        r.setUrl(req.getRequestURL().toString());
        return r;
    }

}

启动应用，访问：http://localhost:8080/json，可以得到如下返回内容：

{
    code: 100，
    data: "Some Data"，
    message: "发生错误2"，
    url: "http://localhost:8080/json"
}

至此，已完成在Spring Boot中创建统一的异常处理，实际实现还是依靠Spring MVC的注解，更多更深入的使用可参考Spring MVC的文档。

示例：

自定义jsonException：

package com.xp.adconfms.exception;

/**
 * Created by Skyline on 2017/5/4.
 */
public class JsonException extends Exception {

    public JsonException(String message) {
        super(message);
    }

}

异常信息：

package com.xp.adconfms.exception;

/**
 * Created by Skyline on 2017/5/4.
 */
public class ErrorInfo<T> {

    public static final Integer OK = 0;
    public static final Integer ERROR = 500;

    public Integer code;
    public String message;
    public String url;
    public T data;

}

捕获异常：

package com.xp.adconfms.exception;

import com.cc.ccutils.JsonUtils;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;

/**
 *
 * 自定义异常页面展示
 * Created by Skyline on 2017/5/4.
 */
@ControllerAdvice
public class GlobalExceptionHander {

    //采用spring-boot 默认的映射/error
    public static final String DEFAULT_ERROR_VIEW = "error";

    /**
     *
     * 捕获@RequestMapping注解的方法抛出的Exception异常并处理：
     * 若是ajax请求或请求端接受json数据则返回json信息；否则转发（forward）到默认的/error映射，error.html页面展示信息,因为是forward所以不用再经过拦截器处理。
     * 若是去掉该方法或者去掉注解@ExceptionHandler，则spring-boot对异常的处理：302重定向到到默认的错误异常处理映射/error,因为是302重定向，
     * 所以会经过拦截器处理。
     * @param req
     * @param e
     * @return
     * @throws Exception
     */
    @ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(HttpServletRequest req, HttpServletResponse res, Exception e) throws Exception {

        String accept = req.getHeader("Accept");

        String requestType = req.getHeader("X-Requested-With");
        boolean ajax = (requestType != null && requestType.equalsIgnoreCase("XMLHttpRequest")) ? true : false;
        if(ajax || accept.contains("json")) {     //ajax请求或者请求端接受json数据
            ErrorInfo<String> r = new ErrorInfo<>();
            r.message = e.getMessage();
            r.code = ErrorInfo.ERROR;
            r.url = req.getRequestURL().toString();
            PrintWriter writer = res.getWriter();
            writer.write(JsonUtils.toJson(r));
            writer.flush();
            writer.close();
            return null;
        } else {
            ModelAndView mav = new ModelAndView();
            mav.addObject("exception", e);
            mav.addObject("url", req.getRequestURL());
            mav.setViewName(DEFAULT_ERROR_VIEW);
            return mav;
        }
    }


    /**
     * 会优先处理JsonException异常
     * 返回json格式
     * @param req
     * @param e
     * @return
     * @throws Exception
     */
    @ExceptionHandler(value = JsonException.class)
    @ResponseBody
    public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, JsonException e) throws Exception {
        ErrorInfo<String> r = new ErrorInfo<>();
        r.message = e.getMessage();
        r.code = ErrorInfo.ERROR;
        r.url = req.getRequestURL().toString();
        return r;
    }


}