Spring REST - Validation

Dans ce ticket nous allons voir comment utiliser les validations natives avec Spring Boot. Les technologies utilisées sont les suivantes :

• Spring Boot 2
• Maven
• Java 11

Prérequis : Il est nécessaire de générer un projet Spring Boot via le site https://start.spring.io . Ajouter Spring web, JPA, h2 pour la persistance des données puis validation pour la validation des données.

Nous créerons une entité voiture, contenant des informations de validation qui seront testées lors de l'appel au controller. Nous en profiterons pour stocker les informations des voitures dans une base de données h2 pour pouvoir être récupérées.

1. Création de l'entité d'exemple Car

@Entity
public class Car {
	@Id
	@GeneratedValue
	private Long id;
	
    @NotEmpty(message = "Please provide a model")
	private String model;
	
    @NotEmpty(message = "Please provide a registration")
	private String registration;

	public Long getId() {
		return id;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public String getModel() {
		return model;
	}

	public void setModel(String model) {
		this.model = model;
	}

	public String getRegistration() {
		return registration;
	}

	public void setRegistration(String registration) {
		this.registration = registration;
	}
}

Remarque : Des annotations @NotEmpty sont présentes. Elles seront utiles pour la validation des champs. Elles décrivent un champ comme ne devant pas être vide.

2. Création du repository

Repository de l'entité Car :

public interface CarRepository extends JpaRepository{}

3. Création du service

Service appelant le repository de l'entité Car :

@Service
public class CarService {
	@Autowired
	private CarRepository carRepository;
	
	public List findAll(){
		return this.carRepository.findAll();
	}
	
	public Car save(Car theCar){
		return this.carRepository.save(theCar);
	}
	
	public Optional findById(Long theId){
		return this.carRepository.findById(theId);
	}
}

4. Création du controller

@Controller
public class CarController {
	@Autowired
	private CarService carService;

	@GetMapping("/cars")
	public ResponseEntity> cars() {
		return ResponseEntity.ok(this.carService.findAll());
	}

	@PostMapping("/car")
	@ResponseStatus(HttpStatus.CREATED)
	public ResponseEntity car(@Valid @RequestBody Car car) {
		return ResponseEntity.ok(this.carService.save(car));
	}
}

5. Test et @ControllerAdvice

Si nous tentons de vérifier le bon fonctionnement des validations, nous observerons une erreur 400 en cas d'absence de valeur lors de l'enregistrement d'une voiture.

$ curl -v -X POST localhost:8080/car -H "Content-type:application/json" -d "{\"model\":\"ABC\"}"
*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 8080 (#0)
> POST /car HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.64.1
> Accept: */*
> Content-type:application/json
> Content-Length: 15
> 
* upload completely sent off: 15 out of 15 bytes
< HTTP/1.1 400 
< Content-Length: 0
< Date: Fri, 08 Jan 2021 17:47:10 GMT
< Connection: close
< 
* Closing connection 0

Afin d'avoir un résultat JSON sur les problèmes rencontrés lors de l'enregistrement, nous allons nous aider d'un controller qui sera appelé dans le cas d'une exception du type MethodeArgumentNotValidException :

@ControllerAdvice
public class CustomGlobalExceptionHandler extends ResponseEntityExceptionHandler {

	@Override
	protected ResponseEntity