Shiny.Mediator 1.0.0-alpha-0038

Prefix Reserved
This is a prerelease version of Shiny.Mediator.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator --version 1.0.0-alpha-0038                
NuGet\Install-Package Shiny.Mediator -Version 1.0.0-alpha-0038                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Shiny.Mediator" Version="1.0.0-alpha-0038" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shiny.Mediator --version 1.0.0-alpha-0038                
#r "nuget: Shiny.Mediator, 1.0.0-alpha-0038"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Shiny.Mediator as a Cake Addin
#addin nuget:?package=Shiny.Mediator&version=1.0.0-alpha-0038&prerelease

// Install Shiny.Mediator as a Cake Tool
#tool nuget:?package=Shiny.Mediator&version=1.0.0-alpha-0038&prerelease                

Shiny Mediator (Preview)

PLEASE NOTE - THIS IS AN ALPHA. THINGS ARE LIKELY TO CHANGE

<a href="https://www.nuget.org/packages/Shiny.Mediator" target="_blank"> <img src="https://buildstats.info/nuget/Shiny.Mediator?includePreReleases=true" /> </a>

A mediator pattern, but for apps. Apps have pages with lifecycles that don't necessarily participate in the standard dependency injection lifecycle. .NET MAUI generally tends to favor the Messenger pattern. We hate this pattern for many reasons which we won't get into. That being said, we do offer a messenger subscription in our Mediator for where interfaces and dependency injection can't reach.

This project is heavily inspired by MediatR with some lesser features that we feel were aimed more at server scenarios, while also adding some features we feel benefit apps

Features

  • A Mediator for your .NET Apps (MAUI & Blazor are the main targets for us)
  • Request & event middleware with some great "out of the box" scenarios for your app
  • Think of "weak" message subscriptions without the fuss or mess to cleanup
  • Our MAUI & Blazor integrations allow your viewmodels or pages to implement an IEventHandler<TEvent> interface(s) without them having to participate in the dependency injection provider
  • We still have a "messagingcenter" type subscribe off IMediator for cases where you can't have your current type implement an interface
  • Instead of Assembly Scanning, we have source generators to automatically wireup the necessary registrations for you! (WIP)
  • Lightweight, No external dependencies, tiny bit of reflection
  • Help remove service overrun and reduce your constructor fat
  • Easy to Unit Test

Works With

  • .NET MAUI - all platforms
  • MVVM Frameworks like Prism, ReactiveUI, & .NET MAUI Shell
  • Blazor - Work In Progress
  • Any other .NET platform - but you'll have to come up with your own "event collector" for the out-of-state stuff

Getting Started

Install Shiny.Mediator from NuGet

First, let's create our request & event handlers

using Shiny.Mediator;

public record TestRequest(string AnyArgs, int YouWant) : IRequest;
public record TestEvent(MyObject AnyArgs) : IEvent;

// and for request/response requests - we'll come back to this
public record TestResponseRequest : IRequest<TestResponse> {}
public record TestResponse {}

Next - let's wire up a RequestHandler. You can have ONLY 1 request handler per request type. This is where you would do the main business logic or data requests.

Let's create our RequestHandler

using Shiny.Mediator;

// NOTE: Request handlers are registered as singletons
public class TestRequestHandler : IRequestHandler<TestRequest> 
{
    // you can do all dependency injection here
    public async Task Handle(TestRequest request, CancellationToken ct) 
    {
        // do something async here
    }
}

public class TestResponseRequestHandler : IRequestHandler<TestResponseRequest, TestResponse>
{
    public async Task<TestResponse> Handle(TestResponseRequest request, CancellationToken ct)
    {
        var response = await GetResponseThing(ct);
        return response;
    }
}

public class TestEventHandler : IEventHandler<TestEvent> 
{
    // Dependency injection works here
    public async Task Handle(TestEvent @event, CancellationToken ct)
    {
        // Do something async here
    }
}

Now, let's register all of our stuff with our .NET MAUI MauiProgram.cs

public static class MauiProgram
{
    public static MauiApp CreateMauiApp()
    {
        var builder = MauiApp
            .CreateBuilder()
            .UseMauiApp<App>();
        
        builder.Services.AddShinyMediator();
        builder.Services.AddSingletonAsImplementedInterfaces<TestEventHandler>();
        builder.Services.AddSingletonAsImplementedInterfaces<TestRequestHandler>();
        builder.Services.AddSingltonAsImplementedInterfaces<TestResponseRequestHandler>();
        // OR if you're using our attribute for source generation
    }
}

