C# - Entity Framework Core: model, migrácie a prvé dotazy

Entity Framework Core (EF Core) je ORM pre .NET – mapuje tabuľky databázy na triedy v C#. Namiesto písania príkazov SQL a ručného čítania stĺpcov z SqlDataReader pracujete s objektmi a dotazy píšete v LINQ. EF Core z nich vygeneruje SQL, vykoná ho a výsledok vráti ako objekty.

V článku prejdeme celú cestu: od prázdneho projektu po databázu so zákazníkmi a objednávkami, do ktorej vieme zapisovať a čítať.

Inštalácia

Do projektu pridajte poskytovateľa pre svoju databázu a balík s nástrojmi pre migrácie. V príkladoch používame SQL Server LocalDB, ktorý sa inštaluje s Visual Studiom:

dotnet add package Microsoft.EntityFrameworkCore.SqlServer
dotnet add package Microsoft.EntityFrameworkCore.Design
dotnet tool install --global dotnet-ef

Pre inú databázu stačí iný balík – napríklad Microsoft.EntityFrameworkCore.Sqlite, Npgsql.EntityFrameworkCore.PostgreSQL alebo Pomelo.EntityFrameworkCore.MySql. Zvyšok kódu ostáva takmer rovnaký.

Triedy modelu

public class Zakaznik
{
    public int Id { get; set; }
    public string Meno { get; set; } = "";
    public string Email { get; set; } = "";

    public List<Objednavka> Objednavky { get; } = new();
}

public class Objednavka
{
    public int Id { get; set; }
    public DateTime Datum { get; set; }
    public decimal Suma { get; set; }

    public int ZakaznikId { get; set; }
    public Zakaznik Zakaznik { get; set; } = null!;
}

EF Core sa riadi konvenciami: vlastnosť Id je primárny kľúč, ZakaznikId je cudzí kľúč k tabuľke zákazníkov. Vlastnosti Objednavky a Zakaznik sú navigačné – cez ne sa prechádza medzi súvisiacimi záznamami.

DbContext

Trieda odvodená od DbContext predstavuje spojenie s databázou. Každá vlastnosť DbSet<T> zodpovedá jednej tabuľke.

using Microsoft.EntityFrameworkCore;

public class ObchodContext : DbContext
{
    public DbSet<Zakaznik> Zakaznici => Set<Zakaznik>();
    public DbSet<Objednavka> Objednavky => Set<Objednavka>();

    protected override void OnConfiguring(DbContextOptionsBuilder options)
    {
        options.UseSqlServer(
            @"Server=(localdb)\MSSQLLocalDB;Database=Obchod;Trusted_Connection=True;TrustServerCertificate=True");
    }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Zakaznik>(e =>
        {
            e.Property(z => z.Meno).HasMaxLength(100);
            e.Property(z => z.Email).HasMaxLength(200);
            e.HasIndex(z => z.Email).IsUnique();
        });

        modelBuilder.Entity<Objednavka>()
            .Property(o => o.Suma)
            .HasPrecision(10, 2);
    }
}

V metóde OnModelCreating sa dopĺňa to, čo sa z tried nedá vyčítať: dĺžky textov, indexy, presnosť desatinných čísel. V reálnej aplikácii pripájací reťazec nepatrí do kódu, ale do konfigurácie (appsettings.json, premenné prostredia).

Migrácie – vytvorenie databázy

Migrácia je vygenerovaný kód, ktorý databázu upraví tak, aby zodpovedala modelu:

dotnet ef migrations add Prvotna
dotnet ef database update

Prvý príkaz vytvorí v projekte priečinok Migrations, druhý migráciu vykoná – vznikne databáza Obchod s tabuľkami Zakaznici a Objednavky. Keď neskôr do triedy pridáte vlastnosť, postup zopakujete s novým názvom migrácie a EF Core pridá do tabuľky iba chýbajúci stĺpec, dáta ostanú zachované.

Vloženie záznamov

using var db = new ObchodContext();

