Le DbContext
La classe qui relie vos classes C# à la base de données.
Après cette fiche, vous saurez :
- expliquer le rôle du DbContext
- écrire une classe qui hérite de DbContext
- déclarer les tables avec des DbSet
- écrire une chaîne de connexion et construire les options
1Le chef d'orchestre
Vos classes Film, Genre... décrivent les tables, mais rien
ne dit encore quelles classes doivent devenir des tables, ni dans quelle base.
C'est le travail du DbContext.
Le DbContext est une classe fournie par Entity Framework. Vous écrivez la
vôtre, qui en hérite : elle reçoit ainsi toute la mécanique d'Entity Framework
sans que vous ayez à la réécrire. C'est le principe de l'héritage en C#.
using Demo_Cinema.Model; using Microsoft.EntityFrameworkCore; namespace Demo_Cinema.Context { public class AppDbContext : DbContext { public DbSet<Film> Films => Set<Film>(); public DbSet<Genre> Genres => Set<Genre>(); public DbSet<Salle> Salles => Set<Salle>(); public DbSet<Seance> Seances => Set<Seance>(); public DbSet<Ticket> Tickets => Set<Ticket>(); public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { } } }
Le fichier se range dans le dossier Context. Le « : DbContext »
après le nom de la classe veut dire « hérite de DbContext ».
2Les DbSet : une ligne par table
Chaque ligne public DbSet<Film> Films déclare une table. Un
DbSet est « un ensemble de » quelque chose : ici un ensemble de films.
| Morceau | Rôle |
|---|---|
DbSet<Film> | Entre les chevrons : la classe, au singulier. C'est elle qui décrit les colonnes. |
Films | Le nom de la propriété : au pluriel. Ce sera le nom de la table. |
=> Set<Film>() | Demande à Entity Framework de fournir l'ensemble. À recopier tel quel. |
C'est la raison du pluriel annoncé à la fiche 1 : la classe décrit un film,
la table en range beaucoup. Le nom Films du DbSet
devient le nom de la table :
CREATE TABLE "Films" ( ... );Attention
Une classe qui n'est pas dans un DbSet n'a pas de table.
Si vous oubliez la ligne DbSet<Salle> Salles, la table
Salles ne sera pas créée. Ajoutez une ligne par classe qui doit devenir
une table.
3Le constructeur et les options
La ligne
public AppDbContext(DbContextOptions<AppDbContext> options) : base(options) { }est un constructeur : un morceau de code qui s'exécute quand on fabrique un
AppDbContext. Il reçoit des options (où se trouve la base, quel mot de
passe...) et les transmet à DbContext avec : base(options). Vous
la recopierez telle quelle dans chaque projet.
4La chaîne de connexion
Pour trouver la base, Npgsql a besoin d'une chaîne de connexion : un texte composé de morceaux séparés par des points-virgules.
Host=localhost;Database=db_cinema;Username=postgres;Password=VotreMotDePasse
| Morceau | Signification |
|---|---|
Host=localhost | L'ordinateur où tourne PostgreSQL. localhost signifie « cet ordinateur-ci ». |
Database=db_cinema | Le nom de la base. Elle n'existe pas encore : elle sera créée avec ce nom. |
Username=postgres | L'utilisateur PostgreSQL (celui de l'installation). |
Password=... | Le mot de passe choisi à l'installation de PostgreSQL. |
Le port 5432 n'est pas écrit : c'est le port par défaut de PostgreSQL,
Npgsql le connaît.
5Construire les options dans Program.cs
Dans Program.cs, on prépare les options avec la chaîne de connexion, puis
on fabrique le DbContext.
using Demo_Cinema.Context; using Microsoft.EntityFrameworkCore; var options = new DbContextOptionsBuilder<AppDbContext>() .UseNpgsql("Host=localhost;Database=db_cinema;Username=postgres;Password=VotreMotDePasse") .Options; using var db = new AppDbContext(options);
Ligne par ligne :
new DbContextOptionsBuilder<AppDbContext>(): un petit assistant qui prépare les options..UseNpgsql("..."): « utilise Npgsql pour parler à PostgreSQL, avec cette chaîne de connexion ». C'est ici que le package de la fiche 2 est utilisé..Options: récupère le résultat.using var db = new AppDbContext(options): fabrique leDbContext. Le motusingle ferme proprement à la fin du programme.
Le mot var laisse C# deviner le type tout seul : options
et db ont chacun le bon type sans qu'on ait à l'écrire.
Attention
Votre mot de passe ne doit jamais être publié.
Si vous mettez votre projet sur GitHub avec le vrai mot de passe dans
Program.cs, tout le monde peut le lire, même longtemps après, même si vous le
supprimez ensuite.
- Pour un exercice sur votre machine, un mot de passe simple comme
postgresconvient. - Pour un vrai projet, le mot de passe se range dans un fichier de configuration
(
appsettings.json) ou dans une variable d'environnement, jamais dans le code. Ce sera l'étape suivante, après ce cours.
6Une autre façon : OnConfiguring
Vous croiserez peut-être une autre écriture, où la chaîne de connexion est écrite
dans le DbContext au lieu de Program.cs :
public class AppDbContext : DbContext { public DbSet<Film> Films => Set<Film>(); public AppDbContext() { } protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) { if (!optionsBuilder.IsConfigured) { optionsBuilder.UseNpgsql("Host=localhost;Database=db_cinema;Username=postgres;Password=VotreMotDePasse"); } } }
Cela fonctionne aussi. Nous gardons la première version (les options construites dans
Program.cs), car elle garde la configuration à un seul endroit, en dehors
de la classe.
À retenir
Le DbContext est le pont entre vos classes et la base.
- Un DbSet par classe qui doit devenir une table, au pluriel.
- Un constructeur qui reçoit les options.
- Dans
Program.cs:UseNpgsqlavec la chaîne de connexion.
→Exercices
Dans votre projet Demo_Cinema, recopiez le AppDbContext de
cette fiche dans le dossier Context. Il vous faut aussi les classes de la
fiche 5 (Film et Genre au minimum, même simplifiées). Retirez
du AppDbContext les DbSet des classes que vous n'avez pas encore
écrites, puis lancez dotnet build.
Solution
Le résultat attendu est Build succeeded.
Si une erreur dit qu'un type est introuvable (The type or namespace name 'Film' could
not be found), il manque probablement le using Demo_Cinema.Model; en haut
du fichier, ou la classe n'existe pas encore.
Voici une chaîne de connexion :
Host=localhost;Database=db_garage;Username=postgres;Password=secret
- Quel est le nom de la base ?
- Sur quel ordinateur tourne PostgreSQL ?
- Modifiez-la pour une base nommée
db_bibliotheque.
Solution
db_garage.- Sur cet ordinateur (
localhost). Host=localhost;Database=db_bibliotheque;Username=postgres;Password=secret
Rappel : secret est un mot de passe d'exercice. Un vrai mot de passe
ne s'écrit jamais dans un projet publié.
Pour le club de sport de la fiche 1, vous avez les classes Membre et
Cours.
- Écrivez le
ClubDbContextavec ses deuxDbSet. - Écrivez, dans
Program.cs, les lignes qui construisent les options pour la basedb_clubet créent leDbContext.
Solution
public class ClubDbContext : DbContext { public DbSet<Membre> Membres => Set<Membre>(); public DbSet<Cours> Cours => Set<Cours>(); public ClubDbContext(DbContextOptions<ClubDbContext> options) : base(options) { } }
var options = new DbContextOptionsBuilder<ClubDbContext>() .UseNpgsql("Host=localhost;Database=db_club;Username=postgres;Password=VotreMotDePasse") .Options; using var db = new ClubDbContext(options);
Deux détails : le DbSet est au pluriel (Membres), et le
type entre chevrons est le même à trois endroits (ClubDbContext).
Pour Cours, le mot est identique au singulier et au pluriel : les deux
noms sont donc les mêmes.
Je sais faire
- Je sais que le DbContext est le pont entre mes classes et la base.
- Je sais déclarer une table avec DbSet
Films. - Je sais lire une chaîne de connexion PostgreSQL.
- Je ne publie jamais mon mot de passe.
Une case qui coince ? Relisez la partie concernée avant de passer à la fiche suivante.