Drupal

Als ersten Artikel unter dem Tag "Coder's Implementation {LANG}" beschäftige ich mich mit dem Umsetzen der in [Coder's Concept] Plugin-Architektur (v 1.0) beschriebenen Plugin-Architektur, in C#. Alle Artikel mit diesem Tag beziehen sich auf einen Artikel mit dem Tag "Coder's Concept". Implementierungsartikel versuche ich mit Klassendiagrammen zu anzureichern.

Projektstruktur

Das Projekt enthält drei Unterprojekte:

1. TodoShared
2. TodoApp
3. DoneFilter

TodoShared

Das erste Projekt enthält die Typen, die vom Programm und von Plugins benötigt werden. Darin enthalten sind eine Klasse (Task) und eine Schnittstelle (ITaskFilter).

Die Schnittstelle muss von allen Plugins implementiert werden und wird als Anker vom Programm benutzt, um eine Liste der geladenen Plugins zusammenzustellen. Alle anderen Projekte referenzieren dieses Projekt. Dadurch sind diese beiden Typen in den beiden anderen Projekten verfügbar.

TodoApp

Das zweite Projekt enthält den Quellcode für das Pluginbasierte Programm.

Dieses Projekt besteht aus 5 nennenswerten Klassen:

1. Program
   Hier werden alle Plugins, die in einem bestimmten Ordner liegen, geladen und eine Liste mit verfügbaren Filtern angelegt.
2. Document
   Diese Klasse enthält eine Liste von Aufgaben und die dazugehörenden Verwaltungsfunktionen. Es wird ein Ereignis zur Verfügung gestellt, das immer dann feuert, wenn sich das Dokument ändert.
3. DocumentView
   Ein Dialog, der ein Document-Objekt unter Anwendung eines Filters (also eines Plugins) anzeigt.
4. MainWindow
   Das Hauptfenster, das Operationen wie "neu", "laden" und "speichern" realisiert.
5. EverythingFilter
   Da DocumentView-Objekte immer einen Filter benötigen, gibt es fest einen Filter, der alle Aufgaben eines Dokuments passieren lässt. Er realisiert die ungefilterte Ansicht.

DoneFilter

Dieses Projekt enthält einen einfachen Filter, der nur bereits erledigte Aufgaben passieren lässt. Wichtig sind die Projekteinstellungen:

Damit der Filter zur Verfügung steht, muss er in das plugins-Verzeichnis kopiert werden, von wo aus er von der Klasse Program im Projekt TodoApp geladen wird. Daher ist es notwendig, dass dieser Ordner im Unterverzeichnis bin/debug existiert. In der an diesem Artikel verlinkten Zip-Datei ist der Ordner vorhanden.

Assemblies zur Laufzeit laden

Assemblies nachträglich zu laden ist einfach.

string[] filenames = Directory.GetFiles(Directory.GetCurrentDirectory()+"\plugins");
foreach (string filename in filenames)
{
Assembly asm = Assembly.LoadFile(filename);
foreach (Type t in asm.GetTypes())
{
if (t.IsClass && t.GetInterface(typeof(ITaskFilter).Name).Equals(typeof(ITaskFilter)))
{
plugins.Add((ITaskFilter)t.GetConstructor(Type.EmptyTypes).Invoke(null));
}
}
}

Zunächst werden alle potentiellen Assemblies festgestellt (das erledigt das äußerste foreach) und geladen. Danach werden alle Typen in dem geladenen Assembly betrachtet. Wenn es sich um eine Klasse handelt und das notwendige Interface implementiert wird, so wird das Objekt instanziert und abgelegt. Innerhalb des Programms wird immer nur über das Interface mit den Plugins kommuniziert.

Der angehängte Code ist kommentiert und sollte keine Fragen offen lassen.