@ControllerAdvice for global handling in Spring Boot

Introduction

@ControllerAdvice helps you handle errors or special cases in one place for all your web controllers. It keeps your code clean and organized.

You want to show a friendly error message for all errors in your app.

You need to log exceptions from any controller in one place.

You want to customize the response when a user sends bad data.

You want to apply the same rules or responses for multiple controllers.

You want to handle specific exceptions globally without repeating code.

Syntax

Spring Boot

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleAllExceptions(Exception ex) {
        return new ResponseEntity<>("Error: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

@ControllerAdvice marks the class as a global handler for controllers.

@ExceptionHandler inside it defines which exceptions to catch and handle.

Examples

This handles only NullPointerException globally and returns a 400 error.

Spring Boot

@ControllerAdvice
public class GlobalHandler {

    @ExceptionHandler(NullPointerException.class)
    public ResponseEntity<String> handleNullPointer(NullPointerException ex) {
        return new ResponseEntity<>("Null value found", HttpStatus.BAD_REQUEST);
    }
}

This handles multiple exception types in one method.

Spring Boot

@ControllerAdvice
public class GlobalHandler {

    @ExceptionHandler({IllegalArgumentException.class, IllegalStateException.class})
    public ResponseEntity<String> handleBadRequests(RuntimeException ex) {
        return new ResponseEntity<>("Bad request: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
    }
}

Sample Program

This example has a controller that throws an error when you visit /error. The @ControllerAdvice class catches that error and returns a friendly message with status 500.

Spring Boot

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class DemoController {

    @GetMapping("/error")
    public String throwError() {
        throw new RuntimeException("Something went wrong");
    }
}

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<String> handleRuntimeException(RuntimeException ex) {
        return new ResponseEntity<>("Global error handled: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

Important Notes

You can have multiple @ExceptionHandler methods for different exceptions.

@ControllerAdvice can also be used to add global data to all controllers or handle validation errors.

Make sure your exception handler methods return proper HTTP status codes for better API design.

Summary

@ControllerAdvice lets you handle errors for all controllers in one place.

Use @ExceptionHandler inside it to catch specific exceptions globally.

This keeps your code clean and improves user experience with consistent error messages.

Practice

1. What is the main purpose of using @ControllerAdvice in a Spring Boot application?

easy

A. To handle exceptions globally for all controllers in one place

B. To define REST endpoints for the application

C. To configure database connections

D. To create scheduled tasks

Solution

1. Step 1: Understand the role of @ControllerAdvice

   @ControllerAdvice is a special annotation in Spring Boot that allows you to write code to handle exceptions or apply logic across all controllers globally.

2. Step 2: Identify its main use

   Its main use is to centralize exception handling so you don't have to repeat error handling code in every controller.

3. Final Answer:

   To handle exceptions globally for all controllers in one place -> Option A

4. Quick Check:

   @ControllerAdvice = global exception handling [OK]

Hint: Think global error handling for all controllers [OK]

Common Mistakes:

• Confusing @ControllerAdvice with @RestController
• Thinking it configures database or tasks
• Assuming it defines endpoints

2. Which of the following is the correct way to declare a global exception handler method inside a @ControllerAdvice class?

easy

A. @Service public String handleError() { return "error"; }

B. @ExceptionHandler(Exception.class) public String handleError() { return "error"; }

C. @GetMapping public String handleError() { return "error"; }

D. @RequestMapping("/error") public String handleError() { return "error"; }

Solution

1. Step 1: Identify the annotation for exception handling

   The correct annotation to handle exceptions globally is @ExceptionHandler with the exception class specified.

2. Step 2: Check method signature and annotation usage

   @ExceptionHandler(Exception.class) public String handleError() { return "error"; } uses @ExceptionHandler(Exception.class) which is correct inside a @ControllerAdvice class to catch all exceptions.

3. Final Answer:

   @ExceptionHandler(Exception.class) public String handleError() { return "error"; } -> Option B

4. Quick Check:

   @ExceptionHandler = global exception method [OK]

Hint: Use @ExceptionHandler with exception class inside @ControllerAdvice [OK]

Common Mistakes:

• Using @RequestMapping or @GetMapping instead of @ExceptionHandler
• Missing exception class in @ExceptionHandler
• Using @Service annotation incorrectly

3. Given the following code snippet, what will be the HTTP response status when a NullPointerException is thrown in any controller?

@ControllerAdvice
public class GlobalExceptionHandler {
  @ExceptionHandler(NullPointerException.class)
  public ResponseEntity<String> handleNullPointer() {
    return new ResponseEntity<>("Null pointer error", HttpStatus.BAD_REQUEST);
  }
}

medium

A. 400 Bad Request with message "Null pointer error"

B. 500 Internal Server Error with default message

C. 200 OK with message "Null pointer error"

D. 404 Not Found with message "Null pointer error"

Solution

1. Step 1: Analyze the @ExceptionHandler method

   The method handles NullPointerException and returns a ResponseEntity with message "Null pointer error" and status BAD_REQUEST.

2. Step 2: Understand HTTP status returned

   HttpStatus.BAD_REQUEST corresponds to 400 status code, so the response will have status 400 with the given message.

3. Final Answer:

   400 Bad Request with message "Null pointer error" -> Option A

4. Quick Check:

   @ExceptionHandler returns 400 status [OK]

Hint: Check ResponseEntity status in @ExceptionHandler method [OK]

Common Mistakes:

• Assuming default 500 error instead of specified status
• Confusing 400 with 200 OK
• Ignoring the returned ResponseEntity status

4. Consider this @ControllerAdvice class:

@ControllerAdvice
public class GlobalHandler {
  @ExceptionHandler(IllegalArgumentException.class)
  public String handleIllegalArgument() {
    return "illegal";
  }

  @ExceptionHandler(Exception.class)
  public String handleAll() {
    return "error";
  }
}

What is the problem if a NullPointerException occurs in a controller?

medium

A. NullPointerException is not handled and causes server error

B. handleIllegalArgument() method will handle NullPointerException incorrectly

C. handleAll() method will handle NullPointerException correctly

D. Compilation error due to multiple @ExceptionHandler methods

Solution

1. Step 1: Identify exception handlers and their scopes

   handleIllegalArgument() handles IllegalArgumentException only; handleAll() handles all Exceptions as a fallback.

2. Step 2: Determine which method handles NullPointerException

   Since NullPointerException is not IllegalArgumentException, handleAll() will catch it as it handles Exception class.

3. Final Answer:

   handleAll() method will handle NullPointerException correctly -> Option C

4. Quick Check:

   More specific handlers first, then general Exception handler [OK]

Hint: General @ExceptionHandler(Exception.class) catches all others [OK]

Common Mistakes:

• Thinking NullPointerException is unhandled
• Assuming multiple handlers cause compile error
• Confusing which handler matches which exception

5. You want to create a global error handler that returns JSON with error details for all exceptions except ResourceNotFoundException, which should return 404 status with a custom message. How should you implement this using @ControllerAdvice?

hard

A. Use a single @ExceptionHandler(Exception.class) method and check exception type inside to return different responses

B. Use @ControllerAdvice only for ResourceNotFoundException and ignore other exceptions

C. Handle ResourceNotFoundException in each controller separately, and use @ControllerAdvice only for other exceptions

D. Create two @ExceptionHandler methods: one for ResourceNotFoundException returning 404 JSON, another for Exception returning generic JSON with 500 status

Solution

1. Step 1: Understand requirement for specific and general handling

   You need one handler for ResourceNotFoundException with 404 and custom JSON, and another for all other exceptions with generic 500 JSON.

2. Step 2: Implement two separate @ExceptionHandler methods in @ControllerAdvice

   One method annotated with @ExceptionHandler(ResourceNotFoundException.class) returns 404 JSON; another with @ExceptionHandler(Exception.class) returns 500 JSON.

3. Final Answer:

   Create two @ExceptionHandler methods: one for ResourceNotFoundException returning 404 JSON, another for Exception returning generic JSON with 500 status -> Option D

4. Quick Check:

   Separate handlers for specific and general exceptions [OK]

Hint: Use multiple @ExceptionHandler methods for different exceptions [OK]

Common Mistakes:

• Using one method with manual type checks inside
• Handling specific exceptions in controllers, not globally
• Ignoring general exceptions in @ControllerAdvice