Lastly, any model model/viewmodel/etc participating in dependency injection can now inject the mediator

public class MyViewModel(Shiny.Mediator.IMediator mediator)
{
    public async Task Execute() 
    {
        await mediator.Send(new TestRequest()); // this will execute TestRequestHandler
        var response = await mediator.Request(new TestResponseRequest()); // this will execute TestResponseRequestHandler and return a value
        
        // this will publish to any service registered that implement IEventHandler<TestEvent>
        // there are additional args here to allow you to execute values in sequentially or wait for all events to complete
        await mediator.Publish(new TestEvent()); 
    }
}

What about my ViewModels?

For .NET MAUI, your viewmodels have the ability to participate in the event publishing chain without being part of dependency injection

With this setup, you don't need to worry about deallocating any events, unsubscribing from some service, or hooking to anything.

Lastly, if your page/viewmodel is navigated away from (popped), it will no longer participate in the event broadcast

First, let's install Shiny.Mediator.Maui Now...let's go back to our MauiProgram.cs and alter the AddShinyMediator

builder.Services.AddShinyMediator(cfg => cfg.UseMaui());

Now your viewmodel (or page) can simply implement the IEventHandler<T> interface to participate

NOTE: Further example to below - you can implement multiple event handlers (or request handlers)

public class MyViewModel : BaseViewModel, 
                           Shiny.Mediator.IEventHandler<TestEvent>,
                           Shiny.Mediator.IEventHandler<TestEvent>
{
    public async Task Handle(TestEvent @event, CancellationToken ct)
    {
    }
    
    public async Task Handle(TestEvent2 @event, CancellationToken ct)
    {
    }
}

Sample

There is a sample in this repo. You do not need any other part of Shiny, Prism, ReactiveUI, etc - those are included as I write things faster with it. Focus on the interfaces from the mediator & the mediator calls itself

Ideas for Workflows Request & Events

  • Use Prism with Modules - want strongly typed navigation parameters, navigations, and have them available to other modules - we're the guy to help!
    • Example TBD
  • Using a Shiny Foreground Job - want to push data an event that new data came in to anyone listening?
  • Have a Shiny Push Delegate that is executing on the delegate but want to push it to the UI, Mediator has a plan!

TODO

  • Document
    • Event Collectors
    • Request Middleware
    • Covariance Event Handlers & Request Middleware - Dependency Injection Support - nothing to do with the library
    • OOBE Middleware - easy, not feature rich - use as a template once you outgrow them
  • Event Collectors for MAUI execute on main thread?
  • Streams - IAsyncEnumerable or IObservable
  • Source Generator Registration
    • Need to use a different method or not use extension methods - maybe AddHandlersFromAssemblyName or allow it to be custom named
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (8)

Showing the top 5 NuGet packages that depend on Shiny.Mediator:

Package Downloads
Shiny.Mediator.Maui

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Blazor

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Resilience

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Caching

Shiny Mediator - A mediator pattern for all .NET Apps

Shiny.Mediator.Prism

