nopCommerce Dokumentace

Databázové migrace

Stručný popis změn v přístupu k práci s databází

Práce s databází byla ve verzi nopCommerce 4.30 výrazně přepracována. První změnou, které si lze všimnout, je úplné opuštění navigačních vlastností. O užitečnosti tohoto přístupu můžeme přemýšlet a polemizovat, ale má několik kladných stránek:

  1. Zjednodušení porozumění kódu a jeho údržby.

    Poznámka

    Během refaktoringu kódu jsme nalezli a opravili několik nepřesností, které ovlivňovaly výkon i funkčnost.

  2. Plná kontrola nad dotazy a okamžikem jejich provedení (což pozitivně ovlivňuje výkon celého řešení).
  3. Možnost zjednodušit proces migrace na libovolný databázový framework (to nejdůležitější).

Protože nopCommerce zcela přešel na .NET Core (verze 4.10) a stal se multiplatformním řešením, podpora více databází se stala stále důležitějším aspektem. Tým nopCommerce provedl rozsáhlý výzkum a analýzu a rozhodl se upustit od používání standardního Entity Framework Core. Zároveň jsme se rozhodli nepracovat s databází prostřednictvím dotazů LINQ s využitím přístupu OOP (což je nejběžnější přístup, který používají vývojáři v C#). Konečná volba padla na kombinaci Linq2DB a FluentMigrator. Níže podrobně popíšu roli každého z těchto frameworků.

Linq2DB

Poznámka

Od verze 4.30 používá nopCommerce jako ORM framework Linq2DB. Linq2DB je objektově-relační mapper (ORM), který vývojářům v .NET umožňuje pracovat s databází pomocí objektů .NET. Dokáže mapovat objekty .NET na celou řadu databázových poskytovatelů.

V nopCommerce se Linq2DB používá jako vrstva pro přístup k databázi. V současné době nopCommerce podporuje tři nejoblíbenější databáze: MS SQL Server, MySQL a PostgreSQL. Pokud kód analyzujeme, snadno zjistíme, že každá databáze je podporována vlastní třídou, která implementuje rozhraní INopDataProvider. Pokud však neplánujete vytvářet vlastního poskytovatele přístupu k databázi, můžete podrobnosti implementace zcela ignorovat. Pro většinu vývojových úloh postačí porozumět jen několika bodům:

  1. Potřebujete objekt odpovídající tabulce v databázi (třídu POCO).
  2. Veškerá práce s daty tabulky probíhá přes rozhraní IRepository<TEntity>. Nemusíte se ani starat o jeho umístění do IoC, protože je registrováno voláním příslušné tovární metody.
  3. Musíte řídit vytvoření tabulky v databázi.

Abychom vyřešili poslední bod, musíme se zabývat druhým frameworkem z této kombinace, a to FluentMigratorem.

FluentMigrator

Poznámka

Fluent Migrator je migrační framework pro .NET podobný migracím v Ruby on Rails. Migrace představují strukturovaný způsob změny databázového schématu a jsou alternativou k vytváření množství skriptů SQL, které musí ručně spouštět každý zapojený vývojář. Migrace řeší problém vývoje databázového schématu pro více databází (například lokální databázi vývojáře, testovací databázi a produkční databázi). Změny databázového schématu jsou popsány ve třídách napsaných v C#. Tyto třídy lze ukládat do systému správy verzí.

Podrobný postup přidání vlastních entit je popsán v následujícím článku: Plugin s přístupem k datům. Zde se proto zastavíme pouze u obecných teoretických bodů:

  1. Migrace jsou podporovány na úrovni samotného kódu nopCommerce.
  2. Můžete vytvářet libovolné migrace zděděné z abstraktní třídy MigrationBase.
  3. Pro zjednodušení správy verzí migrací jsme do kódu přidali atribut NopMigrationAttribute zděděný z MigrationAttribute. Nyní můžete místo obvyklého dlouhého čísla jednoduše uvést datum a čas vytvoření migrace.
  4. Přidali jsme také atribut SkipMigrationOnUpdateAttribute, který určuje, zda se má migrace během procesu aktualizace přeskočit.
  5. Tabulku v databázi můžete vytvořit dvěma způsoby:
    • Použijte metodu Create.Table v metodě Up vaší migrační třídy a všechny podrobnosti zadejte pomocí rozšiřujících metod.
    • Použijte metodu IMigrationManager.BuildTable<T> v metodě Up vaší migrační třídy a všechny podrobnosti v případě potřeby zadejte pomocí implementace rozhraní IEntityBuilder a INameCompatibility (v nopCommerce používáme tento přístup).

Důležité

Abyste mohli spustit nové migrace, musíte zvýšit verzi v souboru plugin.json.