Setting Precedence of Multiple @ControllerAdvice @ExceptionHandlers

by

Is this how one would expect Spring MVC to behave?

As of Spring 4.3.7, here’s how Spring MVC behaves: it uses HandlerExceptionResolver instances to handle exceptions thrown by handler methods.

By default, the web MVC configuration registers a single HandlerExceptionResolver bean, a HandlerExceptionResolverComposite, which

delegates to a list of other HandlerExceptionResolvers.

Those other resolvers are

  1. ExceptionHandlerExceptionResolver
  2. ResponseStatusExceptionResolver
  3. DefaultHandlerExceptionResolver

registered in that order. For the purpose of this question we only care about ExceptionHandlerExceptionResolver.

An AbstractHandlerMethodExceptionResolver that resolves exceptions
through @ExceptionHandler methods.

At context initialization, Spring will generate a ControllerAdviceBean for each @ControllerAdvice annotated class it detects. The ExceptionHandlerExceptionResolver will retrieve these from the context, and sort them using using AnnotationAwareOrderComparator which

is an extension of OrderComparator that supports Spring’s Ordered
interface as well as the @Order and @Priority annotations, with an
order value provided by an Ordered instance overriding a statically
defined annotation value (if any).

It’ll then register an ExceptionHandlerMethodResolver for each of these ControllerAdviceBean instances (mapping available @ExceptionHandler methods to the exception types they’re meant to handle). These are finally added in the same order to a LinkedHashMap (which preserves iteration order).

When an exception occurs, the ExceptionHandlerExceptionResolver will iterate through these ExceptionHandlerMethodResolver and use the first one that can handle the exception.

So the point here is: if you have a @ControllerAdvice with an @ExceptionHandler for Exception that gets registered before another @ControllerAdvice class with an @ExceptionHandler for a more specific exception, like IOException, that first one will get called. As mentioned earlier, you can control that registration order by having your @ControllerAdvice annotated class implement Ordered or annotating it with @Order or @Priority and giving it an appropriate value.

More Related Contents:

  1. How to handle static content in Spring MVC?
  2. Serving static web resources in Spring Boot & Spring Security application
  3. Spring MVC: How to return image in @ResponseBody?
  4. Spring 3 MVC accessing HttpRequest from controller
  5. Spring MVC: Validation, Post-Redirect-Get, Partial Updates, Optimistic Concurrency, Field Security
  6. @ModelAttribute annotation, when to use it?
  7. tomcat server fails to start the server and application in STS [duplicate]
  8. CharacterEncodingFilter don’t work together with Spring Security 3.2.0
  9. Spring mvc @PathVariable
  10. Spring 5.0.3 RequestRejectedException: The request was rejected because the URL was not normalized
  11. How to create a Spring Interceptor for Spring RESTful web services
  12. Dynamic Selection Of JsonView in Spring MVC Controller
  13. ContentCachingResponseWrapper Produces Empty Response
  14. StrictHttpFirewall in spring security 4.2 vs spring MVC @MatrixVariable
  15. How to configure Spring Security to allow Swagger URL to be accessed without authentication
  16. Which is better, return “ModelAndView” or “String” on spring3 controller
  17. How to convert byte array to MultipartFile
  18. How to use “map.get(key)” in Thymeleaf – Broadleaf Ecom
  19. Is it possible to dynamically set RequestMappings in Spring MVC?
  20. Convert Unix timestamp to Java Date, Spring RequestParam
  21. Web-application context/ root application context and transaction manager setup
  22. ServletContext and Spring MVC
  23. Http Post with request content type form not working in Spring MVC 3
  24. What does do?
  25. Spring Boot exception: Could not open ServletContext resource [/WEB-INF/dispatcherServlet-servlet.xml]
  26. How to handle IO streams in Spring MVC
  27. Angular 2 Spring Boot Login CORS Problems
  28. How to handle DataIntegrityViolationException in Spring?
  29. Delete or put methods in thymeleaf
  30. Does Spring @RequestBody support the GET method?

Leave a Comment