Shiny Mediator - A mediator pattern for all .NET Apps

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0-beta-0001 121 10/28/2024
2.1.1 130 10/28/2024
2.1.0 161 10/19/2024
2.1.0-beta-0016 113 10/19/2024
2.1.0-beta-0015 116 10/19/2024
2.1.0-beta-0014 130 10/19/2024
2.1.0-beta-0013 127 10/19/2024
2.1.0-beta-0011 142 10/18/2024
2.1.0-beta-0010 136 10/18/2024
2.1.0-beta-0004 117 10/8/2024
2.1.0-beta-0002 112 10/6/2024
2.0.2 342 10/6/2024
2.0.1 131 10/6/2024
2.0.0 179 10/4/2024
2.0.0-beta-0060 111 10/6/2024
2.0.0-beta-0059 107 10/6/2024
2.0.0-beta-0056 110 10/4/2024
2.0.0-beta-0054 120 10/3/2024
2.0.0-beta-0053 116 10/2/2024
2.0.0-beta-0052 122 10/2/2024
2.0.0-beta-0050 116 10/2/2024
2.0.0-beta-0049 123 10/2/2024
2.0.0-beta-0046 126 10/1/2024
2.0.0-beta-0044 114 9/30/2024
2.0.0-beta-0026 128 9/24/2024
2.0.0-beta-0023 116 9/23/2024
2.0.0-beta-0022 102 9/23/2024
2.0.0-beta-0020 113 9/22/2024
2.0.0-beta-0004 116 9/20/2024
2.0.0-beta-0003 125 9/20/2024
1.9.0-beta-0003 126 9/16/2024
1.9.0-beta-0001 132 9/15/2024
1.9.0-beta 130 9/15/2024
1.8.1 311 9/14/2024
1.8.1-beta-0006 125 9/14/2024
1.8.1-beta-0005 134 9/14/2024
1.8.1-beta-0004 124 9/14/2024
1.8.1-beta-0003 130 9/14/2024
1.8.1-beta-0002 128 9/14/2024
1.8.1-beta-0001 133 9/14/2024
1.8.0 178 9/12/2024
1.8.0-beta-0064 133 9/12/2024
1.8.0-beta-0063 151 9/12/2024
1.8.0-beta-0059 132 9/8/2024
1.8.0-beta-0058 126 9/8/2024
1.8.0-beta-0057 135 9/8/2024
1.8.0-beta-0054 154 9/7/2024
1.8.0-beta-0053 152 9/6/2024
1.8.0-beta-0052 141 9/6/2024
1.8.0-beta-0051 145 9/6/2024
1.8.0-beta-0044 151 9/5/2024
1.8.0-beta-0042 143 9/4/2024
1.8.0-beta-0041 137 9/4/2024
1.8.0-beta-0027 162 8/25/2024
1.8.0-beta-0022 158 8/23/2024
1.8.0-beta-0017 130 8/7/2024
1.8.0-beta-0012 95 7/28/2024
1.8.0-beta-0010 83 7/28/2024
1.7.5 200 8/23/2024
1.7.4 207 8/9/2024
1.7.3 158 8/7/2024
1.7.2 117 7/28/2024
1.7.1 99 7/28/2024
1.7.0 157 7/20/2024
1.7.0-beta-0005 110 7/20/2024
1.7.0-beta-0001 123 7/8/2024
1.6.0 163 7/8/2024
1.6.0-beta-0004 115 7/7/2024
1.5.0 145 7/6/2024
1.5.0-beta-0010 124 7/6/2024
1.5.0-beta-0006 115 7/4/2024
1.4.5 137 7/4/2024
1.4.2 144 6/30/2024
1.4.1 141 6/30/2024
1.4.0 140 6/30/2024
1.4.0-beta-0010 132 6/30/2024
1.3.1 129 6/29/2024
1.3.0 130 6/29/2024
1.3.0-beta-0014 114 6/29/2024
1.3.0-beta-0007 109 6/26/2024
1.2.0 133 6/20/2024
1.2.0-beta-0001 93 6/20/2024
1.1.0 123 6/17/2024
1.1.0-beta-0019 109 6/20/2024
1.1.0-beta-0016 113 6/19/2024
1.1.0-beta-0014 122 6/17/2024
1.1.0-beta-0013 123 6/17/2024
1.0.0 137 6/15/2024
1.0.0-alpha-0054 118 6/15/2024
1.0.0-alpha-0053 118 6/12/2024
1.0.0-alpha-0051 102 6/12/2024
1.0.0-alpha-0048 111 6/10/2024
1.0.0-alpha-0047 120 6/10/2024
1.0.0-alpha-0043 108 6/9/2024
1.0.0-alpha-0042 133 6/7/2024
1.0.0-alpha-0040 118 6/6/2024
1.0.0-alpha-0038 113 6/6/2024
1.0.0-alpha-0036 103 6/5/2024
1.0.0-alpha-0034 127 6/4/2024
1.0.0-alpha-0031 111 6/4/2024
1.0.0-alpha-0025 111 6/3/2024
1.0.0-alpha-0023 118 6/2/2024
1.0.0-alpha-0022 120 6/1/2024
1.0.0-alpha-0019 115 6/1/2024
1.0.0-alpha-0018 102 6/1/2024
1.0.0-alpha-0014 118 6/1/2024
1.0.0-alpha-0013 100 6/1/2024
1.0.0-alpha-0012 106 5/31/2024
1.0.0-alpha-0011 101 5/31/2024
1.0.0-alpha-0010 105 5/31/2024