PEzBus 1.4.0

PEzBus

Certaines applications traitant de grands flux d'entrées/sorties de données (i.e les OMS, serveurs de jeux videos ...) nécessitent une grande organisation pour orchestrer l'impacte d'une nouvelle donnée ou action sur les données existantes. Dans ce cas précis, développer un système drivé par les évènements permet de créer un effets dominos et mettre un nom sur ces changements.

Le java a son package Guava de google, qui offre un bus d'évènement et implémente le pattern Publish / Subscribe et le rend très accessible grâce aux décorateurs de méthodes :

...
MyEvent event = new MyEvent();
eventBus.post(event);
@Subscribe
public void handleEvent(MyEvent event){
    ...
}

Ce mode de fonctionnement rend l'utilisation des évènements plus convenable et de surcroit plus simple. L'idée de ce package et d'apporter ce mode de fonctionnement plus adéquat aux framework .NET

Par expérience, ce qui manque à cette fonctionalité est la capabilité de modéliser l'impacte d'un évènement sur le système. Pouvoir générer une documentation qui se base sur les évènements et les commentaires XML pour modéliser un système est à mon sens largement suffisant pour décrire le fonctionnement d'un système basé sur les évènements.

Performance

Comme les performances sont fondamentalement importantes, voici des tests realisés :

Job=ShortRun IterationCount=3 LaunchCount=1 WarmupCount=3

Pré-requis

Principalement du café et optionellement un clavier

Installation

 dotnet add package PEzBus

Démarrage

L'utilisation est plutôt simple :

• Créer des classes représentants des évènements (accessoirement avec des attributs pour la transmission de donnée) qui implémente l'interface IEzEvent. L'idéale est de choisir des noms claires qui définissent l'évènement en question : i.e OrderCreatedEvent

• Implémenter des méthodes décorées avec l'attribut Subscribe comme suit :

public class LaClass {
    [Subscribe(typeof(MonSuperEvent))]
    public void MaSuperMethode(){
        ...
    }
}

ou encore :

public class LaClass {
   [Subscribe(typeof(MonSuperEvent))]
   public void MaSuperMethode(MonSuperEvent event){
       var eventArg = event.GetEventArg();
       eventArg.TransformationSayen();
   }
}

• Créer une instance du bus d'évènement :

EventBus eventBus = new();

• Inscrire une instance de la class dans ce bus d'évènement :

var maClass = new LaClass();
eventBus.Register<LaClass>(maClass);

• Publier l'évènement qui se produit :

var event = new MonSuperEvent(...params);
eventBus.Publish(event);

Ensuite,les méthodes ayant comme paramètre de l'attribut Subscribe le type MonSuperEvent [Subscribe(typeof(MonSuperEvent))] seront invokés, si et seulement si une instance de classe contenant la méthode est inscrite dans le bus d'évènement.

Versions

**Première version 😗* 1.0.1 Implémentation du bus d'évènements qui constitue le coeur du projet

TODO :

Modéliser l'impacte que pourrait avoir un évènement sur les données existantes dans l'application en se basant sur le nom des évènements, le nom des méthodes, ainsi que les commentaires XML.

Auteurs

• Aymane EL JAHRANI alias @eljaymane

License

The MIT License (MIT) Copyright © 2024

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.