Validation error response formatting in Spring Boot - Step-by-Step Execution

Concept Flow - Validation error response formatting

Receive HTTP Request

↓

Validate Input Data

↓

Valid

↓

Process

↓

Send Success

↓

End

The server receives a request, checks input data validity, and either processes it or sends back a formatted error response.

Execution Sample

Spring Boot

public ResponseEntity<?> handleRequest(@Valid @RequestBody User user, BindingResult result) {
  if (result.hasErrors()) {
    return ResponseEntity.badRequest().body(formatErrors(result));
  }
  return ResponseEntity.ok("Success");
}

This code checks for validation errors and returns a formatted error response if any exist.

Execution Table

Step	Action	Validation Result	Response Created	Response Sent
1	Receive HTTP POST with User data	Not checked yet	No	No
2	Validate User fields (e.g. @NotNull, @Size)	Errors found: name is empty	No	No
3	Check if result.hasErrors()	True	Yes, formatErrors() creates error list	No
4	Return ResponseEntity.badRequest() with error body	N/A	Yes	Yes, error response sent
5	End request processing	N/A	N/A	N/A

💡 Validation errors detected, so error response is sent instead of success.

Variable Tracker

Variable	Start	After Step 2	After Step 3	Final
result.hasErrors()	false	true	true	true
errorResponseBody	null	null	[{"field":"name","message":"must not be empty"}]	[{"field":"name","message":"must not be empty"}]

Key Moments - 2 Insights

Why do we check result.hasErrors() before processing the request?

Because the execution_table row 3 shows that if validation errors exist, we must create and send an error response instead of continuing.

What does formatErrors(result) do?

It extracts field names and messages from validation errors to create a clear error list, as shown in variable_tracker for errorResponseBody.

Visual Quiz - 3 Questions

Look at the execution_table at step 2, what validation result is found?

A No errors found

B Errors found: name is empty

C Validation not performed yet

D All fields valid

💡 Hint

Check the 'Validation Result' column at step 2 in execution_table

At which step is the error response actually sent back to the client?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look at the 'Response Sent' column in execution_table

If the input had no validation errors, how would the execution_table change?

A Step 3 would show result.hasErrors() as false and no error response created

B Step 4 would still create an error response

C Step 2 would show errors found

D Step 5 would be skipped

💡 Hint

Refer to variable_tracker and execution_table rows about result.hasErrors()

Concept Snapshot

In Spring Boot, use @Valid and BindingResult to check input validation.
If errors exist, use BindingResult.hasErrors() to detect them.
Format errors into a clear response body.
Return ResponseEntity.badRequest() with error details.
Otherwise, proceed with normal processing and return success.

Full Transcript

When a Spring Boot controller receives a request with input data, it validates the data using annotations like @NotNull or @Size. The BindingResult object holds any validation errors. The code checks if result.hasErrors() is true. If yes, it formats these errors into a list showing which fields failed and why. Then it returns a bad request response with this error list as the body. If no errors are found, it processes the request normally and returns a success response. This flow ensures clients get clear feedback on what input was wrong.

Practice

1. What is the main purpose of formatting validation error responses in Spring Boot?

easy

A. To provide clear error messages that help users understand input mistakes

B. To speed up the application startup time

C. To reduce the size of the application package

D. To automatically fix invalid inputs

Solution

1. Step 1: Understand validation error responses

   Validation errors occur when user input does not meet rules. Formatting these errors helps users know what went wrong.

2. Step 2: Identify the purpose of formatting

   Clear error messages improve user experience by showing which fields have issues and why.

3. Final Answer:

   To provide clear error messages that help users understand input mistakes -> Option A

4. Quick Check:

   Validation error formatting = clear user messages [OK]

Hint: Errors should explain what and where input failed [OK]

Common Mistakes:

• Thinking error formatting speeds startup
• Assuming errors fix themselves automatically
• Confusing error formatting with package size

2. Which annotation is used in Spring Boot to globally handle validation exceptions and format error responses?

easy

A. @RestControllerAdvice

B. @ComponentScan

C. @Service

D. @Controller

Solution

1. Step 1: Identify global exception handling annotation

   @RestControllerAdvice is designed to handle exceptions across all controllers and format responses.

