关于Spring统一异常处理及说明

 更新时间:2022年09月30日 10:47:42   作者:融极  
这篇文章主要介绍了关于Spring统一异常处理及说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

相关注解概述

通过使用@RestControllerAdvice或@ControllerAdvice定义统一的异常处理类,而不是在每个Controller中逐个定义;

  • @RestControllerAdvice:返回Json格式数据;
  • @ControllerAdvice:返回视图类型数据;
  • @ResponseBody:和Controller方法上的用法一样,会将方法中返回值转换成Json格式后返回给客户端;
  • @ExceptionHandler:用来定义函数针对的异常类型,最后将Exception对象和请求URL映射到返回结果中;用于注释异常处理类,value属性指定需要拦截的异常类型。
  • spring应用启动后,被@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法,都会作用在被@RequestMapping注解的方法上。
  • 全局捕获异常的原理:使用AOP切面技术。
  • 用@RequestBody,就解决了JSon自动绑定。

全局异常依赖包

由于全局捕获异常使用的是AOP切面技术,需要直接或间接导入aop的jar包。

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

示例

import com.terse.develop.utils.exception.AdminException;
import com.terse.develop.utils.exception.MsgResultException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.web.HttpRequestMethodNotSupportedException;
import org.springframework.web.bind.ServletRequestBindingException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.io.IOException;
import java.net.ConnectException;
import java.util.List;
import java.util.Set;

/**
 * 全局异常处理
 */
@RestControllerAdvice
@ResponseBody
public class ExceptionHandlerController {

    private static final Logger logger = LoggerFactory.getLogger(ExceptionHandlerController1.class);

    public static void print(Exception ex) {
        logger.error(ex.toString());
        ex.printStackTrace();
    }

    //Http请求方式不支持
    @ExceptionHandler(value = HttpRequestMethodNotSupportedException.class)
    public Exception HttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
        print(e);
        return new Exception("Http请求方式不支持");
    }

    /**
     * MsgResultException、AdminException 均为自定义异常类
     */
    @ExceptionHandler(value = {MsgResultException.class, AdminException.class})
    public Exception exception(Exception e) {
        print(e);
        if (e instanceof MsgResultException)
            //捕获什么异常信息就返回给前端什么信息
            return new MsgResultException(((MsgResultException) e).getMsg());
        else
            //只返回给后端"请重试"
            return new AdminException("请重试");
    }

    //request Body 读取异常
    @ExceptionHandler(value = HttpMessageNotReadableException.class)
    public Exception httpMessageNotReadableException(HttpMessageNotReadableException e) {
        print(e);
        return new Exception("请检查数据是否正确");
    }

    //参数类型转换异常
    @ExceptionHandler(value = MethodArgumentTypeMismatchException.class)
    public Exception getNumberException(MethodArgumentTypeMismatchException e) {
        print(e);
        return new Exception("String类型不能转换成数字类型");
    }

    /**
     * 校验基本类型
     */
    @ExceptionHandler(value = ConstraintViolationException.class)
    public Exception ConstraintViolationExceptionHandler(ConstraintViolationException ex) {
        Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
        String msg = null;
        for (ConstraintViolation<?> cvl : constraintViolations) {
            msg = cvl.getMessageTemplate();
        }
        logger.error(msg);
        return new Exception(msg);
    }

    //缺少参数异常
    @ExceptionHandler(value = ServletRequestBindingException.class)
    public Exception ServletRequestBindingException(ServletRequestBindingException e) {
        print(e);
        return new Exception("缺少参数");
    }

    /**
     * 校验对象类型
     */
    @ExceptionHandler(value = BindException.class)
    public Exception BindExceptionHandler(BindException bindException) {
        List<FieldError> fieldErrors = bindException.getFieldErrors();
        String msg = null;
        for (FieldError fieldError : fieldErrors) {
            msg = fieldError.getDefaultMessage();
        }
        return new Exception(msg);
    }

    //请求异常
    @ExceptionHandler(value = ConnectException.class)
    public Exception connectException(ConnectException e) {
        print(e);
        return new Exception("服务器异常,请联系管理员");
    }

    //IO流异常
    @ExceptionHandler(value = IOException.class)
    public Exception ioException(IOException e) {
        e.printStackTrace();
        return new Exception("IO流处理异常,请联系管理员");
    }

}

@ExceptionHandler注解使用方法

基本使用方法

Spring的@ExceptionHandler可以用来统一处理方法抛出的异常

比如这样:

@ExceptionHandler()
public String handleExeption2(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:默认";
    return resultStr;
}

当我们使用这个@ExceptionHandler注解时,我们需要定义一个异常的处理方法,比如上面的handlerException2()方法,给这个方法加上@ExceptionHandler注解,这个方法就好处理被@RequestMapping注解方法抛出的异常。

注解的参数

@ExceptionHandler注解中可以添加参数,参数是某个异常类的class,代表这个方法专门处理该类异常

比如:

@ExceptionHandler(NumberFormatException.class)
public String handleExeption(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:NumberFormatException";
    return resultStr;
}

此时注解的参数是NumberFormatException.class,表示只有方法抛出NumberFormatException时,才会调用该方法。

异常类型就近原则

当异常发生时,Spring会选择最接近抛出异常类型的处理方法。

