Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ERNI-Academy/assets-events-abstraction
Events abstractions to publish and subscribe
https://github.com/ERNI-Academy/assets-events-abstraction
abstraction eventbus eventgrid events redis servicebus storage-queues
Last synced: 3 months ago
JSON representation
Events abstractions to publish and subscribe
- Host: GitHub
- URL: https://github.com/ERNI-Academy/assets-events-abstraction
- Owner: ERNI-Academy
- License: mit
- Created: 2022-04-11T14:28:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-21T22:38:50.000Z (over 2 years ago)
- Last Synced: 2024-05-12T06:34:00.306Z (6 months ago)
- Topics: abstraction, eventbus, eventgrid, events, redis, servicebus, storage-queues
- Language: C#
- Homepage:
- Size: 82 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-resources - assets-events-abstraction
README
# About Events Abstraction
Define a contract and many implementations (Azure EventGrid, Azure ServiceBus, Azure Storage Queues, Azure Redis) for publish and subscribe
ERNI Academy StarterKit, PoC, or Gidelines. This is an about description of your repository.
[](#contributors)
## Built With
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
- [.Net 6.0](https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-6)
- [c# 11](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-11)
- [assets-serializers-abstraction (refereced as git submodule)](https://github.com/ERNI-Academy/assets-serializers-abstraction)
## Features
1. Publish
- PublishAsync
2. Subscribe
- Subscribe
- UnSubscribe
- StarProcessingAsync
- StopProcessingAsync
## Getting Started
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
## Prerequisites
.net 6
Visual Studio or Visual Studio Code
## Installation
Installation instructions Events Abstraction by running:
1. Clone the repo
```sh
git clone --recurse-submodules https://github.com/ERNI-Academy/assets-events-abstraction.git
```
> `Important Note`
> All implementations heavly depends on Microsoft Options Pattern for configurations. See https://docs.microsoft.com/en-us/aspnet/core/fundamentals/configuration/options?view=aspnetcore-6.0
> So it is expected a proper configuration in order to work take a look at the samples to see how to configure each publisher/subscriber
> All implementatins also depends on Microsoft logging. See https://docs.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line
2. Publish Basic use
```c#
class MyEvent : EventBase
{
public string MyCustomProperty { get; set; }
}
var @event = new MyEvent { MyCustomProperty = "hi" };
//you can choose between many impl
IEventPublisher publisher = new ErniAcademy.Events.EventGrid.EventGridPublisher();//args ommited for simplicity
IEventPublisher publisher = new ErniAcademy.Events.Redis.RedisPublisher();//args ommited for simplicity
IEventPublisher publisher = new ErniAcademy.Events.ServiceBus.ServiceBusPublisher();//args ommited for simplicity
IEventPublisher publisher = new ErniAcademy.Events.StorageQueues.StorageQueuePublisher();//args ommited for simplicity
//just publish your event
await publisher.PublishAsync(@event);
```
3. Publish Depency injection (ServiceCollection)
```c#
class MyEvent : EventBase
{
public string MyCustomProperty { get; set; }
}
//when configuring your ServiceCollection use the extension methods defined in each library for easy of use.
//This sample is provided with no arguments, take a look on the extensions to see the rest of the arguments, like IConfiguration, ISerializer etc.
services.AddEventsPublisherEventGrid();//args ommited for simplicity
services.AddEventsPublisherRedis();//args ommited for simplicity
services.AddEventsPublisherServiceBus();//args ommited for simplicity
services.AddEventsPublisherStorageQueues();//args ommited for simplicity
//then just inject IEventPublisher directly in your classes
class MyService
{
private readonly IEventPublisher _publisher;
public MyService(IEventPublisher publisher)
{
_publisher = publisher;
}
public async Task SomeMethod()
{
//... some logic
var @event = new MyEvent { MyCustomProperty = "hi" };
//just publish your event
await _publisher.PublishAsync(@event);
}
}
```
4. Subscribe Basic use
```c#
class MyEvent : EventBase
{
public string MyCustomProperty { get; set; }
}
//you can choose between many impl
IEventPublisher subscriber = new ErniAcademy.Events.Redis.RedisSubscriber();//args ommited for simplicity
IEventPublisher subscriber = new ErniAcademy.Events.ServiceBus.ServiceBusSubscriber();//args ommited for simplicity
IEventPublisher subscriber = new ErniAcademy.Events.StorageQueues.StorageQueueSubscriber();//args ommited for simplicity
//first subscribe to an @event by passing a handler to subscribe method
subscriber.ProcessEventAsync += MyProcessor;
private Task MyProcessor(MyEvent @event)
{
//Process @event
}
//start processing events
await subscriber.StarProcessingAsync();
//and when you are done
await subscriber.StopProcessingAsync();
```
3. Subscribe Depency injection (ServiceCollection)
```c#
class MyEvent : EventBase
{
public string MyCustomProperty { get; set; }
}
//when configuring your ServiceCollection use the extension methods defined in each library for easy of use.
//This sample is provided with no arguments, take a look on the extensions to see the rest of the arguments, like IConfiguration, ISerializer etc.
services.AddEventsSubscriberRedis();//args ommited for simplicity
services.AddEventsSubscriberServiceBus();//args ommited for simplicity
services.AddEventsSubscriberStorageQueues();//args ommited for simplicity
//then just inject IEventPublisher directly in your classes
class MyService
{
private readonly IEventSubscriber _subscriber;
public MyService(IEventSubscriber subscriber)
{
_subscriber = subscriber;
}
public async Task SomeMethod()
{
//first subscribe to an @event by passing a handler to subscribe method
_subscriber.ProcessEventAsync += MyProcessor;
//start processing events
await _subscriber.StarProcessingAsync();
//and when you are done
await _subscriber.StopProcessingAsync();
}
private Task MyProcessor(MyEvent @event)
{
//Process @event
}
}
```
## Contributing
Please see our [Contribution Guide](CONTRIBUTING.md) to learn how to contribute.
## License
(LICENSE) © 2022 [ERNI - Swiss Software Engineering](https://www.betterask.erni)
## Code of conduct
Please see our [Code of Conduct](CODE_OF_CONDUCT.md)
## Stats
## Follow us
[](https://www.twitter.com/ERNI)
[](https://www.twitch.tv/erni_academy)
[](https://www.youtube.com/channel/UCkdDcxjml85-Ydn7Dc577WQ)
[](https://www.linkedin.com/company/erni)
## Contact
📧 [[email protected]](mailto:[email protected])
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
