SpringMVC 的三种异常处理方式详解

本文介绍: 异常处理在开发中的重要性不言而喻。通过全局异常处理，可以提高系统的可维护性、容错性和安全性，改善用户体验，方便系统监控和问题排查。在Spr in g MVC中，合理分类和处理应用程序异常和系统异常，使用自定义异常类和全局异常处理器，可以实现精细化的异常处理。配置SimpleMap pingExc ept ionRes ol v er 处理器和实现HandlerEx ce p t ionRes ol v er 接口是常见的实现方式。此外，响应封装类的使用可以统一响应数据格式，简化客户端处理逻辑，提供异常处理和多语言支持，增强应用程序的可维护性

1. 什么是异常

① 配置 SimpleMappingExceptionResolver 处理器

② 实现 HandlerExceptionResolver 接口

③ 使用@ControllerAdvice+@ExceptionHandler实现全局异常

6. 响应封装类

1. 什么是异常

见字如意，就是编码时所报的错误。异常主要分为两种：编译时异常和运行时异常Ru n timeEx ce ption。前者在编码时如不符合规范代码就会报红，是肉眼也看到的错，后者主要通过规范代码开发、测试通过手段减少运行时异常的发生。

在Spr i n g MVC中，异常处理是指对在请求处理过程中可能发生的异常情况进行捕获、处理和响应的机制。它能将所有类型的异常处理从各处理过程解耦出来，既保证了相关处理过程的功能较单一，也实现了异常信息的统一处理和维护。

2. 为什么要全局异常处理

在开发中，不管是da o层、service层还是 controller层，都有可能抛出异常。使用全局异常处理有以下几个优点：

统一的异常处理逻辑：通过全局异常处理，可以将应用程序中的异常处理逻辑集中到一个地方，避免在每个具体的业务代码中都编写相同或类似的异常处理代码。这样可以提高代码的可维护性，减少代码冗余，使代码更加清晰和易于理解。
提高系统的容错性：全局异常处理可以捕获应用程序中的未处理异常，避免异常的传递导致应用程序崩溃或出现未知错误。通过合理地处理异常，可以使系统在出现异常时保持稳定并继续正常运行，提高系统的容错性和健壮性。
统一的异常返回格式：全局异常处理可以定义统一的异常返回格式，将异常信息以一致的方式返回给客户端或用户。这样可以提供更友好和一致的错误提示，改善用户体验，并便于客户端对异常进行处理和展示。
安全性和安全漏洞的处理：全局异常处理可以捕获和处理应用程序中的安全漏洞或异常情况，例如未授权访问、非法操作等。通过适当的异常处理，可以防止一些潜在的安全问题，提高系统的安全性和防护能力。
异常日志记录和监控：全局异常处理可以统一记录应用程序中的异常信息，包括异常类型、发生位置、请求参数等，便于后续的异常分析、故障排查和系统监控。通过对异常进行有效的记录和监控，可以及时发现和解决潜在的问题，提高系统的可靠性和稳定性。

总的来说，全局异常处理能够提高系统的可维护性、容错性和安全性，提供更好的用户体验，方便系统的监控和问题排查。在开发应用程序时，合理利用全局异常处理机制可以有效地处理异常情况，保证应用程序的稳定。

3. Spr i n gMVC异常分类

在Spr i n g MVC中，异常可以分为两类：应用程序异常和系统异常。

应用程序异常：应用程序异常是指由应用程序自身业务逻辑引发的异常，通常是预期的异常情况。这些异常可以根据具体业务需求进行分类，例如用户输入验证失败、资源未找到、权限不足等。应用程序异常可以通过自定义异常类来表示，可以添加自定义的异常信息，以便更好地理解异常原因和处理异常。
系统异常：系统异常是指由系统运行环境或外部因素引发的异常，通常是非预期的异常情况。这些异常可能包括数据库连接失败、网络连接异常、服务器内部错误等。系统异常是无法通过应用程序自身的逻辑来解决的，需要通过合适的异常处理机制来捕获和处理。

