nopCommerce Dokumentace

Systém událostí entit

Přehled

nopCommerce implementuje architekturu řízenou událostmi (event-driven), která vývojářům umožňuje přihlásit se k odběru nebo zpracovávat události vysílané vydavateli (publishery) nebo zdroji událostí, když je provedena nějaká akce/událost, a zároveň nám umožňuje provést určitou obchodní logiku, když je vyvolána konkrétní událost. V nopCommerce se můžeme přihlásit k odběru nebo naslouchat různým událostem publikovaným systémem nopCommerce, nebo dokonce můžeme napsat logiku, která událost vyšle/publikuje, a té pak lze naslouchat nebo se k jejímu odběru přihlásit. Předpokládejme například, že chceme synchronizovat údaje o zákaznících s nějakým jiným externím systémem; v takovém případě můžeme vyvolat událost, když se v našem obchodě zaregistruje nový zákazník nebo když zákazník změní svůj profil. Této události můžeme naslouchat a provést obchodní logiku, která nově vytvořeného zákazníka získá a odešle jej k synchronizaci do externí služby. A nejlepší na tom je, že to vše můžeme udělat bez změny zdrojového kódu nopCommerce.

Vývojáři mohou událost buď publikovat, nebo zpracovávat:

  • Chce-li vývojář událost publikovat, musí získat instanci IEventPublisher a zavolat metodu Publish s příslušnými daty události.

  • Chce-li vývojář naslouchat události, vytvoří novou implementaci generického rozhraní IConsumer. Jakmile je nová implementace konzumenta vytvořena, nopCommerce ji pomocí reflexe najde a zaregistruje pro zpracování událostí.

Pro události změn dat se používají tři rozšiřující metody vydavatele událostí s názvy EntityInsertedAsync, EntityUpdatedAsync a EntityDeletedAsync s BaseEntity rozšiřující rozhraní IEventPublisher, které odpovídají za vysílání událostí vložení, aktualizace a smazání entity.

EntityInsertedAsync

Tato rozšiřující metoda přijímá jako parametr entitu modelu typu BaseEntity. Používá se k publikování/vysílání události vložení entity typu BaseEntity při vložení nových dat. Tato rozšiřující metoda poté zavolá parametrizovaný konstruktor generické třídy EntityInsertedEvent a zpřístupní vloženou entitu prostřednictvím její vlastnosti Entity. Tu pak může vývojář odebírat/zpracovat implementací rozhraní IConsumer typu EntityInsertedEvent s typem entity, kterou jsme právě vložili, např.: IConsumer<EntyInsertedEvent<BaseEntity>>. Zde BaseEntity může být jakákoli třída modelu, která dědí od třídy BaseEntity.

Implementace publisheru pro událost EntityInserted

public class MyFirstPublisherClass
{
    IEventPublisher _eventPublisher;
    public MyFirstPublisherClass(IEventPublisher eventPublisher)
    {
        this._eventPublisher = eventPublisher;
    }

    public async Task MyFirstProductInsertMethod(Product product)
    {
        //Logic to insert goes here
        await _eventPublisher.EntityInsertedAsync(product);
    }
}

Ve výše uvedeném příkladu vkládáme rozhraní IEventPublisher, abychom pomocí mechanismu dependency injection přes konstruktor získali instanci třídy EventPublisher. V metodě MyFirstProductInsertMethod po dokončení logiky vložení produktu voláme metodu EntityInserted s generickým typem Product (který musí dědit od třídy BaseEntity) a nově vytvořeným objektem produktu jako parametrem. Zavoláním této rozšiřující metody se vyšle událost vložení entity pro typ produkt a kdokoli, kdo tuto událost odebírá/jí naslouchá, obdrží tento objekt produktu jako parametr události. Nyní se podívejme, jak tuto událost zpracovat.

Implementace konzumenta pro událost EntityInserted

public class MyFirstConsumerClass : IConsumer<EntityInsertedEvent<Product>>
{
    public async Task HandleEventAsync(EntityInsertedEvent<Product> insertEvent)
    {
        //you can access entity using insertEvent.Entity
        var insertedEntity = insertEvent.Entity;

        //Here goes the business logic you want to perform...

    }
}

Zde vytváříme třídu, která dědí od IConsumer<EntityInsertedEvent<Product>>. Rozhraní IConsumer má pouze jednu metodu, kterou je třeba implementovat, a to metodu HandleEvent. Kdykoli je nyní vyvolána událost EntityInserted typu Product, zavolá se tato metoda HandleEvent s objektem EntityInsertedEvent entity typu produkt. A zde uvnitř této třídy můžeme provést svou obchodní logiku pro další zpracování těchto dat.

EntityUpdatedAsync

