spring boot 异常统一处理

今天完成的事情

异常统一处理

异常在web开发中我们是再熟悉不过了,没学习spring boot之前出现异常没有用一个统一的处理方法,并且没有根据不同的异常来给出不同的提示,在spring boot 这里如果出现异常会出现下面这个页面:

spring boot 默认错误页面

这个页面对用户不是很友好,因为错误是什么引起的,用户不知道。所以需要一个针对不同的异常给出不同的提示信息。下面以一个小demo来演示如何统一处理不同的异常。

1.创建全局异常处理类

  • @ControllerAdvice定义统一的异常处理类
  • @ExceptionHandler定义针对不同异常的处理方法
  • 最后将异常对象和出异常的url映射到erroe.html的错误页面中
package com.baidu.ch8mybatis.exception;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;

/**
 * @author huangdongjiang
 * @date 2018/8/29 22:52
 */
@ControllerAdvice
public class GlobalExceptionHandler {

    private static final String DEFAULT_ERROR_VIEM = "error";

    @ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(HttpServletRequest request, Exception e) {
        System.out.println("进入异常中心。。。............................");
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("exception", e);
        modelAndView.addObject("url", request.getRequestURL());
        modelAndView.setViewName(DEFAULT_ERROR_VIEM);
        return modelAndView;
    }
}

2.写一个显示异常的错误页面:
error.html




    
    统一异常处理


Error Handler

3.写一个Controller来测试一下

package com.baidu.ch8mybatis.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author huangdongjiang
 * @date 2018/8/30 0:08
 */
@Controller
public class Hello {
    @RequestMapping("/hello")
    public String hello() throws Exception {
        System.out.println("抛出异常.......................................");
        throw new Exception("访问的页面忙");
    }
}

直接访问:http://localhost:8080/hello可以看到效果:(markdown截图比较麻烦,我就不截自己的错误页面图了,下面这张图是在博客的教程直接拿过来的)

image

另外,如果我们做的是RESTful的接口,那就不能直接返回html页面,而是返回json格式的数据,那这时应该怎么统一处理异常呢?做法如下:

1.把返回给页面的信息封装成一个ErrorInfo对象

package com.baidu.ch8mybatis.exception;

/**
 * @author huangdongjiang
 * @date 2018/8/30 0:40
 */
public class ErrorInfo {
    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方法
}

2.根据不同的错误自定义异常

package com.baidu.ch8mybatis.exception;

/**
 * @author huangdongjiang
 * @date 2018/8/30 0:43
 */
public class MyException extends Exception {

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

3.在统一异常处理类里面加上我们处理自定义异常的方法,这里跟非RESTful接口不同的地方是在方法上面加上@ResponseBody注解,让其返回json格式的数据

@ExceptionHandler(value = MyException.class)
@ResponseBody
public ErrorInfo jsonErrorHandler(HttpServletRequest request, MyException e) {
        //把错误给封装起来,返回错误对象的json格式数据
        ErrorInfo r = new ErrorInfo<>();
        r.setCode(ErrorInfo.ERROR);
        r.setMessage(e.getMessage());
        r.setUrl(request.getRequestURL().toString());
        r.setData("Some Data");
        return r;
}

4.测试

package com.baidu.ch8mybatis.controller;

import com.baidu.ch8mybatis.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @author huangdongjiang
 * @date 2018/8/30 0:45
 */
@Controller
public class HelloController {

    @RequestMapping("/json")
    public String json() throws MyException {
        throw new MyException("不好,出错啦...");
    }
}

经过测试返回的确是json格式的数据

明天计划的事情

1.学下权限认证

遇到的问题

暂无

收获

如上

你可能感兴趣的:(spring boot 异常统一处理)