El manejo de excepciones en una API REST utilizando Spring Boot es un aspecto crucial del desarrollo que permite una gestión eficaz de los errores y notifica a los clientes sobre los problemas que han ocurrido en el servidor. Analicemos este proceso con más detalle.

¿Cómo ayuda a notificar al cliente sobre los errores?

El manejo de errores en una API REST ayuda a estandarizar el formato de las respuestas de error, facilitando a los clientes el trabajo con dichas respuestas. Esto, a su vez, les informa sobre las razones de los errores, permitiendo que los clientes comprendan qué salió mal y cómo corregir el problema.

Además, este manejo permite la diferenciación entre tipos de errores, como errores de validación o problemas de acceso, haciendo que los mensajes de error sean más precisos y útiles.

Implementación del manejo de excepciones utilizando anotaciones

Spring Boot proporciona varias herramientas para el manejo de excepciones. Las principales son las anotaciones @ControllerAdvice y @ExceptionHandler.

La anotación @ControllerAdvice permite definir manejadores globales de excepciones para todos los controladores en la aplicación, lo que ayuda a centralizar el manejo de errores y evitar la duplicación de código.

Dentro de una clase anotada con @ControllerAdvice, los métodos anotados con @ExceptionHandler especifican qué tipos de excepciones debe manejar un método en particular. Esto simplifica la gestión de errores y hace que el código sea más limpio y organizado.

GlobalExceptionHandler.java


              12345678
            
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ApiException.class)
    public ResponseEntity<?> handleException(ApiException ex) {
         // error handling
    }
}

Dentro de esta clase, el método handleException() será invocado cuando ocurra una excepción de tipo ApiException en la aplicación. La anotación @ExceptionHandler(ApiException.class) indica que este método maneja excepciones de este tipo específico.

Creación de una Excepción Personalizada

¿Pero qué es exactamente la ApiException? Es una excepción personalizada creada específicamente para nuestra API, y podemos crear nuestras propias excepciones y utilizarlas en nuestra API REST.

Puede consultar cómo crear sus propias excepciones personalizadas aquí.

ApiException.java


              12345678910111213141516
            
public class ApiException extends RuntimeException {

    // HTTP status code associated with this exception
    private final HttpStatus httpStatus;

    // Constructor to initialize the exception with a message and an HTTP status
    public ApiException(String message, HttpStatus httpStatus) {
        super(message);
        this.httpStatus = httpStatus;
    }

    // Getter method to retrieve the HTTP status
    public HttpStatus getHttpStatus() {
        return httpStatus;
    }
}

Este código define la clase ApiException, que extiende RuntimeException e incluye un campo adicional httpStatus para almacenar el estado HTTP. El constructor de la clase recibe un mensaje y un estado HTTP, que luego se pasan al constructor base y se almacenan en el campo httpStatus.

Después de esto, podemos lanzar una excepción desde nuestra aplicación:

Main.java


              1234567891011
            
public BookResponseDTO updateBook(String id, BookRequestDTO book) {
    Book modelBook = MapperBook.dtoRequestToModel(book);
    Book repositoryBook = bookRepository.updateBook(id, modelBook);

    // If the book was not found in the repository, throw an ApiException with a NOT_FOUND status
    if (repositoryBook == null) {
        throw new ApiException("Not found book by id: " + id, HttpStatus.NOT_FOUND);
    }

    return MapperBook.modelToResponseDto(repositoryBook);
}

Este tipo de excepción será capturado por un método handleException(ApiException ex) diseñado para gestionarla, y dentro de ese método, se puede definir la lógica para manejar la excepción.

La lógica que se desea implementar consiste en capturar excepciones relacionadas con la API y devolver una respuesta estructurada que contenga información de error junto con el estado HTTP correspondiente.

Main.java


              123456789
            
@ExceptionHandler(ApiException.class)
public ResponseEntity<?> handleException(ApiException ex) {
    return new ResponseEntity<>(ErrorResponse
            .builder()
            .error(ex.getMessage())
            .build(),
            ex.getHttpStatus()
    );
}

Este código gestiona la ApiException mediante la creación de un ResponseEntity con información de error. El método handleException() construye un objeto ErrorResponse con el mensaje de la excepción y establece el estado HTTP desde el campo httpStatus de la excepción, devolviendo esto al cliente.

Inicializamos el campo httpStatus cuando lanzamos la excepción en nuestra aplicación.

ErrorResponse es una clase utilizada para proporcionar información sobre el error. Contiene un campo error que muestra la descripción del error y se crea utilizando las anotaciones @Data y @Builder.

