Spring MVC 自定义异常处理器扩展

前言

在Spring MVC中，extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers)方法允许开发者在保留默认异常处理器的基础上，扩展额外的异常处理逻辑。与configureHandlerExceptionResolvers不同，使用extendHandlerExceptionResolvers不会覆盖或替换系统默认提供的异常处理器，这为自定义处理逻辑提供了更大的灵活性。

1. 配置异常处理器扩展

通过extendHandlerExceptionResolvers方法，可以在默认异常处理器的基础上添加自定义的处理逻辑。以下是一个自定义异常处理器扩展的示例：

@Override
public void extendHandlerExceptionResolvers(List<HandlerExceptionResolver> resolvers) {
    // 向Spring MVC的异常处理器列表中添加自定义的异常处理器
    resolvers.add(myExceptionResolver());
}

@Bean
public MyExceptionResolver myExceptionResolver() {
    // 返回自定义异常处理器的实例
    return new MyExceptionResolver();
}

2. 自定义异常处理器实现

自定义异常处理器可以通过实现HandlerExceptionResolver接口或继承AbstractHandlerExceptionResolver类来实现。以下是一个简单的自定义异常处理器：

public class MyExceptionResolver extends AbstractHandlerExceptionResolver {

    @Override
    protected ModelAndView doResolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        try {
            // 设置HTTP状态码
            response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
            // 输出异常信息到响应
            response.getWriter().write("Custom Error: " + ex.getMessage());
        } catch (IOException e) {
            e.printStackTrace();
        }
        // 返回空的ModelAndView，表示异常已经被处理，不需要进一步处理
        return new ModelAndView();
    }
}

3. 关键配置参数与实现说明

• extendHandlerExceptionResolvers 方法：用于在Spring MVC默认的异常处理器基础上，添加额外的处理器。此方法不会替换默认处理器，而是扩展其行为。

• add 方法：通过将自定义处理器添加到resolvers列表中，可以确保新处理器在默认处理器之后执行，从而提供额外的异常处理逻辑。

• doResolveException 方法：该方法是异常处理的核心部分，可以自定义处理异常的方式。例如，设置特定的HTTP状态码、输出自定义错误信息等。

4. 自定义异常处理器的执行顺序

当多个异常处理器被注册时，它们的执行顺序是按照在列表中的添加顺序进行的。如果一个异常处理器成功处理了异常（返回非空的ModelAndView），则后续的处理器将不会再执行。因此，自定义处理器在列表中的位置非常关键。

在使用extendHandlerExceptionResolvers时，自定义处理器通常会被添加到默认处理器的后面，这意味着它只会在默认处理器未能处理异常的情况下生效。

5. 测试自定义异常处理器

创建一个简单的控制器方法来模拟异常，测试自定义处理器是否正常工作：

@RestController
public class TestController {

    @GetMapping("/testException")
    public String testException() {
        // 模拟抛出异常以测试自定义异常处理器
        throw new RuntimeException("This is a test exception!");
    }
}

访问http://localhost:8080/testException，应当返回自定义的错误消息，如Custom Error: This is a test exception!。

6. 使用场景与注意事项

• 扩展而非替换：extendHandlerExceptionResolvers适合在保留默认处理逻辑的基础上，增加自定义的处理逻辑。
• 顺序控制：确保自定义处理器的顺序正确，以免影响系统默认的异常处理流程。
• 应用场景：可以用于处理特定的业务异常、记录日志、返回特定格式的错误响应等。

总结

通过extendHandlerExceptionResolvers方法，Spring MVC提供了在默认处理器之上扩展异常处理逻辑的能力。这种方式既保留了系统默认的健壮性，又提供了灵活性，允许开发者根据具体需求添加额外的处理规则。