在Spr i n g MVC中，可以通过合理的异常分类和处理机制来对应用程序异常和系统异常进行区分和处理。通常，应用程序异常可以通过@ExceptionHandler注解或自定义的异常处理器来处理，而系统异常可以通过全局异常处理器（HandlerExceptionResolver接口的实现）来捕获和处理。这样可以实现对不同类型异常的精细处理，提高系统的可靠性和用户体验。

4. 异常处理思路

系统的da o、serv ic e、controller 出现异常都通过throw s Ex ce ption 向上抛出，最后由springmvc 前端控制器交由异常处理器进行异常处理。springmvc提供全局异常处理器（一个系统只有一个异常处理器）进行统一异常处理。

确定异常处理的范围和层级：首先，需要确定异常处理的范围，即异常处理应该放在哪个层级。在Spr i n g MVC中，异常处理可以发生在Co nt roll er层、Se r v ic e层或DAO层，具体取决于你的应用架构和需求。一般来说，应用程序异常可以在Co nt roll e r层处理，而系统异常可以在全局异常处理器中处理。
定义异常类：根据你的应用程序需求，可以定义自定义的异常类来表示不同类型的异常。自定义异常类可以继承自Exception或RuntimeException，并添加适当的属性和方法，以便更好地描述异常信息。例如，你可以定义一个ValidationException来表示用户输入验证失败的异常。
异常捕获和处理：在代码中，使用try-catch块来捕获可能发生的异常，并在catch块中进行相应的处理。对于应用程序异常，可以在Co nt roll e r层的方法中使用@ExceptionHandler注解来捕获和处理特定类型的异常。对于系统异常，可以在全局异常处理器中实现HandlerExceptionResolver接口，并在resolveException方法中进行异常处理逻辑。
异常处理逻辑：在异常处理逻辑中，你可以根据具体的异常类型采取适当的处理措施。例如，对于应用程序异常，可以返回特定的错误页面或错误信息给用户，或者记录异常日志以便后续分析。对于系统异常，可以返回一个通用的错误页面或错误信息，或者进行一些系统级的异常处理操作。
异常信息传递和展示：在异常处理过程中，你可以将异常信息传递给前端页面或其他组件进行展示。可以通过ModelAndView对象、@ResponseBody注解或其他方式来传递异常信息。在展示异常信息时，可以根据具体需求进行格式化，以便用户能够清晰地理解异常原因。
单元测试和异常模拟：为了验证异常处理的正确性，建议编写相应的单元测试，并模拟各种异常情况。通过单元测试，可以确保异常处理逻辑的正确性和稳定性。

总结来说，异常处理的思路是根据异常类型进行分类，确定异常处理的范围和层级，定义自定义异常类，捕获和处理异常，并根据具体情况进行异常处理逻辑和异常信息展示。通过合理的异常处理，可以提高系统的可靠性。

5. 三种异常处理方式 示例

在演示下面之前我们现在没有进行异常处理事如何报错的：

1. 随便在那个方法或者 controller 手动写一个错误信息

2. 运行该路径

这就是没有经过任何异常处理的错误信息，如果将这个界面回显给客户当然是不可观的，请继续往下看。

① 配置 SimpleMap pin gExcepti onRes olver 处理器

Spr ingMVC中自带了一个异常处理器叫SimpleMap pin gExcepti onResolver，该处理器实现了HandlerExcepti onResolver 接口，全局异常处理器都需要实现该接口。

1. spring–mvc.xml：

    <!-- springmvc提供的简单异常处理器 --&gt;
    <bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">
        <!-- 定义默认的异常处理页面 -->
        <property name="defaultErrorView" value="error"/>
        <!-- 定义异常处理页面用来获取异常信息的变量名，也可不定义，默认名为exception -->
        <property name="exceptionAttribute" value="xw"/>
        <!-- 定义需要特殊处理的异常，这是重要点 -->
        <property name="exceptionMappings">
            <props>
                <prop key="java.lang.RuntimeException">error</prop>
            </props>
            <!-- 还可以定义其他的自定义异常 -->
        </property>
    </bean>

注：页面跳转由SpringMVC来接管了，所以此处的定义默认的异常处理页面都应该配置成逻辑视图名。