Tato rozšiřující metoda rozhraní IEventPublisher je implementována stejným způsobem jako EntityInserted. Rovněž přijímá jako argument/parametr entitu modelu typu BaseEntity. Používá se k publikování/vysílání události aktualizace entity typu BaseEntity při aktualizaci existující entity. Tato rozšiřující metoda zavolá parametrizovaný konstruktor generické třídy EntityUpdatedEvent a zpřístupní aktualizovanou entitu prostřednictvím její vlastnosti Entity. Tu pak může vývojář odebírat/zpracovat implementací rozhraní IConsumer typu EntityUpdatedEvent s typem Entity, kterou jsme právě vložili, např.: IConsumer<EntityUpdatedEvent<BaseEntity>>.

Implementace publisheru pro událost EntityUpdated

public class MyFirstPublisherClass
{
    IEventPublisher _eventPublisher;
    public MyFirstPublisherClass(IEventPublisher eventPublisher)
    {
        this._eventPublisher = eventPublisher;
    }

    public async Task MyFirstProductUpdateMethod(Product product)
    {
        //Logic to insert goes here
        await _eventPublisher.EntityUpdatedAsync(product);
    }
}

Implementace této třídy je v podstatě stejná jako v příkladu u EntityInserted. V metodě MyFirstProductInsertMethod po dokončení logiky aktualizace produktu voláme metodu EntityUpdatedAsync s generickým typem a právě aktualizovaným objektem produktu jako parametrem. Zavoláním této rozšiřující metody se vyšle událost aktualizace entity pro typ produkt a kdokoli, kdo tuto událost odebírá/jí naslouchá, obdrží tento objekt produktu jako parametr události. Nyní se podívejme, jak tuto událost zpracovat.

Implementace konzumenta pro událost EntityUpdated

public class MyFirstConsumerClass : IConsumer<EntityUpdatedEvent<Product>>
{
    public async Task HandleEventAsync(EntityUpdatedEvent<Product> updateEvent)
    {
        //you can access entity using updateEvent.Entity
        var updatedEntity = updateEvent.Entity;

        //Here goes the business logic you want to perform...

    }
}

I toto je stejné jako třída konzumenta pro událost vložení entity. Zde vytváříme třídu, která dědí od IConsumer<EntityUpdatedEvent<Product>>. Kdykoli je nyní vyvolána událost EntityUpdated typu Product, zavolá se metoda HandleEvent této třídy s parametrem typu EntityUpdatedEvent s objektem entity produktu. A zde uvnitř této třídy můžeme provést svou obchodní logiku pro další zpracování těchto dat.

EntityDeletedAsync

Logika implementace této rozšiřující metody je rovněž stejná jako u rozšiřujících metod EntityInsertedAsync a EntityUpdatedAsync rozhraní IEventPublisher. Tato rozšiřující metoda také přijímá jako argument entitu modelu typu BaseEntity. Používá se k publikování/vysílání události smazání entity BaseEntity při smazání existující entity. Tato rozšiřující metoda zavolá konstruktor generické třídy EntityDeletedEvent a zpřístupní smazanou entitu prostřednictvím její vlastnosti Entity. Tu pak může vývojář odebírat/zpracovat implementací IConsumer<EntityDeletedEvent<BaseEntity>>.

Implementace publisheru pro událost EntityDeleted

public class MyFirstPublisherClass
{
    IEventPublisher _eventPublisher;
    public ExamplePublisherClass(IEventPublisher eventPublisher)
    {
        this._eventPublisher = eventPublisher;
    }

    public async Task MyFirstProductDeleteMethod(Product product)
    {
        //Logic to insert goes here
        await _eventPublisher.EntityDeletedAsync(product);
    }
}

Implementace této třídy je také stejná jako ve výše uvedeném příkladu. V metodě MyFirstProductDeleteMethod po dokončení logiky smazání produktu voláme metodu EntityDeleted s právě smazaným objektem produktu jako parametrem. Zavoláním této rozšiřující metody se vyšle událost smazání entity pro typ produkt a kdokoli, kdo tuto událost odebírá/jí naslouchá, obdrží tento objekt produktu jako parametr události. Nyní se podívejme, jak tuto událost zpracovat.

Implementace konzumenta pro událost EntityDeleted

public class MyFirstConsumerClass : IConsumer<EntityDeletedEvent<Product>>
{
    public async Task HandleEventAsync(EntityDeletedEvent<Product> deleteEvent)
    {
        //you can access entity using deleteEvent.Entity
        var updatedEntity = deleteEvent.Entity;

        //Here goes the business logic you want to perform...
    }
}

I toto je stejné jako třída konzumenta pro událost vložení nebo aktualizace entity. Zde vytváříme třídu, která dědí od IConsumer<EntityDeletedEvent<Product>>.

Kdykoli je nyní vyvolána událost EntityDeleted typu Product, zavolá se metoda HandleEvent této třídy s parametrem typu EntityDeletedEvent s objektem entity produktu. A zde uvnitř této třídy můžeme provést svou obchodní logiku pro další zpracování těchto dat.

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