Wilfried Woivré & .Net

Allier MEF et Unity

MARS12

On a vu dans les deux derniers articles comment débuter avec MEF (Managed Extensibility Framework) et Unity, on peut donc maintenant imaginer les possibilités que ceux-ci offrent en terme de développement. Mais il faut avouer que coupler les deux serait encore un plus pour nos architectures. Et bien c’est possible grâce à MEFContrib (http://mefcontrib.codeplex.com, oui Codeplex est une source de framework presque intarissable)

Bon alors imaginons un cas assez concret, comme une application client lourd, celle-ci permet la création (et donc l’ajout) de plugins. Il est bien évident que chacun des plugins aura une tâche particulière. Par exemple, un plugin pourrait afficher des flux RSS, un autre attaquer la base de données de l’application afin d’afficher les différents utilisateurs présent en base. Bref beaucoup de possibilité, on voit donc ici l’intérêt de MEF afin de créer des plugins ayant un traitement spécifique et cependant se liant parfaitement à notre application.

Donc assez de parole, si l’ont crée cette application (tout le code sera fourni à la fin de cet article)

On va donc commencer par créer notre application en utilisant une architecture à base de plugins, voici donc ci-dessous les références entre nos différentes assemblys :

image

Si on détaillait un peu ce qu’il y a dans chaque assembly :

  • Client : Notre application WPF qui hébergera les différents plugins
  • Service : Cette assembly va dans notre cas servir de Repository, elle jouera donc le rôle de base de données.
  • Model : Contient les différentes entités de notre application
  • Contracts : Contient les différentes interfaces nécessaires à notre application
  • Plugin : Contient les différents plugins de notre application

Bon maintenant, qu’on a vu les références dans notre application, si on voyait notre application avec son joli design (ou pas)

image

Je ne vais détaillé tous le code, mais on va tout de même voir les interactions pour MEF. Commençons par notre assembly Contract, elle contient deux interfaces qui sont IModule, et IModuleMetadata, qui sont respectivement, l’interface pour définir un module, et l’interface qui contiendra les metadata de chaque objet.

public interface IModule
{
}
public interface IModuleMetadata
{
string Title { get; }
string Author { get; }
}

Notre première interface va en fait être utilisé pour nos différentes interactions utilisées par MEF, ici, cette interface ne défini aucune méthode puisque nos modules sont indépendants.

Notre deuxième définit un titre un nom d’auteur pour chacun des composants, comme ça on sait sur qui il faut taper quand ça ne marche pas ….

Passons à un module, celui des flux RSS par exemple,

[Export(typeof(IModule))]
[ExportMetadata("Title", "Flux RSS de Wilfried Woivré")]
[ExportMetadata("Author", "Wilfried Woivré")]
public partial class RSSControl : UserControl, INotifyPropertyChanged, IModule

On voit donc ici un export de type IModule, et les différentes metadatas de ce module. Bref, rien de bien compliqué dans notre cas du coup.

Il ne manque plus que notre client WPF qui héberge notre application

public partial class Window1 : Window
{
[ImportMany]
Lazy<IModule, IModuleMetadata>[] modules;

[Export(typeof(Func<List<Person>>))]
private List<Person> GetPersons()
{
return new ServiceMock().GetPerson();
}

On a donc ici notre liste de modules que l’on va chargé grâce à MEF. Dans notre fonction que l’on déclare en mode export, on expose la liste des personnes comprises dans notre application, puisque le module qui affiche ces informations n’a pas accès à l’assembly qui gère cela.

Ici, au terme de cette première étape, on a donc une application modulaire grâce à MEF ! Mais chacun de ces modules est “libre” de faire ce qu’il veut, prenons un cas concret, imaginons que l’on veuille instaurer des logs dans notre application. Comment fait-on ? On a le choix me direz-vous, chacun des modules peut choisir de faire ce qu’il veut, ou alors on essaye d’unifier nos différents logs.

Même autre cas, notre méthode ‘GetPersons()’ qui est exportées par MEF n’est déclarée dans aucune interface, donc il faut rédiger une documentation sur toutes les méthodes disponibles, documentation qui ne sera d’ailleurs peut être même pas lue …

Une solution serait donc de passer via une Factory, en effet, si l’on indique que notre ‘ServiceMock’ implémente une interface IContract, on peut utiliser une seule méthode à exportée qui renverrait une instance de notre ServiceMock, on pourrait donc avoir une seule méthode à exporter qui serait de ce type :

[Export(typeof(Func<IFactory>))]
private IFactory GetPersons()
{
return ServiceMock.GetSingleton();
}

Ainsi, il n’y aurait qu’une fonction principale à répertorier dans notre documentation, pour le reste, l’IntelliSense peut vous aider très facilement, mais bien entendu cela n’empêche pas de faire tout plein de doc !

Bon, vous allez me dire, qu’on arrive enfin à un rendu pas trop mal, mais qu’en est-il d’Unity là dedans …. Grâce à lui nous allons ajouter notre logger dans notre cas.

Alors on sait que MEF est fait pour intégrer des éléments non connus dans notre application, alors qu’Unity travaille sur des éléments connus à l’avance, donc ça peut poser problème au final. Donc heureusement, Codeplex est riche en utilitaire et framework en tout genre, il y a donc comme je l’ai dit le projet MefContrib qui est une bonne base pour créer une application intégrant MEF et Unity.

Pour plus de facilité, j’ai redéfini le Bootstrapper d’Unity afin d’y injecter mes données relatives à MEF.

public class BootStrapper : UnityBootstrapper
{
public CompositionContainer MefContainer { get; private set; }

protected override IUnityContainer CreateContainer()
{
var aggregateCatalog = new AggregateCatalog(new ComposablePartCatalog[] { new DirectoryCatalog(@".\Extensions") });
var unityContainer = new UnityContainer();
MefContainer = unityContainer.RegisterFallbackCatalog(aggregateCatalog);

return unityContainer;
}

protected override void ConfigureContainer()
{
Container.RegisterInstance(MefContainer);
Container.RegisterInstance<ILogger>(new Logger());

base.ConfigureContainer();
}

protected override IModuleCatalog GetModuleCatalog()
{
return new DirectoryModuleCatalog() { ModulePath = @".\Extensions" };
}

protected override System.Windows.DependencyObject CreateShell()
{
var view = Container.Resolve<Window1>();
view.Show();

var mefModules = MefContainer.GetExports<IModule>();
view.LoadModules(mefModules);

return view;
}
}

Ici, on hérite donc de la classe Bootstrapper qui est présente dans Unity, c’est une méthode courante que l’on retrouve souvent lorsqu’on utilise PRISM.

Notre première méthode va donc créer notre container Unity, et va y rajouter un catalogue pointant sur notre dossier de plugin. La deuxième va nous permettre de configurer ce précédent container, et d’y ajouter une instance de type ILogger. La suivante indique le chemin des Module, dans laquelle on va injecter du Unity. Et enfin la dernière va créer notre Shell, et lui affecter les différentes instances de modules.

J’ai de plus redéfini quelques méthodes d’extension pour IUnityContainer que vous pourrez voir dans la source du code, je vous laisse un peu de surprise.

A partir de là, on est presque près, cependant au lancement de l’application on n’a pas les logs actifs, ce qui est un soucis, étant donné que c’est ce qu’on désirait. Afin d’arranger cela, rien de plus simple, il suffit de jouer avec les attributs de MEF en exportant le constructeur prenant une instance de ILogger en entrée.

[ImportingConstructor]
public RSSControl(ILogger logger) : this()
{
Logger = logger;
}

Et là rien de plus, on a bien nos différents logs actifs. On a donc réussi à intégrer MEF avec Unity, grâce à tout plein de librairies…

Bref, pour conclure avant de vous fournir le code source de l’application, l’intégration de MEF avec Unity est un bon moyen de coupler IoC et Extensions, cependant cela ralentit fortement le chargement des applications, et je pense que la maintenance de celles-ci ne doit pas être améliorée étant donné qu’il faut connaitre les deux technologies pour maintenir le Shell. Mais cependant c’est tout de même un beau challenge à réaliser … La suite plus tard, étant donné que mon projet pour la fin de l’année se base sur ces trois derniers articles.

image

Remonter

Débuter avec Unity

MARS5

Maintenant qu’on a vu comme débuter avec MEF (Managed Extensibility Framework), on va passer à Unity.

Unity est un concept de développement, disponible dans les Enterprise Library de Microsoft, en version 4.1 lors de l’écriture de cet article. Unity sert à effectuer de l’IoC (Inversion de contrôle) sur les composants que l’on souhaite.

Avant de commencer, à quoi sert l’IoC ? L’IoC permet d’apporter à vos projets un nouveau niveau d’abstraction à votre code. Le but de l’IoC est que ce soit le contrôle qui appelle qui fournisse les différents accès, classes, instances au contrôle appelé.

Imaginons un cas simple, dans une application nous voulons logger des éléments, nous avons diverses manières de le faire. On peut dans un premier cas, instancier un nouveau logger à chaque fois qu’on en a besoin. La deuxième qui est mieux, et d’utiliser une factory qui va gérée elle-même la ou les instances de logger. La troisième se fait via Unity, ou lors de la création de nos contrôles on lui passe un type ou une instance de ILogger. On va comprendre ça mieux par la suite avec l’exemple.

Déjà installer et récupérer Unity, ça peut être utile histoire de s’amuser avec ! Vous pouvez trouver Unity sur Codeplex à l’adresse http://unity.codeplex.com, de plus il est compris dans les enterprise library que je conseille à tous d’utiliser que ce soit pour Unity ou autres, il y a vraiment plein de choses sympas dedans !

Pour mon exemple, histoire de ne pas faire trop compliqué, je suis reparti d’une présentation de Mike Taulty sur PRISM et Silverlight. Unity fait partie de PRISM, mais il peut très bien tourner sans. Vous pouvez retrouver la vidéo sur Channel 9 http://channel9.msdn.com/posts/mtaulty/Prism--Silverlight-Part-2-Dependency-Injection-with-Unity/

Donc pour ceux qui n’iront pas voir les vidéos de cette saga, il présente les différentes caractéristiques de PRISM. Pour Unity, il réalise une calculette en application Console que je vais vous présenter ci dessous.

Utilisons un peu les possibilités de Visual Studio 2010 pour notre schéma, voici donc la structure éclaté de la solution.

image

La solution est donc divisé en 6 namespaces :

  • InterfacesLibrary contient les différentes interfaces implémentées dans l’application
  • InputOutputLibrary contient les différentes classes gérant les entrées et sorties (Console.WriteLine, Console.ReadLine …)
  • Demo.Unity, c’est le point d’entrée du Program
  • CommonTypesLibrary contient les types communs de l’application (enum d’opération, et une classe Arguments qui contient uniquement 2 int)
  • CalculatorLibrary contient la logique du programme, et oui même pour une addition, il faut que ce soit un peu structuré
  • CalculatorCommandParsingLibrary va se charger de parser toutes les données saisies par l’utilisateur

Le but de notre application est que le cœur du programme utilise les différents éléments tel que le parser, les entrées-sorties uniquement via les interfaces. Suivant le principe d’Unity c’est le point d’entrée de notre Program qui va référencer les différentes instances que notre logique va utiliser.

Si on regarde le schéma des dépendances de nos assembly on obtient ceci avec NDepend :

image

On peut voir que seul Demo.Unity référence les différentes assembly dont nous allons nous servir pour effectuer notre traitement. On remarque aussi, que CalculatorLibrary et Demo.Unity référence Microsoft.Practices.ServiceLocation, et Demo.Unity référence aussi Microsoft.Practices.Unity et Microsoft.Practices.Composite.UnityExtensions, on va voir par la suite, pourquoi ces deux assemblys références cette dll.

Bon si on regardait un peu le code maintenant, je ne vous mets pas tout, je vous fournirais tout le code à la fin de cet article.

Donc en fait dans Unity tout se joue à la création des éléments, on va donc analyser notre classe CalculatorReplLoop et notre Program.cs

Voici notre classe CalculatorReplLoop, enfin une partie :

IInputService inputService;
List<IOutputService> outputServices;
ICalculator calculator;
IInputParserService parsingService;

public CalculatorReplLoop()
{

}

public CalculatorReplLoop(ICalculator calculator, IServiceLocator container, IInputService inputService, IInputParserService inputParserService)
{
this.calculator = calculator;
this.inputService = inputService;
outputServices = new List<IOutputService>(container.GetAllInstances<IOutputService>());
parsingService = inputParserService;
}

Regardons un peu plus en détail notre deuxième constructeur, on voit qu’il prend en paramètre diverses interfaces.

ICalculator, IInputService et IInputParserService sont les différences interfaces implémentées dans notre programme, elles servent respectivement à effectuer les opérations, récupérer les valeurs saisies via la console, parser les différentes commandes saisies par l’utilisateur.

IServiceLocator est un objet qui dans notre cas va encapsuler un UnityContainer qui contient les différents types que nous avons injecté. Vous pouvez retrouver IServiceLocator sur Codeplex : http://compositewpf.codeplex.com/. On reviendra néanmoins sur ce que contient ce container, lorsque je vais vous présenter ce qu’on injecte avec Unity.

Passons maintenant à la partie lancement du programme, puis ce que comme je vous l’ai dit c’est l’appelant qui injecte des données à l’appelé, et non l’appelé qui demande des données.

class Program
{
static void Main(string[] args)
{
UnityContainer container = new UnityContainer();

container.RegisterType<ICalculator, Calculator>();
container.RegisterType<ICalculatorReplLoop, CalculatorReplLoop>();
container.RegisterType<IInputService, ConsoleInputService>();
container.RegisterType<IInputParserService, InputParserService>();

container.RegisterType<IOutputService, ConsoleOutputService>("Consoleoutput");
container.RegisterType<IOutputService, MsgBoxOutputService>("MsgBoxOutput");
container.RegisterInstance<IServiceLocator>(new UnityServiceLocatorAdapter(container));

ICalculatorReplLoop loop = container.Resolve<ICalculatorReplLoop>();
loop.Run();
}
}

Au premier abord, Unity peut faire peur à cause de cela. Mais en fait, la réalisation est assez simple, on utilise un objet de type UnityContainer qui va contenir tous les types et les instances que l’on veut utiliser dans notre application.

Prenons le premier bloc, ici, nous “enregistrons” les types ICalculator, ICalculatorReplLoop, IInputService et IInputParserService associés à des classes qui implémentent ces interfaces. Ensuite, les choses se corsent un peu, en effet pour présenter le plus d’éléments, j’ai décidé d’utiliser différents instances de IOutputService, j’enregistre donc les deux types dans mon container, puis j’enregistre une instance de IServiceLocator qui encapsulera mon UnityContainer, j’utilise pour cela un UnityServiceLocatorAdapter qui est contenu dans l’assembly Microsoft.Practices.UnityExtension disponible sur http://compositewpf.codeplex.com/

Pourquoi cela ? Et bien tout simplement, parce que je ne voulais pas que le composant que j’appelle connaisse Unity, si ça avait été le cas, le composant pourrait vivre sa propre vie sans que l’appelant le contrôle.

Maintenant qu’on a enregistré nos différents types, instances, il va falloir maintenant résoudre tout cela afin d’avoir une application qui fonctionne. Et là Unity est magique pour cela, il n’y a qu’à demander quel type on veut résoudre, et il fait par lui même les associations.

Bon, et si on exécutait un peu l’application pour voir le rendu :

image

On demande une opération Add qui sera reconnue par notre parser, puis on lui fournit deux entiers, qui seront lus puis stocké dans un objet Arguments, et on affiche le résultat de l’opération à la fois dans la Console et dans une MessageBox.

Il existe de nombreuses façon d’utiliser Unity, dans ce cas je l’ai utilisé totalement au niveau du code, cependant il est possible d’enregistrer nos différents types au niveau d’un simple fichier de configuration, et ce sans référencer les différentes assembly. Pour ma part, je ne suis pas très adepte de cette méthode, car pour moi ce qui doit être en configuration est quelque chose qui est voué à changer un jour. Or là Unity est prévue pour la conception des applications qui elle n’est pas vouée à changer.

Et voici comme promis le code source de l’application (sous Visual Studio 2008, je pense à ceux qui n’ont pas encore migré) :

image

Remonter