Akka.NET integration plugin for Grace dependency injection library
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
LICENSE
RELEASE_NOTES.md
Readme.md
appveyor.yml
build.cmd
build.fsx
build.ps1

Readme.md

Akka.DI.Grace Build status NuGet Version

Actor Producer Extension backed by the Grace Dependency Injection Container for the Akka.NET framework.

What is it?

Akka.DI.Grace is an ActorSystem extension for the Akka.NET framework that provides an alternative to the basic capabilities of Props when you have Actors with multiple dependencies.

If Grace is your IoC container of choice and your actors have dependencies that make using the factory method provided by Props prohibitive and code maintenance is an important concern then this is the extension for you.

Installation

Akka.DI.Grace can be installed via the NuGet UI (as Akka.DI.Grace), or via the NuGet Package Manager console:

PM> Install-Package Akka.DI.Grace

How do you use it?

The best way to understand how to use it is by example. If you are already considering this extension then we will assume that you know how how to use the Grace container. This example is demonstrating a system using ConsistentHashing routing along with this extension.

Start by creating your Grace DependencyInjectionContainer, registering your actors and dependencies.

// Setup Grace
IInjectionScope container = new DependencyInjectionContainer(cfg =>
    {
        cfg.Export<WorkerService>().As<IWorkerService>();
        cfg.Export<TypedWorker>();
    });

Next you have to create your ActorSystem and inject that system reference along with the container reference into a new instance of the GraceDependencyResolver.

// Create the ActorSystem
using (var system = ActorSystem.Create("MySystem"))
{
    // Create the dependency resolver
    IDependencyResolver resolver = new GraceDependencyResolver(container, system);

    // we'll fill in the rest in the following steps
}

To register the actors with the system use method Akka.Actor.Props Create<TActor>() of the IDependencyResolver interface implemented by the GraceDependencyResolver.

// Register the actors with the system
system.ActorOf(resolver.Create<TypedWorker>(), "Worker1");
system.ActorOf(resolver.Create<TypedWorker>(), "Worker2");

Finally create your router, message and send the message to the router.

// Create the router
IActorRef router = system.ActorOf(Props.Empty.WithRouter(new ConsistentHashingGroup(config)));

// Create the message to send
TypedActorMessage message = new TypedActorMessage
{
   Id = 1,
   Name = Guid.NewGuid().ToString()
};

// Send the message to the router
router.Tell(message);

The resulting code should look similar to the the following:

// Setup Grace
IInjectionScope container = new DependencyInjectionContainer(cfg =>
    {
        cfg.Export<WorkerService>().As<IWorkerService>();
        cfg.Export<TypedWorker>();
    });

// Create the ActorSystem
using (var system = ActorSystem.Create("MySystem"))
{
    // Create the dependency resolver
    IDependencyResolver resolver = new GraceDependencyResolver(container, system);

    // Register the actors with the system
    system.ActorOf(resolver.Create<TypedWorker>(), "Worker1");
    system.ActorOf(resolver.Create<TypedWorker>(), "Worker2");

    // Create the router
    IActorRef router = system.ActorOf(Props.Empty.WithRouter(new ConsistentHashingGroup(config)));

    // Create the message to send
    TypedActorMessage message = new TypedActorMessage
    {
       Id = 1,
       Name = Guid.NewGuid().ToString()
    };

    // Send the message to the router
    router.Tell(message);
}

Maintainer