Shiny.Mediator.AspNet 3.1.0-beta-0013

Prefix Reserved
This is a prerelease version of Shiny.Mediator.AspNet.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Shiny.Mediator.AspNet --version 3.1.0-beta-0013                
NuGet\Install-Package Shiny.Mediator.AspNet -Version 3.1.0-beta-0013                
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.AspNet" Version="3.1.0-beta-0013" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shiny.Mediator.AspNet --version 3.1.0-beta-0013                
#r "nuget: Shiny.Mediator.AspNet, 3.1.0-beta-0013"                
#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.AspNet as a Cake Addin
#addin nuget:?package=Shiny.Mediator.AspNet&version=3.1.0-beta-0013&prerelease

// Install Shiny.Mediator.AspNet as a Cake Tool
#tool nuget:?package=Shiny.Mediator.AspNet&version=3.1.0-beta-0013&prerelease                

Shiny Mediator

<a href="https://www.nuget.org/packages/Shiny.Mediator" target="_blank"> <img src="https://img.shields.io/nuget/v/Shiny.Mediator?style=for-the-badge" /> </a>

Mediator is a behavioral design pattern that lets you reduce chaotic dependencies between objects. The pattern restricts direct communications between the objects and forces them to collaborate only via a mediator object.

Shiny Mediator <NugetBadge name="Shiny.Mediator" /> is a mediator pattern implementation, but for built with ALL .NET apps in mind. We provide a TON of middleware out-of-box to get you up and rolling with hardly any effort whatsoever. Checkout our Getting Started guide to see how easy it is. Imagine using 1 line of code to add offline, caching, or validation to your code!

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

Samples & Documentation

Features

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

What Does It Solve

Problem #1 - Service & Reference Hell

Does this look familiar to you? Look at all of those injections! As your app grows, the list will only grow. I feel sorry for the dude that gets to unit test this bad boy.

public class MyViewModel(
    IConnectivity conn,
    IDataService data,
    IAuthService auth,
    IDialogsService dialogs,
    ILogger<MyViewModel> logger
) {
    // ...
    try {
        if (conn.IsConnected) 
        {
            var myData = await data.GetDataRequest();
        }
        else 
        {
            dialogs.Show("No Connection");
            // cache?
        }
    }
    catch (Exception ex) {
        dialogs.Show(ex.Message);
        logger.LogError(ex);
    }
}

With a bit of our middleware and some events, you can get here:

public class MyViewModel(IMediator mediator) : IEventHandler<ConnectivityChangedEvent>, IEventHandler<AuthChangedEvent> {
    // ...
    var myData = await mediator.Request(new GetDataRequest());

    // logging, exception handling, offline caching can all be bundle into one nice clean call without the need for coupling
}

public class GetDataRequestHandler : IRequestHandler<GetDataRequest, MyData> {

    [OfflineAvailable] // <= boom done
    public async Task<MyData> Handle(GetDataRequest request, CancellationToken cancellationToken) {
        // ...
    }
}

Problem #2 - Messages EVERYWHERE (+ Leaks)

Do you use the MessagingCenter in Xamarin.Forms? It's a great tool, but it can lead to some memory leaks if you're not careful. It also doesn't have a pipeline, so any errors in any of the responders will crash the entire chain. It doesn't have a request/response style setup (not that it was meant for it), but this means you still require other services.

public class MyViewModel
{
    public MyViewModel()
    {
        MessagingCenter.Subscribe<SomeEvent1>(this, @event => {
            // do something
        });
        MessagingCenter.Subscribe<SomeEvent2>(this, @event => {
            // do something
        });

        MessagingCenter.Send(new SomeEvent1());
        MessagingCenter.Send(new SomeEvent2());

        // and don't forget to unsubscribe
        MessagingCenter.Unsubscribe<SomeEvent1>(this);
        MessagingCenter.Unsubscribe<SomeEvent2>(this);
    }
}

Let's take a look at our mediator in action for this scenarios

public class MyViewModel : IEventHandler<SomeEvent1>, IEventHandler<SomeEvent2>
{
    public MyViewModel(IMediator mediator)
    {
        // no need to unsubscribe
        mediator.Publish(new SomeEvent1());
        mediator.Publish(new SomeEvent2());
    }
}

Problem #3 - Strongly Typed Navigation with Strongly Typed Arguments

Our amazing friends over in Prism offer the "best in class" MVVM framework. We'll them upsell you beyond that, but one of their amazing features is 'Modules'. Modules help break up your navigation registration, services, etc.

What they don't solve is providing a strongly typed nature for this stuff (not their job though). We think we can help addon to their beautiful solution.

A normal call to a navigation service might look like this:

_navigationService.NavigateAsync("MyPage", new NavigationParameters { { "MyArg", "MyValue" } });

This is great. It works, but I don't know the type OR argument requirements of "MyPage" without going to look it up. In a small project with a small dev team, this is fine. In a large project with a large dev team, this can be difficult.

Through our Shiny.Framework library we offer a GlobalNavigationService that can be used to navigate to any page in your app from anywhere, however, for the nature of this example, we'll pass our navigation service FROM our viewmodel through the mediator request to ensure proper scope.

public record MyPageNavigatonRequest(INavigationService navigator, string MyArg) : IRequest;
public class MyPageNavigationHandler : IRequestHandler<MyPageNavigatonRequest>
{
    public async Task Handle(MyPageNavigatonRequest request, CancellationToken cancellationToken)
    {
        await request.navigator.NavigateAsync("MyPage", new NavigationParameters { { "MyArg", request.MyArg } });
    }
}

