DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
Securing Your Software Supply Chain with JFrog and Azure
Register Today

Trending

  • Knowing and Valuing Apache Kafka’s ISR (In-Sync Replicas)
  • A Complete Guide to Agile Software Development
  • Future of Software Development: Generative AI Augmenting Roles and Unlocking Co-Innovation
  • Observability Architecture: Financial Payments Introduction

Trending

  • Knowing and Valuing Apache Kafka’s ISR (In-Sync Replicas)
  • A Complete Guide to Agile Software Development
  • Future of Software Development: Generative AI Augmenting Roles and Unlocking Co-Innovation
  • Observability Architecture: Financial Payments Introduction
  1. DZone
  2. Coding
  3. Frameworks
  4. Global Exception Handling Using Spring @RestControllerAdvice in REST Services

Global Exception Handling Using Spring @RestControllerAdvice in REST Services

This article will try to cover global exception handling using ControllerAdvise annotation introduced in Spring 4.3.

Dharmendra Rathor user avatar by
Dharmendra Rathor
·
Jan. 15, 20 · Tutorial
Like (14)
Save
Tweet
Share
60.66K Views

Join the DZone community and get the full member experience.

Join For Free

golden retriever sleeping in sunlight

A REST API developer will have two requirements related to error handling.

  1. Common place for Error handling
  2. Similar Error Response body with a proper HTTP status code across APIs

Both requirements can be addressed by using RestControllerAdvice annotation in Spring.

Refer to code at https://github.com/DharmendraRathor/springzone/tree/master/customer.

I have created Get customer service for customer resource.

Java
x
13
 
1
@RestController
2
@RequestMapping("/customer")
3
public class CustomerController {
4
 
          
5
    @Autowired
6
    private CustomerManager customerManager;
7
 
          
8
    @GetMapping("/{id}")
9
    public Customer getCustomer(@PathVariable String id) {
10
        return customerManager.getCustomer(id).orElseThrow(() -> new NotFoundException("Customer not found with id " + id));
11
    }
12
 
          
13
}


curl --request GET --url http://localhost:8080/customer/1

Java
xxxxxxxxxx
1
 
1
If customer does not exist in DB , I want to throw error message with http Status 404.
2
 
          
3
{
4
  "errorCode": "NOT_FOUND_ERROR",
5
  "errorMsg": "Customer not found with id 1",
6
  "status": 404,
7
  "timestamp": "2019-12-26 11:45:59"
8
}
9
 
          


To achieve this, we have to define global exception handler class with annotation @RestControllerAdvice.

You may also be interested in:  Global Exception Handling With @ControllerAdvice

We have added one method "handleGenericNotFoundException", which handles exceptions defined with

@ExceptionHandler(value = NotFoundException.class).

Any service generating exception "NotFoundException" will come to “handleGenericNotFoundException” method, and the method will wrap the exception in common format using the "CustomErrorResponse" class. In this case, the "customer not found" error will be thrown as defined in “handleGenericNotFoundException” method inside the ExceptionAdvice class.

Java
xxxxxxxxxx
1
12
 
1
@RestControllerAdvice
2
public class ExceptionAdvice {
3
 
          
4
    @ExceptionHandler(value = NotFoundException.class)
5
    public ResponseEntity<CustomErrorResponse> handleGenericNotFoundException(NotFoundException e) {
6
        CustomErrorResponse error = new CustomErrorResponse("NOT_FOUND_ERROR", e.getMessage());
7
        error.setTimestamp(LocalDateTime.now());
8
        error.setStatus((HttpStatus.NOT_FOUND.value()));
9
        return new ResponseEntity<>(error, HttpStatus.NOT_FOUND);
10
    }   
11
 
          
12
}


CustomErrorResponse can be found at CustomErrorResponse.

We can define multiple error handler methods for different types of exceptions generated by services in "ExceptionAdvice" class and wrap each using common CustomErrorResponse response. This will make sure we have common place to handle errors and all services return similar error responses.

The git repo for the complete project git project.


Further Reading

Spring REST Service Exception Handling

How to Deal With Exceptions

REST Web Protocols Spring Framework

Opinions expressed by DZone contributors are their own.

Trending

  • Knowing and Valuing Apache Kafka’s ISR (In-Sync Replicas)
  • A Complete Guide to Agile Software Development
  • Future of Software Development: Generative AI Augmenting Roles and Unlocking Co-Innovation
  • Observability Architecture: Financial Payments Introduction

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com

Let's be friends: