Sping 4 异常处理

Posted 2020-08-21

异常与HTTP状态码的映射（@ResponseStatus）

Spring默认会将自身抛出的异常自动映射到合适的状态码，如下是一些示例：

举个例子，当后端抛出如下异常（TypeMismatchException异常，往方法传参时，类型不匹配）：

org.springframework.beans.TypeMismatchException: Failed to convert value of type \'java.lang.String\' to required type \'long\'; nested exception is java.lang.NumberFormatException: For input string: "2l"
    at org.springframework.beans.TypeConverterSupport.doConvert(TypeConverterSupport.java:77)
    at org.springframework.beans.TypeConverterSupport.convertIfNecessary(TypeConverterSupport.java:47)
    at org.springframework.validation.DataBinder.convertIfNecessary(DataBinder.java:603)
...

前台返回400状态码：

除了以上异常，对于其它异常以及我们业务自己抛出的异常，如果没有明确绑定Http状态码，响应默认都会带有500状态码。

当然，除了这些默认机制，我们也可以将自定义异常绑定特点的Http状态码，通过@ResponseStatus注解可实现，如下示例：

 定义一个异常，通过@ResponseStatus注解绑定400状态码：

@ResponseStatus(value = HttpStatus.NOT_FOUND)
public class MyException extends RuntimeException
{

}

然后再controller抛出自定义异常throw new MyException();

访问controller，发现响应确实返回了400状态码。

控制器中的异常处理方法（@ExceptionHandler）

异常处理方法能处理同一个controller中所有方法抛出的异常，如下示例：

我们在controller下添加了一个MyException异常的处理方法，直接返回到body。

    @ExceptionHandler(MyException.class)
    @ResponseBody
    public String handleException(){
        return "handle by ExceptionHandler.";
    }

打开浏览器，观察结果：

控制器通知（@ControllerAdvice）

异常处理方法只能处理同一个controller中抛出的异常，然而一个系统，肯定不止一个controller，总不可能在每个controller中都添加重复性的异常处理方法吧~~

那么对于多个controller，如何处理异常呢？使用@ControllerAdvice注解即可。

带有@ControllerAdvice注解的类，可以收到系统中所有Controller抛出的异常，如下示例：

@ControllerAdvice
public class DSSExceptionHandler extends BaseController
{

    /**
     * 处理controller抛出的异常
     *
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public String handleException(HttpServletRequest request, Exception e)
    {
        logger.error("Request FAILD, URL = {} ", request.getRequestURI());
        logger.error(e.toString(), e);
        return gson.toJson(BaseController.FAILD);
    }

    /**
     * 处理controller抛出的异常
     *
     * @return
     */
    @ExceptionHandler(NumberFormatException.class)
    @ResponseBody
    public String handleNumberFormatException(HttpServletRequest request, NumberFormatException e)
    {
        logger.error("Request FAILD, URL = {} ", request.getRequestURI());
        logger.error(e.toString(), e);
        return gson.toJson(BaseController.FAILD);
    }

}

有一个点注意下，就是spring 扫描配置的时候，要包括该bean，我的配置如下，可参考：

spring-mvc.xml：

    <context:component-scan base-package="com.cetiti.epdc.dss" >
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>  
        <context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice"/> 
    </context:component-scan> 

spring.xml

    <context:component-scan base-package="com.cetiti.epdc.dss">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" />
        <context:exclude-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice" />
    </context:component-scan>

另外，在上面的示例中，范围更小的异常，优先级更大，所以会调用handleNumberFormatException方法。

参考资料

spring in action 4