{"id":58916,"date":"2023-10-04T08:30:39","date_gmt":"2023-10-04T03:00:39","guid":{"rendered":"https:\/\/2thenew.xyz\/blog\/?p=58916"},"modified":"2024-01-02T17:37:04","modified_gmt":"2024-01-02T12:07:04","slug":"custom-exceptional-handling-using-controlleradvice","status":"publish","type":"post","link":"https:\/\/2thenew.xyz\/blog\/custom-exceptional-handling-using-controlleradvice\/","title":{"rendered":"Custom Exceptional Handling using ControllerAdvice"},"content":{"rendered":"

\"Blog<\/p>\n

Here, we can see in the above image that the product is not present for this product ID. But we are getting proper 200 status. which is not a proper understandable response.<\/p>\n

Let\u2019s understand why we need Custom Exceptional Handing<\/strong><\/h2>\n

Using @ControllerAdvice<\/code> in Spring allows you to create a centralized exception handler that can handle exceptions thrown by controllers in your application. This is a powerful feature for custom exception handling. Here’s a step-by-step guide on how to implement custom exception handling using @ControllerAdvice<\/code> in Spring:<\/p>\n

Step 1: Create Custom Exception Classes<\/strong><\/h3>\n

Create custom exception classes that extend RuntimeException<\/code> Or a suitable base exception class. For example:<\/p>\n

public<\/span> class<\/span> ProductNotFoundException<\/span> extends<\/span> RuntimeException<\/span> {\r\n    public<\/span> ProductNotFoundException<\/span>(String message)<\/span> {\r\n        super<\/span>(message);\r\n    }\r\n}<\/span><\/pre>\n
public<\/span> class<\/span> InvalidRequestException<\/span> extends<\/span> RuntimeException<\/span> {\r\n    public<\/span> InvalidRequestException<\/span>(String message)<\/span> {\r\n        super<\/span>(message);\r\n    }\r\n}<\/span><\/pre>\n
You can create as many custom exception classes as needed for different error scenarios.<\/p>\n
Step 2: Create a Global Exception Handler<\/strong><\/h3>\n
Create a global exception handler class annotated with @ControllerAdvice<\/code>. This class will contain methods to handle various exceptions.<\/p>\n
Here’s an example:<\/p>\n
@ControllerAdvice<\/span>\r\npublic<\/span> class<\/span> GlobalExceptionHandler<\/span> {\r\n\r\n    @ExceptionHandler(ProductNotFoundException.class)<\/span>\r\n    public<\/span> ResponseEntity<String> handleProductNotFoundException<\/span>(ProductNotFoundException ex)<\/span> {\r\n        return<\/span> new<\/span> ResponseEntity<\/span><>(ex.getMessage(), HttpStatus.NOT_FOUND);\r\n    }\r\n\r\n    @ExceptionHandler(InvalidRequestException.class)<\/span>\r\n    public<\/span> ResponseEntity<String> handleInvalidRequestException<\/span>(InvalidRequestException ex)<\/span> {\r\n        return<\/span> new<\/span> ResponseEntity<\/span><>(ex.getMessage(), HttpStatus.BAD_REQUEST);\r\n    }\r\n\r\n    @ExceptionHandler(Exception.class)<\/span>\r\n    public<\/span> ResponseEntity<String> handleOtherExceptions<\/span>(Exception ex)<\/span> {\r\n        return<\/span> new<\/span> ResponseEntity<\/span><>(\"An error occurred: \"<\/span> + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);\r\n    }\r\n}<\/span><\/pre>\n
In this example, we\u2019ve created three exception-handling methods: one for handling ProductNotFoundException<\/code>, one for handling InvalidRequestException<\/code>, and another for handling general exceptions. These methods return appropriate HTTP response statuses and error messages.<\/p>\n
Step 3: Throw Custom Exceptions in Your Controllers<\/strong><\/h3>\n
In your controller methods, throw custom exceptions when needed. For example:<\/p>\n
@RestController<\/span>\r\n@RequestMapping(\"\/api\/products\")<\/span>\r\npublic<\/span> class<\/span> ProductController<\/span> {\r\n    @Autowired<\/span>\r\n    private<\/span> ProductService productService;\r\n\r\n    @GetMapping(\"\/{id}\")<\/span>\r\n    public<\/span> ResponseEntity<Product> getProductById<\/span>(@PathVariable<\/span> Long id)<\/span> {\r\n        Product<\/span> product<\/span> =<\/span> productService.getProductById(id);\r\n        if<\/span> (product == null<\/span>) {\r\n            throw<\/span> new<\/span> ProductNotFoundException<\/span>(\"Product not found with ID: \"<\/span> + id);\r\n        }\r\n        return<\/span> ResponseEntity.ok(product);\r\n    }\r\n\r\n    @PostMapping<\/span>\r\n    public<\/span> ResponseEntity<String> createProduct<\/span>(@RequestBody<\/span> Product product)<\/span> {\r\n        if<\/span> (product == null<\/span>) {\r\n            throw<\/span> new<\/span> InvalidRequestException<\/span>(\"Invalid product request\"<\/span>);\r\n        }\r\n        productService.createProduct(product);\r\n        return<\/span> ResponseEntity.status(HttpStatus.CREATED).body(\"Product created successfully\"<\/span>);\r\n    }\r\n    \/\/ Other controller methods<\/span>\r\n}<\/span><\/pre>\n
In this example, when a product is not found (getProductById<\/code>) or an invalid request is made (createProduct<\/code>), we throw custom exceptions (ProductNotFoundException<\/code> and InvalidRequestException<\/code>).<\/p>\n
Step 4: Test the Exception Handling<\/strong><\/h3>\n
Now, when you access your RESTful endpoints and an exception is thrown, the global exception handler will catch the exception and return the appropriate HTTP status and error message.<\/p>\n
For example, if you make a GET request to \/api\/products\/123<\/code>, and a product with ID 123 is not found, the response will have a status code of 404 (NOT FOUND) and an error message like “Product not found with ID: 123.”<\/p>\n
By following these steps, you\u2019ve added custom exception handling using @ControllerAdvice<\/code> in your Spring Boot application, allowing you to handle specific exceptions gracefully and provide meaningful error responses to clients.<\/p>\n
\n
\n
\"Blog<\/div>\n<\/div>\n<\/figure>\n
After we fix this issue, we’ll be getting a proper response. You can have a look at the code here on github<\/a>.<\/p>\n
You can comment down below or email me your queries.<\/p>\n
<\/div>","protected":false},"excerpt":{"rendered":"
Here, we can see in the above image that the product is not present for this product ID. But we are getting proper 200 status. which is not a proper understandable response. Let\u2019s understand why we need Custom Exceptional Handing Using @ControllerAdvice in Spring allows you to create a centralized exception handler that can handle […]<\/p>\n","protected":false},"author":1507,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":37,"footnotes":""},"categories":[446,1994,3109],"tags":[5489],"class_list":["post-58916","post","type-post","status-publish","format-standard","hentry","category-java","category-software-development","category-user-experience","tag-exceptionalhandling"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t