Spring MVC: how to intercept 404 before returning error page/response?

Question

In my Spring Boot 2.2.x web application I need to intercept 404 errors so I can execute some custom logic before the error page is rendered or the json with error info is returned.

What's the correct way to achieve this?

At the moment I'm trying with a @ControllerAdvice class, but I don't know which exception to handle with the @ExceptionHandler method (if any is thrown)...

NOTE: I have already tried to intercept NoHandlerFoundException, but this doesn't seem to work... (the handler is not triggered).

@ControllerAdvice
public class ErrorHandler {
    @ExceptionHandler(NoHandlerFoundException.class)
    public void handleException() {
        System.out.println("It's a 404!");
    }
}

I also enabled this in my application.properties:

spring.mvc.throw-exception-if-no-handler-found=true

Any other suggestion?

Does this answer your question? [Handle error 404 with Spring controller](https://stackoverflow.com/questions/13356549/handle-error-404-with-spring-controller) — N. berouain, Jan 22 '20 at 08:50
`NoHandlerFoundException` as mentioned by one of answer below is good choice. — Vishwa Ratna, Jan 22 '20 at 08:52
@VishwaRatna I can't intercept this exception using ExceptionHandler. The handler is not triggered. — davioooh, Jan 22 '20 at 09:08

davioooh · Accepted Answer · 2020-01-22T11:06:30.717

I finally found the solution (or part of it) in this question: Custom exception handler for NoHandlerFoundException is not working without @EnableWebMvc

By default Spring doesn't throw an exception for 404 errors. You need to enable this property in application.properties (or yaml):

spring.mvc.throw-exception-if-no-handler-found=true

But you also need to set this property:

spring.mvc.static-path-pattern: /static

This restriction prevents Spring to search for static contents matching the missing path/handler.

Now you can intercept a NoHandlerFoundException as usual with @ExceptionHandler.

NOTE Before setting the spring.mvc.static-path-pattern property I tried to add @EnableWebMvc to a configuration class in my project: this way the NoHandlerFoundException was thrown but I obviously lost all the Spring Boot autoconfigurations.

score 1 · Answer 2 · answered Jan 22 '20 at 08:50

1

Use NoHandlerFoundException. This maps to 404 in spring boot.

answered Jan 22 '20 at 08:50

Prashant

4,775
3
28
47

I added the ErrorHandler code to my question. At the moment in my project I have just this class and the Application class to start the app. – davioooh Jan 22 '20 at 10:37

score 0 · Answer 3 · answered Jan 22 '20 at 08:52

In the same class you use @ControllerAdvice implement ErrorController.

@ControllerAdvice
public class ControllerAdvice implements ErrorController {

    @RequestMapping("/error")
    public ResponseEntity<Map> handleError(HttpServletResponse response) {
        Map errorMapJson = new HashMap();

        if(response.getStatus() == HttpStatus.NOT_FOUND.value()) {
            errorMapJson.put("type", "404 Error");
        }

        return new ResponseEntity<Map>(errorMapJson, HttpStatus.NOT_FOUND);
    }

    @Override
    public String getErrorPath() {
        return "/error";
    }
}

Spring MVC: how to intercept 404 before returning error page/response?

3 Answers3