spring-boot自定义异常返回

上文测试开发专题:spring-boot统一异常捕获我们讨论了java异常以及如何使用Spring-Boot捕获异常,但是没有去说捕获异常后该如何进一步处理,这篇文章我们将对这个遗留的问题进行讨论.

统一错误响应定义

我们希望在程序发生异常的时候,能够给用户返回一个比较友好且明确的信息,对于api接口来说,一种比较好的格式是json,类似于下面这种格式

{
	"code": "10001",
	"message": "消息",
	"uri":"Get /v2/banner"
}

所以需要一个对象来描述这种数据格式：

public class UnifyResponse {
    private int code;
    private String message;
    private String requestUri;

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

错误响应处理

上文我们谈到从开发者的角度来说，异常分为已知异常和未知异常，针对不同的异常使用不同的异常处理函数进行处理，我们之前定义两个处理函数

@ControllerAdvice
public class GlobalExceptionAdvice {

    /**
     * 处理未知异常
     * @param req
     * @param ex
     */
    @ExceptionHandler(value = Exception.class)
    public void handleHttpException(HttpServletRequest req, Exception ex){
        System.out.println("发生异常了");
    }

    /**
     * 处理已知异常
     * @param req
     * @param ex
     */
    @ExceptionHandler(value = HttpException.class)
    public void handleHttpException(HttpServletRequest req, HttpException ex){

        System.out.println("发生了 HttpException");
    }
}

当未知异常发生时，需要将异常信息存储进 UnifyResponse，序列化后返回给用户

@ExceptionHandler(value = Exception.class)
    public UnifyResponse handleHttpException(HttpServletRequest req, Exception ex){
        String uri = req.getRequestURI();
        String method = req.getMethod();
        System.out.println(ex.getMessage());
        return new UnifyResponse(9999, "服务器错误", method + " " + uri);
    }

对于未知异常我们也不知道发生了什么，所以这里的code码就定义一个通用的，虽然Exception里面有message，但是这里不建议将这个异常里的message返回给用户，这位可能涉及到代码结构的一些东西，而且即使将这个信息返回给前端，他也不知道是啥问题，没什么意义，所以可以将这个message写到日志里，方便后面问题查询。

返回给用户的message可以自定义一个通用的，比如服务器错误什么的。

我们来测试一下，在Controller里抛出一个Exception：

 @RequestMapping(value = "/v2/banner", method = {RequestMethod.GET})
    public String test() throws Exception{
        throw new Exception("我抛出来的");
    }

然后再浏览器里访问，发现出错了