比如之前提到的NumberFormatException,这个异常有父类RuntimeException,RuntimeException还有父类Exception,如果我们分别定义异常处理方法,@ExceptionHandler分别使用这三个异常作为参数

比如:

@ExceptionHandler(NumberFormatException.class)
public String handleExeption(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:NumberFormatException";
    return resultStr;
}
 
@ExceptionHandler()
public String handleExeption2(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:默认";
    return resultStr;
}
 
@ExceptionHandler(RuntimeException.class)
public String handleExeption3(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:RuntimeException";
    return resultStr;
}

那么,当代码抛出NumberFormatException时,调用的方法将是注解参数NumberFormatException.class的方法,也就是handleExeption(),而当代码抛出IndexOutOfBoundsException时,调用的方法将是注解参数RuntimeException的方法,也就是handleExeption3()。

注解方法的返回值

标识了@ExceptionHandler注解的方法,返回值类型和标识了@RequestMapping的方法是统一的,可参见@RequestMapping的说明,比如默认返回Spring的ModelAndView对象,也可以返回String,这时的String是ModelAndView的路径,而不是字符串本身。

有些情况下我们会给标识了@RequestMapping的方法添加@ResponseBody,比如使用Ajax的场景,直接返回字符串,异常处理类也可以如此操作,添加@ResponseBody注解后,可以直接返回字符串

比如这样:

@ExceptionHandler(NumberFormatException.class)
@ResponseBody
public String handleExeption(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:NumberFormatException";
    return resultStr;
}

这样的操作可以在执行完方法后直接返回字符串本身。

注解使用错误举例

使用@ExceptionHandler时尽量不要使用相同的注解参数。

如果我们定义两个处理相同异常的处理方法:

@ExceptionHandler(NumberFormatException.class)
@ResponseBody
public String handleExeption(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:NumberFormatException";
    return resultStr;
}
 
@ExceptionHandler(NumberFormatException.class)
@ResponseBody
public String handleExeption2(Exception ex) {
    System.out.println("抛异常了:" + ex);
    ex.printStackTrace();
    String resultStr = "异常:默认";
    return resultStr;
}

两个方法都处理NumberFormatException,这种定义方式编译可以通过,而当NumberFormatException真正被抛出时

Spring会给我们报错:

java.lang.IllegalStateException: Ambiguous @ExceptionHandler method mapped for [class java.lang.NumberFormatException]: {public java.lang.String TestController.handleExeption(java.lang.Exception), public java.lang.String TestController.handleExeption2(java.lang.Exception)}
    at org.springframework.web.method.annotation.ExceptionHandlerMethodResolver.addExceptionMapping(ExceptionHandlerMethodResolver.java:102) ~[spring-web-5.0.5.RELEASE.jar:5.0.5.RELEASE]
...

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 解决java数值范围以及float与double精度丢失的问题

    解决java数值范围以及float与double精度丢失的问题

    下面小编就为大家带来一篇解决java数值范围以及float与double精度丢失的问题。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • Jar包反编译修改代码后重新打jar包图文详解

    Jar包反编译修改代码后重新打jar包图文详解

    这篇文章主要给大家介绍了关于Jar包反编译修改代码后重新打jar包的相关资料,JAR文件就是Java Archive(Java档案文件),它是 Java的一种文档格式,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-07-07
  • JVM Tomcat性能实战(推荐)

    JVM Tomcat性能实战(推荐)

    下面小编就为大家带来一篇JVM Tomcat性能实战(推荐)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-05-05
  • java中struts 框架的实现

    java中struts 框架的实现

    本文给大家介绍的是java中struts 框架的实现,有需要的小伙伴可以参考下。
    2015-06-06
  • MyBatis Xml映射文件之字符串替换方式

    MyBatis Xml映射文件之字符串替换方式

    这篇文章主要介绍了MyBatis Xml映射文件之字符串替换方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • springboot项目中统一时间格式处理方法

    springboot项目中统一时间格式处理方法

    JacksonConfiguration主要用于配置JSON的序列化和反序列化,而LocalDateTimeFormatter则用于处理请求和响应中的LocalDateTime格式,这两个配置项在SpringBoot项目中至关重要,确保数据格式的正确处理和传输
    2024-10-10
  • Java设计模式之单例设计模式解析

    Java设计模式之单例设计模式解析

    这篇文章主要介绍了Java设计模式之单例设计模式解析,设计模式是在大量的实践中总结和理论化之后优选的代码结构、编程风格、以及解决问题的思考方式,设计模式免去我们自己再思考和摸索,需要的朋友可以参考下
    2023-11-11
  • Java 定时器的多种实现方式

    Java 定时器的多种实现方式

    本文介绍了Java中定时器的多种实现方式,有此需求的朋友可以根据实际选择适合自己的方式
    2021-06-06
  • 对Netty组件的基本介绍

    对Netty组件的基本介绍

    这篇文章主要介绍了对Netty组件的基本介绍,Netty是基于Java NIO client-server的网络应用框架,使用Netty可以快速开发网络应用,本文涵盖了netty开发中主要的组件的介绍,需要的朋友可以参考下
    2021-06-06
  • springboot接入微信app支付的方法

    springboot接入微信app支付的方法

    本文使用springboot集成微信支付服务,包含微信统一支付订单接口,以及支付回调接口等,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-05-05

最新评论