DependencyModules.SourceGenerator 1.0.0-RC9066

This is a prerelease version of DependencyModules.SourceGenerator.
dotnet add package DependencyModules.SourceGenerator --version 1.0.0-RC9066                
NuGet\Install-Package DependencyModules.SourceGenerator -Version 1.0.0-RC9066                
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="DependencyModules.SourceGenerator" Version="1.0.0-RC9066" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DependencyModules.SourceGenerator --version 1.0.0-RC9066                
#r "nuget: DependencyModules.SourceGenerator, 1.0.0-RC9066"                
#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 DependencyModules.SourceGenerator as a Cake Addin
#addin nuget:?package=DependencyModules.SourceGenerator&version=1.0.0-RC9066&prerelease

// Install DependencyModules.SourceGenerator as a Cake Tool
#tool nuget:?package=DependencyModules.SourceGenerator&version=1.0.0-RC9066&prerelease                

DependencyModules

DependencyModules is a C# source generator package that uses attributes to create dependency injection registration modules. These modules can then be used to populate an IServiceCollection instance.

Installation

dotnet add package DependencyModules.Runtime
dotnet add package DependencyModules.SourceGenerator

Service Attributes

  • [DependencyModule] - used to attribute class that will become dependency module (must be partial)
  • [SingletonService] - registers service as AddSingleton
  • [ScopedService] - registers service as AdddScoped
  • [TransientService] - registers service as AddTransient
// Registration example
[DependencyModule]
public partial class MyModule { }

// registers SomeClass implementation for ISomeService
[SingletonService]
public class SomeClass : ISomeService 
{
  public string SomeProp => "SomeString";
}

// registers OtherSerice implementation
[TransientService]
public class OtherService
{
  public OtherService(ISomeService service)
  { 
    SomeProp = service.SomeProp;
  }
  public string SomeProp { get; }
}

Container Instantiation

AddModule - method adds modules to service collection

var serviceCollection = new ServiceCollection();

serviceCollection.AddModule<MyModule>();

var provider = serviceCollection.BuildServiceProvider();

var service = provider.GetService<OtherService>();

Module Re-use

DependencyModules creates an Attribute class that can be used to apply sub dependencies.

// Modules can be re-used with the generated attributes
[DependencyModule]
[MyModule.Attribute]
public partial class AnotherModule { }

Parameters

Sometimes you want to provide extra registration for your module. This can be achieved by adding a constructor to your module or optional properties. Note these parameters and properties will be correspondingly implemented in the module attribute.

[DependencyModule]
public partial class SomeModule : IServiceCollectionConfiguration 
{
  private bool _someFlag;
  public SomeModule(bool someFlag = false)
  {
    _someFlag = someFlag;
  }
  
  public string OptionalString { get; set; } = "";
  
  public void ConfigureServices(IServiceCollection services) 
  {
    if (_someFlag) 
    {
      // custom registration
    } 
  }
}

[DependencyModule]
[SomeModule.Attribute(true, OptionalString = "otherString")]
public partial class SomeOtherModule 
{

}

Managing duplicate registration

By default a module will only be loaded once, assuming attributes are used or the modules are specified in the same AddModules call. Seperate calls to AddModule will result in modules being loaded multiple times. If a module uses parameters it can be useful to load a module more than once. That can be accompilished by overriding the Equals and GetHashcode methods to allow for multiple loads.

Services will be registered using an Add method by default. This can be overriden using the With property on individual service or at the DepedencyModule level.

[SingletonService(With = RegistrationType.Try)]
public class SomeService { }

[DependencyModule(With = RegistrationType.Try)]
public partial class SomeModule { }

Realm

By default, all dependencies are registered in all modules within the same assembly. The realm allows the developer to scope down the registration within a given module.

// register only dependencies specifically marked for this realm
[DependencyModule(OnlyRealm = true)]
public partial class AnotherModule { }

[SingletonService(ServiceType = typeof(ISomeInterface), 
  Realm = typeof(AnotherModule))]
