Accueil › Fullstack Angular + Spring Boot › Concevoir le contrat : DTO côté back, types côté front
Concevoir le contrat : DTO côté back, types côté front
Le contrat d'APIdebutant
Un DTO n'est pas une formalité : c'est la définition du contrat. Deux règles suffisent à éviter la plupart des problèmes.
Un DTO par sens de circulation. Ce que le client peut envoyer n'est pas ce que le back accepte de révéler :
// entrée : uniquement ce que le client a le droit de décider
public record CreerCommandeRequest(
@NotNull Long clientId,
@NotEmpty List<LigneRequest> lignes) { }
// sortie : ce que le back assume de montrer
public record CommandeDto(
long id,
String reference,
String nomClient,
BigDecimal total,
StatutCommande statut,
LocalDateTime creeLe) { }
Le total et le statut sont calculés par le back. Ils n'apparaissent pas en entrée : un client ne décide pas du prix de sa commande.
Un DTO par écran, pas par table. Le front a besoin du nom du client, pas d'un clientId qu'il faudrait résoudre par un second appel.
Côté Angular, le type est la transcription fidèle du DTO de sortie :
export interface Commande {
id: number;
reference: string;
nomClient: string;
total: number;
statut: 'EN_ATTENTE' | 'VALIDEE' | 'EXPEDIEE' | 'ANNULEE';
creeLe: string;
}
Les deux fichiers doivent évoluer ensemble. Le chapitre « Faire tourner les deux ensemble » montre comment automatiser ce lien avec OpenAPI.
Les termes à connaître
- DTO d'entrée / DTO de sortie
Deux DTO distincts pour un même concept. Le DTO d'entrée (
CreerCommandeRequest) ne contient que ce que le client a le droit de fournir ; le DTO de sortie (CommandeDto) contient ce que le back accepte de révéler. Les deux ne sont presque jamais identiques.- record
Classe Java immuable et concise (depuis Java 16), idéale pour un DTO : champs
final, constructeur canonique, accesseurs,equals/hashCode/toStringgénérés. Jackson sait sérialiser et désérialiser unrecordsans configuration.- Mapping
La traduction entre entité et DTO. Elle se fait à la main (constructeur, méthode
de(...)), par une méthode de l'entité, ou avec une bibliothèque de mapping. Dans tous les cas, c'est un point de passage explicite : rien ne traverse le contrat par accident.- Projection
Technique Spring Data qui demande à la base exactement les colonnes du DTO, en déclarant un type de retour
interfaceourecordsur la méthode du repository. On évite de charger l'entité complète pour n'en garder que trois champs.- @JsonProperty
Annotation Jackson qui fixe le nom JSON d'un champ, indépendamment du nom Java :
@JsonProperty("nom_client"). Utile pour respecter un contrat imposé, mais préférez un nommage cohérent partout plutôt que des renommages ponctuels.- Sur-exposition (over-fetching)
Renvoyer plus de données que l'écran n'en affiche. Coûte de la bande passante, de la mémoire, et fait fuiter de l'information métier. Le symptôme typique est une liste de 50 éléments où chaque élément porte 30 champs dont 4 sont affichés.
- Agrégat de lecture (vue)
DTO conçu pour un écran précis, assemblant des données de plusieurs entités (
TableauDeBordDto). Il ne correspond à aucune table : c'est normal. Un contrat se conçoit à partir des besoins d'affichage, pas à partir du modèle de données.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.