SpringBoot(十二):全局异常处理

  发布时间:   文章分类:Java 浏览数: 15

文章来源: aodeng.cc/archives/springboots......, 本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。

本作品采用 知识共享署名 4.0 国际许可协议 进行许可。

本文作者:低调小熊猫

文章链接: https://aodeng.cc/archives/springbootshiers

转载声明:自由转载-非商用-非衍生-保持署名,非商业转载请注明作者及出处,商业转载请联系作者本人qq:2696284032

简介

通常在Controller层需要去捕获service层的异常,防止返回一些不友好的错误信息到客户端,但如果Controller层每个方法都用模块化的try-catch代码去捕获异常,会很难看也难维护,所以使用全局异常比较方便

这方法是springboot封装好了的,我们直接使用即可,普通的配置我就不贴了

使用

配置类

/**
 * @program:hope
 * @author:aodeng
 * @create:2018-10-10 14:15
 **/
@RestControllerAdvice //该注解将异常以 json 格式输出
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler{
    /***
     *定义要普获的异常
     * @param request
     * @param e
     * @param response
     * @return
     */
    @ExceptionHandler(CustomException.class)
    public ExceptionEntity customExceptionEntity(HttpServletRequest request, final Exception e, HttpServletResponse response){
        response.setStatus(HttpStatus.BAD_REQUEST.value());
        CustomException customException=(CustomException)e;
        return new ExceptionEntity(customException.getCode(),customException.getMessage());
    }

    /***
     * 捕获  RuntimeException 异常
     * 如果你觉得在一个 exceptionHandler 通过  if (e instanceof xxxException) 太麻烦
     * 那么你还可以自己写多个不同的 exceptionHandler 处理不同异常
     * @param request
     * @param e
     * @param response
     * @return
     */
    @ExceptionHandler(RuntimeException.class)
    public ExceptionEntity runtimeExceptionEntity(HttpServletRequest request,final Exception e,HttpServletResponse response){
        response.setStatus(HttpStatus.BAD_REQUEST.value());
        RuntimeException runtimeException=(RuntimeException)e;
        return new ExceptionEntity(400,runtimeException.getMessage());
    }

    /***
     * Override ResponseEntityExceptionHandler类中的handleExceptionInternal方法
     * 通用的接口映射异常处理方
     * @param e
     * @param o
     * @param httpHeaders
     * @param httpStatus
     * @param webRequest
     * @return
     */
    @Override
    protected ResponseEntity<Object> handleExceptionInternal(Exception e, Object o, HttpHeaders httpHeaders,
                                                    HttpStatus httpStatus, WebRequest webRequest){
        if (e instanceof MethodArgumentNotValidException){
            MethodArgumentNotValidException methodArgumentNotValidException=(MethodArgumentNotValidException)e;
            return new ResponseEntity<>(new ExceptionEntity(httpStatus.value(),methodArgumentNotValidException.getBindingResult().getAllErrors().get(0).getDefaultMessage()),httpStatus);
        }
        if(e instanceof MethodArgumentTypeMismatchException){
            MethodArgumentTypeMismatchException methodArgumentTypeMismatchException=(MethodArgumentTypeMismatchException)e;
            logger.error("参数转换失败,方法:"+methodArgumentTypeMismatchException.getParameter().getMethod().getName()+",参数:"+
            methodArgumentTypeMismatchException.getName()+",信息:"+methodArgumentTypeMismatchException.getLocalizedMessage());
            return new ResponseEntity<>(new ExceptionEntity(httpStatus.value(),"参数转换失败"),httpStatus);
        }
        return new ResponseEntity<>(new ExceptionEntity(httpStatus.value(),"参数转换失败"),httpStatus);
    }
}

创建CustomException 继承 RuntimeException类

public class CustomException extends RuntimeException{
    private static final long serialVersionUID = -8400239090334588012L;
    private int code;

    public CustomException(){
        super();
    }

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

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}

创建ErrorResponseEntity实体类,用存放异常信息

public class CustomException extends RuntimeException{
    private static final long serialVersionUID = -8400239090334588012L;
    private int code;

    public CustomException(){
        super();
    }
    //忽略get,set
}

测试

@RestController
public class TestController {

    @GetMapping("/test")
    public String test(Integer number){
        if (null == number){
            throw new CustomException(110,"number不能为空,其实是400");
        }
        int i=100/ number;
        return "你输入的数字缩小100倍是:"+i;
    }
}

以上所述就是小编给大家介绍的《SpringBoot(十二):全局异常处理》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 Coder·码农网 的支持!

码农可能感兴趣的文章:

本文永久链接:www.codercto.com/a/30638.html

相关码农书籍:
Linux Shell脚本攻略

Linux Shell脚本攻略

(印)拉克什曼 / 门佳 / 人民邮电出版社 / 2011-11 / 49.00元

《Linux Shell脚本攻略》通过细致剖析实际应用中的110多个案例,使许多看似复杂的Linux shell脚本任务迎刃而解。《Linux Shell脚...

相关码农工具:
SQL 格式化/压缩工具

SQL 格式化/压缩工具

SQL 在线格式化/压缩工具

URL 编码/解码

URL 编码/解码

URL 编码/解码

图片转BASE64编码

图片转BASE64编码

在线图片转Base64编码工具