nopCommerce Dokumentace

Úvod do systému pluginů

Jak inicializovat nový plugin (jak vytvořit nový projekt pluginu)

nopCommerce používá k rozšíření funkčnosti obchodu nopCommerce systém pluginů. Pluginy jsou sadou nezávislých programů nebo komponent, které lze přidat do existujícího systému a rozšířit tak určitou konkrétní funkčnost, a které lze ze systému také odebrat, aniž by to během procesu ovlivnilo hlavní systém.

Poznámka

Více informací o tom, jak vytvořit plugin, najdete na této stránce.

Jak vyhledávat a používat pluginy z obchodu nopCommerce

nopCommerce již obsahuje několik předpřipravených pluginů, které jsou ihned k použití. Můžete také vyhledat řadu pluginů dostupných na oficiálním marketplace nopCommerce a zjistit, zda již někdo nevytvořil plugin, který vyhovuje vašim potřebám. Pokud ne, můžete si vždy vytvořit vlastní plugin podle svých požadavků. Zde se ale podívejme, jak najít a používat pluginy z obchodu nopCommerce. Pro tento účel má nopCommerce marketplace, kde najdeme různé motivy a pluginy. Najdete jej na adrese nopCommerce Marketplace.

image4

Zde vidíte tři karty. Karta All obsahuje všechny motivy a rozšíření, karta Themes obsahuje všechny motivy nopCommerce, které slouží jako vzhled webu nopCommerce, a konečně karta Extensions, kde najdeme pluginy. Přejděte tedy na kartu Extensions. Zde najdete všechny bezplatné i komerční pluginy. Konkrétní plugin, který hledáte, můžete vyhledat zde. Na pravé straně najdete sekci filtrování, pomocí které můžete výběr zúžit. Jakmile hledaný plugin najdete, stačí jej stáhnout a nainstalovat. Každý plugin má na své stránce ke stažení úplný popis toho, jak jej používat, takže si tyto popisy nezapomeňte přečíst.

Rozhraní IPlugin

IPlugin je rozhraní, které zpřístupňuje funkce používané při instalaci nebo odinstalaci pluginu. Každý projekt pluginu musí obsahovat třídu, která toto rozhraní implementuje, aby nopCommerce tento projekt považoval za plugin.

Metoda GetConfigurationPageUrl

string GetConfigurationPageUrl()

Tato metoda by měla vracet URL konfiguračního view. Když plugin nainstalujeme, uvidíme tlačítko Configuration; pokud tedy tuto metodu v naší třídě implementujeme, řetězec, který z ní vrátíme, bude použit jako URL tohoto tlačítka configuration.

Vlastnost PluginDescriptor

PluginDescriptor PluginDescriptor{ get; set; }

Tato vlastnost slouží k získání nebo nastavení informací popisujících aktuální plugin. Když píšeme nový plugin nebo widget, musíme vytvořit soubor plugin.json. nopCommerce používá tentýž soubor k inicializaci hodnoty této vlastnosti.

Metoda InstallAsync

Task InstallAsync();

Metoda se spouští při instalaci pluginu; tato logika obvykle implementuje inicializaci nastavení, lokalizačních řetězců a další infrastruktury pro správnou konfiguraci pluginu.

Metoda UninstallAsync

Task UninstallAsync();

Tato metoda je opakem metody „InstallAsync“; po odinstalaci pluginu by měla zcela odstranit všechny prostředky, které mu byly přiděleny.

Metoda UpdateAsync

Task UpdateAsync(string currentVersion, string targetVersion);

Metoda slouží k aktualizaci pluginu na zadanou verzi.

Metoda PreparePluginToUninstallAsync

Task PreparePluginToUninstallAsync()

Tato metoda se zavolá, když u pluginu klikneme na tlačítko UninstallAsync. Kód uvnitř této metody se spustí předtím, než nopCommerce plugin ze systému odinstaluje. V této metodě můžeme chtít napsat logiku, která ověří, zda lze náš plugin odinstalovat. Můžeme zde například zkontrolovat, zda existují jiné pluginy, které na pluginu, jejž se snažíme odinstalovat, závisejí. Pokud ano, můžeme chtít uživatelům zabránit v odinstalaci pluginu, dokud nebude odinstalován plugin, který na aktuálním pluginu závisí.

Třída PluginDescriptor

Tato třída, jak již název napovídá, uchovává informace popisující plugin. Pokud porovnáte vlastnosti této třídy s klíči ze souboru plugin.json, uvidíte podobnou strukturu. Je to proto, že tato třída PluginDescriptor.cs slouží k namapování souboru plugin.json na třídu C#, aby nopCommerce mohl informace uvedené v plugin.json používat. Kromě těchto vlastností obsahuje třída PluginDescriptor ještě několik dalších vlastností a pomocných metod.

Vlastnost Installed

public virtual bool Installed { get; set; }

Tato vlastnost slouží k ověření, zda je plugin v naší aplikaci nopCommerce nainstalován, či nikoli.

Vlastnost PluginType

public virtual Type PluginType { get; set; }

Slouží k získání nebo nastavení typu pluginu. Tento typ odkazuje na třídu, která v projektu pluginu implementuje rozhraní IPlugin.

Vlastnost OriginalAssemblyFile

public virtual string OriginalAssemblyFile { get; set; }

Slouží k získání nebo nastavení původního souboru sestavení (assembly), ze kterého byla vytvořena stínová kopie.

Vlastnost ReferencedAssembly

public virtual Assembly ReferencedAssembly { get; set; }

Slouží k získání nebo nastavení stínově zkopírovaného sestavení, které je v aplikaci aktivní.

Vlastnost ShowInPluginsList

public virtual bool ShowInPluginsList { get; set; } = true;

Tato vlastnost určuje, zda chceme plugin zobrazovat v seznamu pluginů, či nikoli.

Metoda GetPluginDescriptorFromText

public static PluginDescriptor GetPluginDescriptorFromText(string text)

Tato metoda přijímá jako vstup řetězec json a parsuje jej na typ PluginDescriptor. Vrací PluginDescriptor získaný z řetězce json.

Metoda Save

public virtual void Save()

Slouží k uložení popisu pluginu z PluginDescriptor do souboru plugin.json.

Metoda CompareTo

public int CompareTo(PluginDescriptor other)

Porovná aktuální instanci PluginDescriptor s jinou instancí PluginDescriptor předanou jako parametr, a to porovnáním vlastnosti FriendlyName. Vrací celé číslo, které udává, zda tato instance v pořadí řazení předchází zadanému parametru, následuje po něm, nebo se nachází na stejné pozici.

Metoda Instance

public virtual TPlugin Instance<TPlugin>() where TPlugin : class, IPlugin

Tato metoda slouží k získání instance pluginu typu daného vlastností PluginType z aktuálního PluginDescriptor.

Rozhraní IPluginManager

IPluginManager je generické rozhraní s typovým parametrem třídy. Obsahuje deklarace metod používaných k načítání pluginů pomocí různých parametrů filtrů. Implementaci tohoto rozhraní najdeme ve třídě PluginManager, která se nachází ve jmenném prostoru {Nop.Services.Plugins}.

Přispěvatelé: nopsg DmitriyKulagin
Upravit na GitHubu