ErrorResponse.java


              12345
            
@Data
@Builder
public class ErrorResponse {
  private String error;
}

La anotación @Builder de Lombok simplifica la creación de objetos al implementar el patrón Builder. Permite una forma más legible y mantenible de construir objetos, especialmente aquellos con muchos parámetros. Por ejemplo, se puede crear una instancia de ErrorResponse de la siguiente manera:

ErrorResponse.builder().error("ERROR").build();

El método builder() inicializa un nuevo constructor para la clase ErrorResponse. El método error("ERROR") establece el campo error en "ERROR", y el método build() construye el objeto final ErrorResponse con el valor especificado.

Manejo de errores en nuestra aplicación

Resumen

El manejo de excepciones en una API REST centraliza la gestión de errores proporcionando un formato de respuesta consistente para el cliente. Esto simplifica la comprensión y el tratamiento de errores, ya que los clientes reciben mensajes claros y estructurados.

El uso de las anotaciones @ControllerAdvice y @ExceptionHandler permite la personalización de cómo se gestionan las diferentes excepciones, mientras que las excepciones personalizadas pueden incluir información adicional, como el estado HTTP.

¿Todo estuvo claro?

¡Gracias por tus comentarios!

Sección 3. Capítulo 5

Pregunte a AI

Pregunte lo que quiera o pruebe una de las preguntas sugeridas para comenzar nuestra charla

Suggested prompts:

Can you explain how to create a custom exception in Spring Boot?

What is the purpose of the ErrorResponse class in this context?

How does @ControllerAdvice improve error handling in a REST API?

Awesome!

Completion rate improved to 3.45

Desliza para mostrar el menú

¿Cómo ayuda a notificar al cliente sobre los errores?

Implementación del manejo de excepciones utilizando anotaciones

Spring Boot proporciona varias herramientas para el manejo de excepciones. Las principales son las anotaciones @ControllerAdvice y @ExceptionHandler.

GlobalExceptionHandler.java


              12345678
            
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ApiException.class)
    public ResponseEntity<?> handleException(ApiException ex) {
         // error handling
    }
}

Creación de una Excepción Personalizada

Puede consultar cómo crear sus propias excepciones personalizadas aquí.

ApiException.java


              12345678910111213141516
            
public class ApiException extends RuntimeException {

    // HTTP status code associated with this exception
    private final HttpStatus httpStatus;

    // Constructor to initialize the exception with a message and an HTTP status
    public ApiException(String message, HttpStatus httpStatus) {
        super(message);
        this.httpStatus = httpStatus;
    }

    // Getter method to retrieve the HTTP status
    public HttpStatus getHttpStatus() {
        return httpStatus;
    }
}

Después de esto, podemos lanzar una excepción desde nuestra aplicación:

Main.java


              1234567891011
            
public BookResponseDTO updateBook(String id, BookRequestDTO book) {
    Book modelBook = MapperBook.dtoRequestToModel(book);
    Book repositoryBook = bookRepository.updateBook(id, modelBook);

    // If the book was not found in the repository, throw an ApiException with a NOT_FOUND status
    if (repositoryBook == null) {
        throw new ApiException("Not found book by id: " + id, HttpStatus.NOT_FOUND);
    }

    return MapperBook.modelToResponseDto(repositoryBook);
}

Main.java


              123456789
            
@ExceptionHandler(ApiException.class)
public ResponseEntity<?> handleException(ApiException ex) {
    return new ResponseEntity<>(ErrorResponse
            .builder()
            .error(ex.getMessage())
            .build(),
            ex.getHttpStatus()
    );
}

Inicializamos el campo httpStatus cuando lanzamos la excepción en nuestra aplicación.

ErrorResponse.java


              12345
            
@Data
@Builder
public class ErrorResponse {
  private String error;
}

ErrorResponse.builder().error("ERROR").build();

Manejo de errores en nuestra aplicación

Resumen

¿Todo estuvo claro?

¡Gracias por tus comentarios!

Sección 3. Capítulo 5

Gestión de Excepciones

¿Cómo ayuda a notificar al cliente sobre los errores?

Implementación del manejo de excepciones utilizando anotaciones

Creación de una Excepción Personalizada

Manejo de errores en nuestra aplicación

Resumen

Awesome!

Gestión de Excepciones

¿Cómo ayuda a notificar al cliente sobre los errores?

Implementación del manejo de excepciones utilizando anotaciones

Creación de una Excepción Personalizada

Manejo de errores en nuestra aplicación

Resumen