2. 创建 error.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<%--错误信息--%>
${xw}<br>
<img src="static/imgs/R.jpg">
</body>
</html>

配置异常处理后的界面：

② 实现 HandlerExceptionResolver 接口

1. 创建一个名为Glob alException的自定义异常类，它继承自RuntimeException类。

在Jav a中，自定义异常类通常需要继承自Exception类或其子类。RuntimeException是Exception的一个子类，它表示在程序执行过程中可能会发生的异常情况。通过继承RuntimeException类，Glob alException可以被视为一个非受检异常（unchecked exception），即在方法签名中不需要显式声明或捕获。

Glob alException类提供了多个构造函数，用于创建不同类型的异常对象。每个构造函数都调用了父类RuntimeException的相应构造函数，以便将异常信息传递给父类进行处理。

package com.ycxw.exception;

public class GlobalException extends RuntimeException {
    public GlobalException() {
    }

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

    public GlobalException(String message, Throwable cause) {
        super(message, cause);
    }

    public GlobalException(Throwable cause) {
        super(cause);
    }

    public GlobalException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }
}

通过提供不同的构造函数，GlobalException类可以在不同的情况下创建异常对象，并传递相关的异常信息和原因。

自定义异常类的好处在于可以根据应用程序的需求，定义特定类型的异常，以便更好地描述和处理不同的异常情况。在代码中，当某个方法或操作发生异常时，可以抛出GlobalException对象，并在上层进行相应的异常处理逻辑。

2. 定义了一个名为GlobalExceptionHandler的类，并实现了HandlerExceptionResolver接口。同时，使用@Component 注解将该类标记为一个Spring组件，以便在应用程序中进行自动扫描和注册。

@Component
public class GlobalExceptionHandler implements HandlerExceptionResolver {
    @Override
    public ModelAndView resolveException(HttpServletRequest httpServletRequest,
                                         HttpServletResponse httpServletResponse,
                                         Object o, Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.setViewName("error");
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            mv.addObject("xw",globalException.getMessage());
            mv.addObject("msg","全局异常....");
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            mv.addObject("xw",runtimeException.getMessage());
            mv.addObject("msg","运行时异常....");
        }
        return mv;
    }
}

这段代码定义了一个名为GlobalExceptionHandler的类，并实现了HandlerExceptionResolver接口。同时，使用@Component 注解将该类标记为一个Spring组件，以便在应用程序中进行自动扫描和注册。

HandlerExceptionResolver接口是Spring MVC框架提供的用于处理异常的接口。通过实现该接口，可以自定义全局异常处理器，用于捕获和处理在请求处理过程中产生的异常。

在代码中，resolveException方法是HandlerExceptionResolver接口的一个方法，用于处理异常。它接受HttpServletReque st、HttpServletResponse、Object和Exception等参数，并返回一个ModelAndView对象。

在方法内部，首先创建了一个空的ModelAndView对象mv。然后，设置了视图的名称为”error“，这意味着当发生异常时，将渲染名为”error“的视图。

接下来，通过instanceo f 判断异常的类型，进行不同的处理逻辑。如果异常是GlobalException类型，将异常信息和自定义的”全局异常….”消息添加到mv对象中。如果异常是RuntimeException类型，将异常信息和”运行时异常….”消息添加到mv对象中。

最后，将mv对象返回，以便框架将其渲染并返回给客户端。

通过实现HandlerExceptionResolver接口并定义resolveException方法，可以自定义全局异常处理逻辑，并在应用程序中统一处理异常情况。这样可以提供更好的用户体验，并减少代码中重复的异常处理代码。

利用上一个报错信息：

3. 抛出一个全局错误信息

③ 使用@Cont rollerAd vice+@ExceptionHandler实现全局异常

定义了一个名为GlobalExceptionResolver的类，并使用@Cont rollerAd vice注解将其标记为一个全局异常处理器。