2. Step 2: Confirm other annotations are not for global error handling

   @Controller is for MVC controllers, @Service for business logic, @ComponentScan for scanning components, none handle exceptions globally.

3. Final Answer:

   @RestControllerAdvice -> Option A

4. Quick Check:

   Global error handler = @RestControllerAdvice [OK]

Hint: Use @RestControllerAdvice for global error formatting [OK]

Common Mistakes:

• Confusing @Controller with error handling
• Using @Service or @ComponentScan incorrectly
• Missing global exception handler annotation

3. Given this Spring Boot exception handler method, what will the JSON response contain when a validation error occurs?

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity> handleValidationErrors(MethodArgumentNotValidException ex) {
  Map errors = new HashMap<>();
  ex.getBindingResult().getFieldErrors().forEach(error -> {
    errors.put(error.getField(), error.getDefaultMessage());
  });
  return ResponseEntity.badRequest().body(errors);
}

medium

A. A plain text string listing all errors

B. An empty JSON object

C. A JSON object with field names as keys and error messages as values

D. A JSON array of error codes only

Solution

1. Step 1: Analyze the error map creation

   The code collects field errors and puts each field name as key and its error message as value in a Map.

2. Step 2: Understand the response body

   The Map is returned as JSON in the response body, so the client receives a JSON object with field-error pairs.

3. Final Answer:

   A JSON object with field names as keys and error messages as values -> Option C

4. Quick Check:

   Field-error map = JSON object with keys and messages [OK]

Hint: Map field to message for clear JSON error response [OK]

Common Mistakes:

• Expecting plain text instead of JSON
• Thinking response is empty or only codes
• Confusing JSON array with JSON object

4. Identify the error in this Spring Boot validation error handler method:

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity> handleErrors(MethodArgumentNotValidException ex) {
  Map errors = new HashMap<>();
  for (FieldError error : ex.getBindingResult().getFieldErrors()) {
    errors.put(error.getDefaultMessage(), error.getField());
  }
  return ResponseEntity.badRequest().body(errors);
}

medium

A. The method does not handle the exception type correctly

B. The error message and field name are swapped when putting into the map

C. The response status should be OK instead of badRequest

D. The map should be a List instead

Solution

1. Step 1: Check map key-value assignment

   The code uses error.getDefaultMessage() as key and error.getField() as value, which reverses the intended field-to-message mapping.

2. Step 2: Understand correct mapping

   Field names should be keys and error messages should be values for clarity in JSON response.

3. Final Answer:

   The error message and field name are swapped when putting into the map -> Option B

4. Quick Check:

   Field as key, message as value is correct [OK]

Hint: Map field name as key, error message as value [OK]

Common Mistakes:

• Swapping keys and values in error map
• Using wrong exception class
• Returning wrong HTTP status code

5. You want to customize your Spring Boot validation error response to include the timestamp, status code, and a list of field errors with messages. Which approach correctly implements this formatting?

hard

A. Throw a new RuntimeException inside the exception handler to trigger default error page

B. Return a plain string with all errors concatenated in the exception handler

C. Use @ControllerAdvice without @ResponseBody and return a ModelAndView for errors

D. Create a custom error response class with fields for timestamp, status, and a list of errors; populate it in a @RestControllerAdvice method handling MethodArgumentNotValidException

Solution

1. Step 1: Understand desired error response structure

   The response should have timestamp, status code, and detailed field errors in JSON format.

2. Step 2: Identify correct implementation method

   Creating a custom error response class and populating it in a @RestControllerAdvice method allows structured JSON output with all required fields.

3. Step 3: Exclude incorrect options

   Returning plain strings or ModelAndView does not produce JSON with structured fields; throwing RuntimeException loses control over formatting.

4. Final Answer:

   Create a custom error response class with fields for timestamp, status, and a list of errors; populate it in a @RestControllerAdvice method handling MethodArgumentNotValidException -> Option D

5. Quick Check:

   Custom class + @RestControllerAdvice = structured JSON error [OK]

Hint: Use custom class and @RestControllerAdvice for detailed JSON errors [OK]

Common Mistakes:

• Returning plain text instead of JSON
• Using @ControllerAdvice without JSON response
• Throwing exceptions instead of formatting response