Now, in your viewmodel, you can do this:

public class MyViewModel
{
    public MyViewModel(IMediator mediator)
    {
        mediator.Request(new MyPageNavigationCommand(_navigationService, "MyValue"));
    }
}

Strongly typed. No page required page knowledge from the module upfront. The other dev team of the module can define HOW things work.

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Shiny.Mediator.AspNet:

Repository Stars
shinyorg/templates
dotnet CLI & Visual Studio Templates
Version Downloads Last updated
3.3.1 26 14 hours ago
3.3.0 20 14 hours ago
3.3.0-beta-0028 24 14 hours ago
3.3.0-beta-0025 35 2 days ago
3.3.0-beta-0024 34 2 days ago
3.3.0-beta-0004 59 12 days ago
3.2.0 45 22 days ago
3.2.0-beta-0027 36 22 days ago
3.2.0-beta-0023 59 23 days ago
3.2.0-beta-0020 57 23 days ago
3.1.3 65 23 days ago
3.1.2 60 24 days ago
3.1.1 63 a month ago
3.1.0 64 a month ago
3.1.0-beta-0013 56 a month ago
3.1.0-beta-0006 58 a month ago
3.1.0-beta-0004 62 a month ago
3.0.0 48 a month ago
3.0.0-beta-0055 41 a month ago
3.0.0-beta-0046 53 a month ago
3.0.0-beta-0045 61 a month ago
3.0.0-beta-0043 60 a month ago
3.0.0-beta-0038 61 a month ago
3.0.0-beta-0037 60 a month ago
3.0.0-beta-0029 67 a month ago
3.0.0-beta-0028 54 a month ago
3.0.0-beta-0018 55 a month ago
3.0.0-beta-0016 33 a month ago
3.0.0-beta-0012 44 a month ago
3.0.0-beta-0008 81 2 months ago
3.0.0-beta-0007 74 2 months ago
3.0.0-beta-0004 70 2 months ago
2.2.0-beta-0001 87 4 months ago
2.1.1 112 4 months ago
2.1.0 118 4 months ago
2.1.0-beta-0016 88 4 months ago
2.1.0-beta-0015 80 4 months ago
2.1.0-beta-0014 91 4 months ago
2.1.0-beta-0013 97 4 months ago
2.1.0-beta-0011 103 4 months ago
2.1.0-beta-0010 108 4 months ago
2.1.0-beta-0004 81 4 months ago
2.1.0-beta-0002 74 4 months ago
2.0.2 105 4 months ago
2.0.1 98 4 months ago
2.0.0 95 5 months ago
2.0.0-beta-0060 78 4 months ago
2.0.0-beta-0059 75 4 months ago
2.0.0-beta-0056 79 5 months ago
2.0.0-beta-0054 87 5 months ago
2.0.0-beta-0053 75 5 months ago
2.0.0-beta-0052 81 5 months ago
2.0.0-beta-0050 81 5 months ago
2.0.0-beta-0049 75 5 months ago
2.0.0-beta-0046 73 5 months ago
2.0.0-beta-0044 76 5 months ago
2.0.0-beta-0026 82 5 months ago
2.0.0-beta-0023 79 5 months ago
2.0.0-beta-0022 73 5 months ago
2.0.0-beta-0020 82 5 months ago
2.0.0-beta-0004 77 5 months ago
2.0.0-beta-0003 83 5 months ago
1.9.0-beta-0003 92 5 months ago
1.9.0-beta-0001 90 5 months ago
1.9.0-beta 89 5 months ago
1.8.1 108 5 months ago
1.8.1-beta-0006 88 5 months ago
1.8.1-beta-0005 96 5 months ago
1.8.1-beta-0004 85 5 months ago
1.8.1-beta-0003 86 5 months ago
1.8.1-beta-0002 92 5 months ago
1.8.1-beta-0001 89 5 months ago
1.8.0 125 5 months ago
1.8.0-beta-0064 91 5 months ago
1.8.0-beta-0063 89 5 months ago
1.8.0-beta-0059 77 5 months ago
1.8.0-beta-0058 74 5 months ago
1.8.0-beta-0057 85 5 months ago
1.8.0-beta-0054 89 5 months ago
1.8.0-beta-0053 97 5 months ago
1.8.0-beta-0052 77 5 months ago
1.8.0-beta-0051 94 5 months ago
1.8.0-beta-0044 106 6 months ago
1.8.0-beta-0042 89 6 months ago
1.8.0-beta-0041 95 6 months ago
1.8.0-beta-0027 110 6 months ago
1.8.0-beta-0022 129 6 months ago
1.8.0-beta-0017 114 6 months ago
1.8.0-beta-0012 83 7 months ago
1.8.0-beta-0010 89 7 months ago
1.7.5 151 6 months ago
1.7.4 136 6 months ago
1.7.3 114 6 months ago
1.7.2 119 7 months ago
1.7.1 91 7 months ago
1.7.0 98 7 months ago
1.7.0-beta-0005 76 7 months ago
1.7.0-beta-0001 87 7 months ago
1.6.0 95 7 months ago
1.6.0-beta-0004 88 7 months ago
1.5.0 117 7 months ago
1.5.0-beta-0010 93 7 months ago