Validación automática de datos en APIs con Spring Boot
Contenido del curso
Leiber Bertel
David Mauricio Gorraiz Moreno
Alejandro Ramírez
Profesor
Milton Hernan Camacho Quitian
Santiago Andres Castro Cruz
Alejandro Ramírez
Profesor
Quinto Impacto
ANDRES ALFONSO MIRA MEJIA
Hola, para el caso en que se envíe un género no válido (es decir, que no exista en Genre) al crear una nueva película, Jackson intentará deserializar el valor y fallará, lanzando un HttpMessageNotReadableException.
De forma predeterminada, esta excepción se traduce en una respuesta HTTP 400 Bad Request. Sin embargo, para ofrecer una respuesta más clara y descriptiva al consumidor de nuestra API, creé este advice:
@ExceptionHandler(HttpMessageNotReadableException.class) public ResponseEntity<Error> handleException(HttpMessageNotReadableException e) { String type = "format-validation-error"; String message = "Ha ocurrido un error en el formato de los datos enviados."; if (e.getCause() instanceof InvalidFormatException cause && cause.getTargetType() == Genre.class) { type = "genre-not-found"; message = "El género enviado no es válido. Por favor, verifique los valores permitidos."; } Error error = new Error(type, message); return ResponseEntity.badRequest().body(error); }
De esta manera, damos más contexto sobre qué salió mal y facilitamos la comprensión del error.
Primero le agrego @Vaid en el metodo post en el MovieController:
@PostMapping public ResponseEntity<MovieDto> add(@RequestBody @Valid MovieDto movieDto){ return ResponseEntity.status(HttpStatus.CREATED).body(this.movieService.add(movieDto)); }
Luego en la clase MovieDto se agregan las validaciones que se quieren implementar:
package com.platzi.play.domain.dto; import com.platzi.play.domain.Genre; import jakarta.validation.constraints.*; import java.time.LocalDate; public record MovieDto( Long id, @NotBlank(message = "La pelicula debe tner un titulo que no sea vacio.") String title, @Positive(message = "El valor de la duracion debe ser un numero positivo") Integer duration, Genre genre, @PastOrPresent(message = "La fecha de lanzamiento debe ser anterior o igual a la actual") LocalDate releaseDate, @Min(value = 0, message = "El valor minimo de calificacion debe ser cero") @Max(value = 5, message = "El valor maximo de la calificacion debe ser cinco") Double rating, Boolean state ) { }
Muy bien, David!
Comparto mi propuesta.
En el método add se agrega la anotación @Valid
@PostMapping public ResponseEntity<MovieDto> add(@RequestBody @Valid MovieDto movieDto){ return ResponseEntity.status(HttpStatus.CREATED).body(this.movieService.add(movieDto)); }
Luego, en MovieDto se agregan las anotaciones de Bean Validation:
package com.platzi.play.domain.dto; import com.platzi.play.domain.Genre; import jakarta.validation.constraints.*; import java.time.LocalDate; public record MovieDto( Long id, @NotBlank(message = "El título es obligatorio") String title, @Positive(message = "La duración de la película debe ser mayor que 0") Integer duration, @NotNull(message = "El género de la película debe ser informado") Genre genre, @PastOrPresent(message = "La fecha de lanzamiento debe ser menor a la fecha actual") LocalDate releaseDate, @Min(value = 0, message = "El rating no puede ser menor que 0") @Max(value = 5, message = "El rating no puede ser mayor que 5") Double rating, @NotNull(message = "El estado debe ser informado") Boolean status ) { }
Funciona de la siguiente manera:
En el MovieController el @Valid en metodo
@PostMapping public ResponseEntity<MovieDto> add(@RequestBody @Valid MovieDto movieDto){ return ResponseEntity.status(HttpStatus.CREATED).body(this.movieService.add(movieDto)); }
y luego de eso ponemos las validaciones en el MovieDto
public record MovieDto( Long id, @NotBlank(message = "El titulo es obligatorio") String title, @Min(value = 1, message = "La duracion no puede ser menor a 1") @Max(value = 240, message = "La duracion no puede ser mayor a 240") Integer duration, Genre genre, @PastOrPresent(message = "la fecha de lanzamiento debe ser anterior a la fecha actual") LocalDate releaseDate, @Min(value = 0, message = "El rating no puede ser menor a 0") @Max(value = 5, message = "El rating no puede ser mayor a 5") Double rating, State state ) { }
de esta forma me funciona, pero tengo una pregunta adicionalmente.
¿Por qué cuando adiciona la
@NotBlank(message = "El genero es obligatorio")
para el genero, me sale la excepción general y no la del MethodArgumentNotValidException
?
Lo que pasa es que @NotBlank solo funciona con String, y en este caso genre es un enum. Por eso no entra en el MethodArgumentNotValidException sino que lanza una excepción más general, porque la anotación no aplica para ese tipo de dato.
La forma correcta es usar @NotNull(message = "El género es obligatorio") en el enum. Si el campo viniera como String, ahí sí tendría sentido usar @NotBlank.
Coloque esta etiqueta para el estado: @NotNull (message = "El campo 'disponible' es obligatorio") Boolean state
✅