public class SomeDep : ISomeInterface { }

Keyed Registration

Registration attributes have a Key property that allows for specifying the key at registration time.

[SingletonService(Key = "SomeKey")]
public class KeyService : IKeyService { }

// yields this registration line
services.AddKeyedSingleton(typeof(IKeyService), "SomeKey", typeof(KeyService));

Unit testing & Mocking

DependencyModules provides an xUnit extension to make testing much easier. It handles the population and construction of a service provider using specified modules.

> dotnet add package DependencyModules.xUnit
> dotnet add package DependencyModules.xUnit.NSubstitute

// applies module & nsubstitute support to all tests.
// test attributes can be applied at the assembly, class, and test method level
[assemlby: MyModule.Attribute]
[assembly: NSubstituteSupport]

public class OtherServiceTests 
{
  [ModuleTest]
  public void SomeTest(OtherService test, [Mock]ISomeService service)
  {
     service.SomeProp.Returns("some mock value");
     Assert.Equals("some mock value", test.SomeProp);
  }
  
  public void 
}

Implementation

Behind the scenes the library generates registration code that can be used with any IServiceCollection compatible DI container.

Example generated code for SutModule.cs

    // SutModule.Dependencies.g.cs
    public partial class SutModule
    {
        private static int moduleField = DependencyRegistry<SutModule>.Add(ModuleDependencies);

        private static void ModuleDependencies(IServiceCollection services)
        {
            services.AddTransient(typeof(IDependencyOne), typeof(DependencyOne));
            services.AddSingleton(typeof(IGenericInterface<>), typeof(GenericClass<>));
            services.AddScoped(typeof(IScopedService), typeof(ScopedService));
            services.AddSingleton(typeof(ISingletonService), typeof(SingletonService));
            services.AddSingleton(typeof(IGenericInterface<string>), typeof(StringGeneric));
        }
    }

    // SutModule.Modules.g.cs
    public partial class SutModule : IDependencyModule
    {
        static SutModule()
        {
        }

        // this method loads all dependencies into IServiceCollection.
        public void PopulateServiceCollection(IServiceCollection services)
        {
            DependencyRegistry<SutModule>.LoadModules(services, this);
        }

        void IDependencyModule.InternalApplyServices(IServiceCollection services)
        {
            DependencyRegistry<SutModule>.ApplyServices(services);
        }

        public override bool Equals(object? obj)
        {
            return obj is SutModule;
        }

        public override int GetHashCode()
        {
            return HashCode.Combine(base.GetHashCode());
        }

        public class Attribute : System.Attribute, IDependencyModuleProvider
        {
            public IDependencyModule GetModule()
            {
                var newModule = new SutModule();
                return newModule;
            }
        }
    }
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.  net9.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-RC9066 0 2/8/2025
1.0.0-RC9059 35 2/6/2025
1.0.0-RC9058 33 2/6/2025
1.0.0-RC9048 34 2/2/2025
1.0.0-RC9047 28 2/2/2025
1.0.0-RC9045 33 2/2/2025
1.0.0-RC9044 30 2/2/2025
1.0.0-RC9042 33 2/1/2025
1.0.0-RC9040 30 2/1/2025
1.0.0-RC9024 28 1/31/2025
1.0.0-RC9022 30 1/31/2025
1.0.0-RC9021 30 1/26/2025
1.0.0-RC9015 49 1/5/2025
1.0.0-RC9013 39 1/5/2025
1.0.0-RC9012 38 1/5/2025
1.0.0-RC9011 38 1/5/2025
1.0.0-RC9009 43 1/5/2025
1.0.0-RC9006 54 1/4/2025
1.0.0-RC9003 49 1/4/2025
1.0.0-RC9000 56 1/4/2025
1.0.0-RC8 53 1/4/2025
1.0.0-RC3 64 1/4/2025
1.0.0-RC2 67 1/4/2025
1.0.0-RC1 67 1/3/2025