package com.ycxw.exception;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
public class GlobalExceptionResolver {

// 返回错误json数据
    @ResponseBody
    @ExceptionHandler
    public Map handler(Exception e){
        Map map = new HashMap();
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            map.put("xw",globalException.getMessage());
            map.put("msg","全局异常....");
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            map.put("xw",runtimeException.getMessage());
            map.put("msg","运行时异常....");
        }else {
            map.put("xw",e.getMessage());
            map.put("msg","其它异常....");
        }
        return map;
    }
}

@ControllerAdvice是Spring MVC框架提供的注解，用于定义全局控制器增强。通过使用@ControllerAdvice注解，可以将该类应用于所有的控制器中，并提供统一的异常处理逻辑。

在代码中，使用@ResponseBod y 注解将handler方法标记为返回JSON数据的方法。@ExceptionHandler注解用于指定该方法处理的异常类型。

handler方法接受一个Exception类型的参数e，并返回一个Map对象。在方法内部，根据异常的类型进行不同的处理逻辑。

如果异常是GlobalException类型，将异常信息和自定义的”全局异常….”消息添加到map对象中。如果异常是RuntimeException类型，将异常信息和”运行时异常….”消息添加到map对象中。如果异常不属于上述两种类型，将异常信息和”其它异常….”消息添加到map对象中。

最后，将map对象作为JSON数据返回给客户端。

通过使用@ControllerAdvice注解和@ExceptionHandler注解，可以自定义全局异常处理逻辑，并将异常信息以JSON格式返回给客户端。这样可以提供更好的错误处理和异常信息展示方式。

6. 响应 封装类

响应封装类的作用是将响应数据进行统一的封装和格式化，以便在应用程序中进行统一的处理和返回给客户端。

通常，在一个应用程序中，不同的接口可能返回不同的数据结构和格式。这样会导致客户端在处理响应数据时需要编写大量的重复代码来解析和处理不同的响应格式，增加了开发和维护的复杂性。
为了解决这个问题，可以使用响应封装类来对响应数据进行统一的封装。响应封装类通常是一个自定义的类，其中包含了与响应相关的信息，如状态码、消息、数据等。
通过将响应数据封装到一个固定的数据结构中，可以使得所有的接口返回的响应数据格式保持一致。这样客户端只需要针对统一的响应数据结构进行处理，而不需要关注不同接口的具体返回格式。
响应封装类还可以提供额外的功能，如异常处理、错误码定义、多语言支持等。通过在响应封装类中定义统一的异常处理逻辑，可以捕获和处理应用程序中的异常，并将异常信息封装到响应数据中返回给客户端。同时，可以在响应封装类中定义错误码，并根据错误码进行国际化处理，以支持多语言环境下的错误提示。

总之，响应封装类的作用是提供一个统一的响应数据格式，简化客户端的处理逻辑，提供额外的功能如异常处理和多语言支持，并提高应用程序的可维护性和可扩展性。

例如：

package com.ycxw.utils;

import java.util.HashMap;

public class R extends HashMap {
    public R data(String key, Object value) {
        this.put(key, value);
        return this;
    }
 
    public static R ok(int code, String msg) {
        R r = new R();
        r.data("success", true).data("code", code).data("msg", msg);
        return r;
    }
 
    public static R error(int code, String msg) {
        R r = new R();
        r.data("success", false).data("code", code).data("msg", msg);
        return r;
    }
 
    public static R ok(int code, String msg,Object data) {
        R r = new R();
        r.data("success", true).data("code", code).data("msg", msg).data("data", data);
        return r;
    }
 
    public static R ok(int code, String msg, long count, Object data) {
        R r = new R();
        r.data("success", true).data("code", code).data("msg", msg).data("count", count).data("data", data);
        return r;
    }
}

编写统一响应方法：

    // 响应封装类
    @ResponseBody
    @ExceptionHandler
    public R handler(Exception e){
        if (e instanceof GlobalException){
            GlobalException globalException = (GlobalException) e;
            return R.ok(505,"全局异常....",globalException.getMessage());
        }else if (e instanceof RuntimeException){
            RuntimeException runtimeException = (RuntimeException) e;
            return R.ok(505,"运行时异常....",runtimeException.getMessage());
        }else {
            return R.ok(505,"其他异常....",e.getMessage());
        }
    }