nopCommerce Dokumentace

Rozhraní ITypeFinder

ITypeFinder

Jde o velmi jednoduché rozhraní. Obsahuje pouze dvě metody (přičemž jedna má dvě přetížení). Definici rozhraní vidíte níže:

/// <summary>
/// Classes implementing this interface provide information about types 
/// to various services in the Nop engine.
/// </summary>
public interface ITypeFinder
{
  /// <param name="onlyConcreteClasses">A value indicating whether to find only concrete classes</param>
  IEnumerable<Type> FindClassesOfType<T>(bool onlyConcreteClasses = true);

  /// <param name="assignTypeFrom">Assign type from</param>
  /// <param name="onlyConcreteClasses">A value indicating whether to find only concrete classes</param>
  IEnumerable<Type> FindClassesOfType(Type assignTypeFrom, bool onlyConcreteClasses = true);

  /// <summary>
  /// Gets the assemblies related to the current implementation.
  /// </summary>
  IList<Assembly> GetAssemblies();
}

Hlavním úkolem třídy, která toto rozhraní implementuje, je vyhledávat v sestaveních (assemblies) typy zadané třídy nebo rozhraní. Na příkladech ze zdrojového kódu nopCommerce se podíváme, kde se to může hodit. Nejprve se však podívejme na metodu GetAssemblies. Úkolem této metody je jednoduše vrátit seznam sestavení, ve kterých se vyhledávání provádí. Jak přesně se tento seznam sestavuje, závisí na konkrétní implementaci rozhraní.

Výchozí implementace ITypeFinder

Hlavní výchozí implementací tohoto rozhraní je třída WebAppTypeFinder. WebAppTypeFinder pak jen mírně rozšiřuje třídu AppDomainTypeFinder, která v podstatě vykonává veškerou práci s vyhledáváním typů. Používáme však odvozenou třídu, protože rozšiřuje rozsah vyhledávání typů na všechna sestavení z adresáře \Bin, zatímco základní třída pracuje pouze se sestaveními z aktuální aplikační domény.

Nebudeme se zdržovat podrobnostmi implementace metod FindClassesOfType (obě se totiž redukují na velmi jednoduchou funkci, jejíž kód je k dispozici na tomto odkazu) a přejdeme k tomu nejdůležitějšímu na tomto rozhraní.

K čemu tedy rozhraní ITypeFinder potřebujeme

Toto rozhraní se používá v některých velmi důležitých aspektech fungování nopCommerce:

  1. Vyhledávání sestavení pro konfiguraci mechanismu migrací (Jak fungují migrace?)
  2. Vyhledávání tříd určitých rozhraní nezbytných pro správné spuštění webu, například:
    • IStartupTask – počáteční inicializace modulů a pluginů
    • INopStartup – konfigurace služeb a middleware při spuštění aplikace
    • IOrderedMapperProfile – vytvoření konfigurace Mapster
    • IEntityBuilder, INameCompatibility – konfigurace builderu databázových entit pro zpětnou kompatibilitu pojmenování tabulek pro Linq2Db (Vrstva přístupu k datům nopCommerce)
    • IRouteProvider – registrace rout
    • IConsumer<T> – registrace obslužných rutin interních událostí, jako jsou změny databázových entit
    • IExternalAuthenticationRegistrar – registrace a konfigurace externích metod ověřování
  3. Vyhledávání vhodného sledovače zásilek v reálném čase

Závěr

Jak vidíte, rozhraní je malé, ale velmi cenné. Bez použití přístupu realizovaného prostřednictvím metod rozhraní ITypeFinder by bylo obtížné implementovat tak flexibilní modulární strukturu, jaká je v nopCommerce.