@ExceptionHandler for type Exception not called for Spring exception in custom ResponseEntityExceptionHandler

Question

After reading some blog posts about making a custom exception handler for Spring, I wrote the following class:

@ControllerAdvice
public class RestExceptionHandler extends ResponseEntityExceptionHandler {
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ResponseEntity<Object> exceptionHandler(Exception e) {
        HashMap<String, Object> msg = new HashMap<>(2);
        msg.put("error", HttpStatus.PRECONDITION_FAILED.value());
        msg.put("message", "Something went wrong");
        return new ResponseEntity<>(msg, HttpStatus.BAD_REQUEST);
    }
}

The intent is to send msg in the JSON response instead of giving away the Spring exception what was thrown for whatever reason.

This class isn't working, however.

When I hit, say, and invalid endpoint for my server API, I get the default response payload:

{
  "timestamp": 1449238700342,
  "status": 405,
  "error": "Method Not Allowed",
  "exception": "org.springframework.web.HttpRequestMethodNotSupportedException",
  "message": "Request method 'POST' not supported",
  "path": "/bad_enpoint"
}

What am I missing?

Thanks.

Can you elaborate on "isnt't working"? It doesn't get called? It does, but it fails? — Rafal G.
– Rafal G., Commented Nov 15, 2016 at 21:03
I updated the question with more info. It doesn't get called, I still the Spring default JSON back with the Spring expection being "exposed" — sargas
– sargas, Commented Nov 15, 2016 at 21:04

Rafal G. · Accepted Answer · 2016-11-15 21:13:15Z

3

Your handler will not be called because you want to map Exception to your custom error response but Spring MVC most likely already has one exception handler registered for Exception class. It also has one that handles HttpRequestMethodNotSupportedException for sure.

It is not a great idea however, to overwrite entire Spring MVC exception handling/mapping anyway. You should only care about specific exceptions - ones that you define.

Please read this article for a bit more insight into Spring MVC exception handling.

answered Nov 15, 2016 at 21:13

Rafal G.

4,4401 gold badge29 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

sargas Over a year ago

Thanks for the article, I'm fine with Spring having its own handlers. I don't like, however, the fact that Spring gives away too much about the internals of an application by sending a response with stuff like "exception": "org.springframework.web.HttpRequestMethodNotSupportedException",

Rafal G. Over a year ago

Ok it is a valid point. Try to add @Order annotation with the HIGHEST PRECEDENCE set. See this answer: stackoverflow.com/questions/19498378/…

sargas Over a year ago

This link to the use of @Order is exactly what I needed.

Valeriy · Accepted Answer · 2021-03-25 16:13:46Z

2

You don't need to extend ResponseEntityExceptionHandler to make it work.
Setting two HttpStatuses is reaaaaaly bad idea.

    @ControllerAdvice
    public class RestExceptionHandler  {
        @ExceptionHandler(value = Exception.class)
        @ResponseBody
        public ResponseEntity<String> exceptionHandler(Exception e) {
            return new ResponseEntity<>("Something went wrong", HttpStatus.BAD_REQUEST);
        }
    }

edited Mar 25, 2021 at 16:13

Valeriy

1,4453 gold badges22 silver badges47 bronze badges

answered Nov 15, 2016 at 20:18

Piotr Sołtysiak

1,0066 silver badges13 bronze badges

5 Comments

sargas Over a year ago

I still get the same JSON response (see bottom of my question) instead of "Something went wrong"

Piotr Sołtysiak Over a year ago

The @ControllerAdvice is aspect for controllers. Your AJAX call didn't even get to controller - from response I guess you don't have POST implemented on /bad_enpoint controller (or no controller at all)

sargas Over a year ago

I have a @RestController class that defines the endpoints. Should @RestController and @ControllerAdvice be annotated on the same class?

Piotr Sołtysiak Over a year ago

No, consider @ControllerAdvice class as aspect for all controllers. Could you paste your @RestController class?

sargas Over a year ago

Unfortunately I can't, it is a proprietary application. Thank you for your help.

Collectives™ on Stack Overflow

@ExceptionHandler for type Exception not called for Spring exception in custom ResponseEntityExceptionHandler

2 Answers 2

3 Comments

5 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

5 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related