Une classe = une table
Comment écrire une classe C# pour que la table soit exactement celle qu'on veut.
Après cette fiche, vous saurez :
- relier classe, propriété et objet à table, colonne et ligne
- écrire une propriété et respecter les règles de nommage
- prévoir le type PostgreSQL d'une propriété
- décider si une colonne peut rester vide (string ou string?)
1La correspondance de base
Entity Framework suit une règle toute simple. Regardez le schéma.
| Dans C# | Dans PostgreSQL |
|---|---|
Une classe (Film) | Une table (Films) |
Une propriété (Titre) | Une colonne (Titre) |
| Un objet (un film précis, comme Dune) | Une ligne de la table |
Le travail d'un développeur avec Entity Framework consiste donc à décrire les colonnes en écrivant les propriétés. Voyons comment.
2Écrire une propriété
Voici la classe Film du cinéma, dans sa version la plus simple.
public class Film { public int IdFilm { get; set; } public string Titre { get; set; } public int Annee { get; set; } }
Une ligne comme public int Annee { get; set; } s'appelle une
propriété automatique (ou auto-propriété). Elle se lit en quatre morceaux :
| Morceau | Signification |
|---|---|
public | Visible depuis tout le programme, donc aussi par Entity Framework. |
int | Le type : ici un nombre entier. C'est lui qui décide du type de la colonne. |
Annee | Le nom : il devient le nom de la colonne. |
{ get; set; } | get permet de lire la valeur, set permet de la modifier. Entity Framework a besoin des deux. |
Avec Visual Studio, vous n'avez pas à tout taper : écrivez prop puis
appuyez sur la touche Tab deux fois. La ligne se crée toute seule.
La propriété complète
Il existe une version plus longue, la propriété complète (raccourci propfull
puis Tab) :
private string synopsis; public string Synopsis { get { return synopsis; } set { synopsis = value; } }
Elle cache la valeur dans une variable private (le synopsis en
minuscule). Elle ne sert que quand on veut ajouter une règle dans le set,
par exemple refuser un nombre négatif. Pour Entity Framework, la propriété automatique
suffit, et c'est celle que nous utilisons.
3Les règles de nommage
Les noms que vous choisissez se retrouvent tels quels dans la base. Il faut donc soigner les noms.
| Règle | Exemple |
|---|---|
| La classe est au singulier et commence par une majuscule. | Film, Salle |
| Chaque propriété est en PascalCase : une majuscule au début de chaque mot, sans espace ni tiret bas. | DureeMinutes, DateAchat |
| Pas d'accent dans les noms. | Realisateur, pas Réalisateur |
Attention
Ne vous écrivez pas nomAttaque avec un « n » minuscule.
Visual Studio souligne ce genre de nom et signale l'avertissement IDE1006
(« règle de nommage non respectée »). En C#, les propriétés s'écrivent en PascalCase :
NomAttaque. Ce n'est pas bloquant, mais il vaut mieux prendre le bon pli dès
le départ.
4Le type de la propriété donne le type de la colonne
Vous choisissez un type C#, et Npgsql choisit pour vous le type PostgreSQL qui lui correspond.
| Type C# | Type PostgreSQL | Pour mettre... |
|---|---|---|
int | integer | un nombre entier : une année, une capacité |
string | text | du texte : un titre, un nom |
bool | boolean | vrai ou faux : Est3d |
double | double precision | un nombre à virgule : un prix |
decimal | numeric | un nombre à virgule exact : de l'argent |
DateOnly | date | une date sans heure : la date d'une séance |
Pour de l'argent, on préfère souvent decimal, qui ne fait pas d'erreur
d'arrondi. Dans le cinéma, nous gardons double pour rester simples.
5Cette colonne peut-elle rester vide ?
Une colonne NOT NULL doit toujours contenir une valeur. Une colonne qui accepte le NULL peut rester vide. Entity Framework décide à partir du type de la propriété :
public int Annee { get; set; } // jamais vide -> NOT NULL public string Titre { get; set; } // jamais vide -> NOT NULL public string? Synopsis { get; set; } // peut être vide -> accepte le NULL
Le petit point d'interrogation après le type veut dire « peut être vide ». Il fait toute la différence. Voici ce que PostgreSQL recevra :
CREATE TABLE "Films" ( "IdFilm" integer GENERATED BY DEFAULT AS IDENTITY, "Titre" text NOT NULL, "Annee" integer NOT NULL, "Synopsis" text, ... );
Un int n'a pas de version « vide » simple : il est toujours
NOT NULL. Un string sans point d'interrogation l'est aussi, à condition
que votre projet ait <Nullable>enable</Nullable> dans son
.csproj (c'est le cas par défaut dans un projet récent).
Le mot « required »
Avec ce réglage, le compilateur affiche un avertissement sur string Titre :
« cette propriété ne doit pas être vide, mais rien ne l'oblige à recevoir une
valeur ». On le règle en ajoutant le mot required :
public required string Titre { get; set; }
required oblige celui qui crée un film à donner un titre. L'avertissement
disparaît, et la colonne reste NOT NULL.
À retenir
Le type décide de tout.
int,bool,double... → colonne NOT NULL.stringavecrequired→ colonne NOT NULL.string?(avec le point d'interrogation) → colonne qui peut rester vide.
Il reste à décider de la clé primaire, de la longueur des textes et de l'unicité : c'est le travail des annotations, dans la fiche suivante.
→Exercices
Pour chaque propriété, donnez le type de la colonne PostgreSQL et dites si elle peut rester vide.
public int Capacite { get; set; } public bool Est3d { get; set; } public double PrixBase { get; set; } public DateOnly DateSeance { get; set; } public string? Remarques { get; set; }
Solution
| Propriété | Type PostgreSQL | Peut rester vide ? |
|---|---|---|
Capacite | integer | Non |
Est3d | boolean | Non |
PrixBase | double precision | Non |
DateSeance | date | Non |
Remarques | text | Oui (à cause du ?) |
Cette classe ne respecte pas les règles de nommage. Récrivez-la correctement.
public class salles { public int idSalle { get; set; } public int numero_salle { get; set; } public int capacité { get; set; } }
Combien de colonnes aura la table ?
Solution
public class Salle { public int IdSalle { get; set; } public int NumeroSalle { get; set; } public int Capacite { get; set; } }
Quatre corrections : la classe au singulier avec une majuscule, les propriétés en PascalCase, le tiret bas supprimé, l'accent de capacité retiré.
La table aura 3 colonnes.
Écrivez la classe Genre du cinéma avec :
- un identifiant entier,
IdGenre; - un libellé obligatoire (« Comédie », « Drame »...) ;
- une description qui peut rester vide.
Précisez, pour chaque propriété, si la colonne sera NOT NULL.
Solution
public class Genre { public int IdGenre { get; set; } // NOT NULL public required string Libelle { get; set; } // NOT NULL public string? Description { get; set; } // peut rester vide }
Le point d'interrogation de string? est ce qui rend la description
facultative.
Je sais faire
- Je sais qu'une classe devient une table et une propriété une colonne.
- J'écris mes classes au singulier et mes propriétés en PascalCase.
- Je sais quel type PostgreSQL correspond à int, string, bool, double et DateOnly.
- Je sais faire la différence entre string et string? pour une colonne.
Une case qui coince ? Relisez la partie concernée avant de passer à la fiche suivante.