var zakaznik = new Zakaznik { Meno = "Ján Novák", Email = "Táto e-mailová adresa je chránená pred spamovacími robotmi. Na jej zobrazenie potrebujete mať nainštalovaný JavaScript." };
zakaznik.Objednavky.Add(new Objednavka { Datum = DateTime.Today, Suma = 120.50m });
zakaznik.Objednavky.Add(new Objednavka { Datum = DateTime.Today, Suma = 39.90m });

db.Zakaznici.Add(zakaznik);
await db.SaveChangesAsync();

Console.WriteLine($"Nový zákazník má ID {zakaznik.Id}");

Do databázy sa nič nezapíše, kým nezavoláte SaveChangesAsync(). Vtedy EF Core v jednej transakcii vloží zákazníka aj obe objednávky a doplní vygenerované kľúče.

Čítanie

// Všetci zákazníci podľa mena
List<Zakaznik> vsetci = await db.Zakaznici
    .OrderBy(z => z.Meno)
    .ToListAsync();

// Jeden záznam podľa primárneho kľúča (null, ak neexistuje)
Zakaznik? jeden = await db.Zakaznici.FindAsync(1);

// Podmienka, zoradenie, obmedzenie počtu
List<Objednavka> velke = await db.Objednavky
    .Where(o => o.Suma > 100)
    .OrderByDescending(o => o.Datum)
    .Take(10)
    .ToListAsync();

// Agregácia sa vykoná v databáze
decimal spolu = await db.Objednavky.SumAsync(o => o.Suma);

Dotaz sa do databázy odošle až vtedy, keď si vypýtate výsledok – metódou ToListAsync, FirstOrDefaultAsync, CountAsync, SumAsync alebo cyklom foreach. Dovtedy ho možno ďalej skladať.

Súvisiace dáta – Include

Navigačné vlastnosti sa nenačítavajú automaticky. Bez Include by bol zoznam Objednavky prázdny:

List<Zakaznik> zakaznici = await db.Zakaznici
    .Include(z => z.Objednavky)
    .ToListAsync();

foreach (Zakaznik z in zakaznici)
{
    Console.WriteLine($"{z.Meno}: {z.Objednavky.Count} objednávok");
}

Úprava a zmazanie

Kontext si pamätá objekty, ktoré načítal, a sleduje ich zmeny (change tracking). Stačí zmeniť vlastnosť a uložiť:

Zakaznik? z = await db.Zakaznici.FirstOrDefaultAsync(x => x.Email == "Táto e-mailová adresa je chránená pred spamovacími robotmi. Na jej zobrazenie potrebujete mať nainštalovaný JavaScript.");

if (z is not null)
{
    z.Meno = "Ján Novák ml.";
    await db.SaveChangesAsync();   // UPDATE iba zmeneného stĺpca
}

// Zmazanie
Objednavka? o = await db.Objednavky.FindAsync(2);

if (o is not null)
{
    db.Objednavky.Remove(o);
    await db.SaveChangesAsync();
}

Na čo si dať pozor

  • Životnosť kontextu – DbContext je určený na krátke použitie: jedna operácia alebo jedna webová požiadavka. Nedržte jeden kontext počas celého behu aplikácie a nepoužívajte ho z viacerých vlákien naraz.
  • Vždy using – kontext drží spojenie s databázou, treba ho uvoľniť.
  • Migrácie patria do repozitára – sú súčasťou zdrojového kódu a spúšťajú sa pri nasadení.
  • LINQ sa prekladá do SQL – vlastnú metódu C# vo Where databáza nepozná a EF Core vyhodí výnimku. V dotaze používajte len výrazy, ktoré sa dajú preložiť.

V ďalšom článku sa pozrieme na výkon: prečo je niekedy EF Core pomalý a ako písať dotazy, ktoré z databázy neťahajú viac, než treba.

O autorovi

Ing.Jaroslav Vadel

Som zakladateľom www.projectik.eu. Hrám sa na programátora, ktorý ovláda: c#,cpp,java,unity3d,php,html,NI testand,NI Vision Builder,Cognex In-Sight,NI LabView "Naprogramovať program, ktorý funguje vie každy. Ale to, že program funguje ešte neznamena, že je napísany správne "

Súvisiace články