Merge pull request #21 from Tim-Maes/feature/keyed-services

Support for Keyed Services
Tim-Maes · Jan 2, 2024 · 6c3996b · 6c3996b
2 parents b0640fb + 2c25cf9
commit 6c3996b
Show file tree

Hide file tree

Showing 11 changed files with 214 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -15,15 +15,15 @@
 ### Supported types
 <center>
 
-| Type           | Supported|
-|----------------|----------|
-|AddTransient    |✔️        |
-|TryAddTransient |✔️        |
-|AddScoped       |✔️        |
-|TryAddScoped    |✔️        |
-|AddSingleton    |✔️        |
-|TryAddSingleton |✔️        |
-|TryAddEnumerable|❌       |
+| **Type**           | **Available** |  **Keyed (.NET 8)** |
+|--------------------|----------|------------------------------|
+|AddTransient        |✔️        |✔️                            |
+|TryAddTransient     |✔️        |❌                            |
+|AddScoped           |✔️        |✔️                             |
+|TryAddScoped        |✔️        |❌                            |
+|AddSingleton        |✔️        |✔️                            |
+|TryAddSingleton     |✔️        |❌                            |
+|TryAddEnumerable    |❌        |❌                           |
 </center>
 
 ## Installation 📦
@@ -137,6 +137,39 @@ public interface IMyTaskRunner
 }
 ```
 
+**When using keyed services:**
+
+Decorate your class with the attribute and provide the key
+
+```csharp
+[AddScoped("myKey")]
+public class KeyedService
+{
+	public void Run()
+	{
+		// ...
+	}
+}
+
+[AddScoped("key", typeof(IKeyedService))]
+public class KeyedService : IKeyedService
+{
+	public void Run()
+	{
+		// ...
+	}
+}
+
+[AddScoped("anotherKey")]
+public class AnotherKeyedService : IKeyedService
+{
+	public void Run()
+	{
+		// ...
+	}
+}
+```
+
 ### Options Registration
 
 Decorate your class containing the options with `[RegisterOptions]` and specify the corresponding section in `appsettings.json`.

diff --git a/src/Bindicate.Tests/Bindicate.Tests.csproj b/src/Bindicate.Tests/Bindicate.Tests.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
@@ -8,10 +8,13 @@
 
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="6.12.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="7.0.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2" />
-    <PackageReference Include="xunit" Version="2.5.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.1" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="xunit" Version="2.6.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.5">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/Bindicate.Tests/Scoped/AddScopedAttributeTests.cs b/src/Bindicate.Tests/Scoped/AddScopedAttributeTests.cs
@@ -1,4 +1,5 @@
 using Bindicate.Attributes;
+using Bindicate.Attributes.Scoped;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Bindicate.Tests.ScopedTests;
@@ -7,12 +8,28 @@ public class AddScopedAttributeTests
 {
     private readonly Assembly _testAssembly = typeof(AddScopedAttributeTests).Assembly;
 
+    [Fact]
+    public void AddScoped_WithoutAttribute_NotRegistered()
+    {
+        // Arrange
+        var services = new ServiceCollection();
+        services.AddAutowiringForAssembly(_testAssembly).Register();
+        var serviceProvider = services.BuildServiceProvider();
+
+        // Act
+        using var scope = serviceProvider.CreateScope();
+        var service = scope.ServiceProvider.GetService<NonRegisteredClass>();
+
+        // Assert
+        service.Should().BeNull();
+    }
+
     [Fact]
     public void AddScoped_WithInterface_RegistersCorrectly()
     {
         //Arrange
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         //Act
@@ -30,7 +47,7 @@ public void AddScoped_RegistersCorrectly()
     {
         // Arrange
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         // Act
@@ -42,12 +59,42 @@ public void AddScoped_RegistersCorrectly()
         service.Should().NotBeNull().And.BeOfType<SimpleScopedClass>();
         serviceDescriptor.Lifetime.Should().Be(ServiceLifetime.Scoped);
     }
+
+
+    [Fact]
+    public void AddKeyedScoped_WithMultipleKeys_RegistersCorrectly()
+    {
+        // Arrange
+        var services = new ServiceCollection();
+        services.AddAutowiringForAssembly(_testAssembly).ForKeyedServices().Register();
+        var serviceProvider = services.BuildServiceProvider();
+
+        // Act and Assert for the first key
+        using var scope1 = serviceProvider.CreateScope();
+        var service1 = scope1.ServiceProvider.GetKeyedService<IKeyedService>("myKey");
+        service1.Should().NotBeNull().And.BeOfType<KeyedService>();
+
+        // Act and Assert for the second key
+        using var scope2 = serviceProvider.CreateScope();
+        var service2 = scope2.ServiceProvider.GetKeyedService<IKeyedService>("mySecondKey");
+        service2.Should().NotBeNull().And.BeOfType<SecondKeyedService>();
+    }
 }
 
+public class NonRegisteredClass { }
+
 [AddScoped]
 public class SimpleScopedClass { }
 
 public interface IScopedInterface { }
 
 [AddScoped(typeof(IScopedInterface))]
 public class ScopedWithInterface : IScopedInterface { }
+
+[AddKeyedScoped("myKey", typeof(IKeyedService))]
+public class KeyedService : IKeyedService { }
+
+[AddKeyedScoped("mySecondKey", typeof(IKeyedService))]
+public class SecondKeyedService : IKeyedService { }
+
+public interface IKeyedService { }
diff --git a/src/Bindicate.Tests/Singleton/AddSingletonAttributeTests.cs b/src/Bindicate.Tests/Singleton/AddSingletonAttributeTests.cs
@@ -1,18 +1,17 @@
 using Bindicate.Attributes;
-using Bindicate.Tests.ScopedTests;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Bindicate.Tests.Singleton;
 
 public class AddSingletonAttributeTests
 {
-    private readonly Assembly _testAssembly = typeof(AddScopedAttributeTests).Assembly;
+    private readonly Assembly _testAssembly = typeof(AddSingletonAttributeTests).Assembly;
 
     [Fact]
     public void AddSingleton_AlwaysReturnsSame()
     {
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         var instance1 = serviceProvider.GetService<ISingletonInterface>();
@@ -26,7 +25,7 @@ public void AddSingleton_WithInterface_RegistersCorrectly()
     {
         // Arrange
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         // Act
@@ -44,7 +43,7 @@ public void AddSingleton_RegistersCorrectly()
     {
         // Arrange
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         // Act

diff --git a/src/Bindicate.Tests/Transient/AddTransientAttributeTests.cs b/src/Bindicate.Tests/Transient/AddTransientAttributeTests.cs
@@ -1,18 +1,17 @@
 using Bindicate.Attributes;
-using Bindicate.Tests.ScopedTests;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Bindicate.Tests.Transient;
 
 public class AddTransientAttributeTests
 {
-    private readonly Assembly _testAssembly = typeof(AddScopedAttributeTests).Assembly;
+    private readonly Assembly _testAssembly = typeof(AddTransientAttributeTests).Assembly;
 
     [Fact]
     public void AddTransient_AlwaysReturnsNewInstance()
     {
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         var instance1 = serviceProvider.GetService<ITransientInterface>();
@@ -26,7 +25,7 @@ public void AddTransient_WithInterface_RegistersCorrectly()
     {
         // Arrange
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         // Act
@@ -44,7 +43,7 @@ public void AddSingleton_RegistersCorrectly()
     {
         // Arrange
         var services = new ServiceCollection();
-        services.AddAutowiringForAssembly(_testAssembly);
+        services.AddAutowiringForAssembly(_testAssembly).Register();
         var serviceProvider = services.BuildServiceProvider();
 
         // Act

diff --git a/src/Bindicate/Attributes/BaseKeyedServiceAttribute.cs b/src/Bindicate/Attributes/BaseKeyedServiceAttribute.cs
@@ -0,0 +1,23 @@
+namespace Bindicate.Attributes;
+
+[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
+public abstract class BaseKeyedServiceAttribute : Attribute
+{
+    public Type ServiceType { get; protected set; }
+    public object Key { get; protected set; }  // Added key property
+
+    public abstract Lifetime.Lifetime Lifetime { get; }
+
+    // Constructor for class-only registration without a key
+    protected BaseKeyedServiceAttribute()
+    {
+        ServiceType = null;
+    }
+
+    // Constructor for explicit interface registration with a key
+    protected BaseKeyedServiceAttribute(object key, Type serviceType = null)
+    {
+        Key = key;
+        ServiceType = serviceType;
+    }
+}
diff --git a/src/Bindicate/Attributes/Scoped/AddKeyedScopeAttribute.cs b/src/Bindicate/Attributes/Scoped/AddKeyedScopeAttribute.cs
@@ -0,0 +1,15 @@
+namespace Bindicate.Attributes.Scoped;
+
+/// <summary>
+/// Specifies that a service should be registered with the dependency injection container with a specified key.
+/// </summary>
+public class AddKeyedScopedAttribute : BaseKeyedServiceAttribute
+{
+    public AddKeyedScopedAttribute(object key, Type serviceType)
+        : base(key, serviceType)
+    {
+    }
+
+    public override Lifetime.Lifetime Lifetime => Bindicate.Lifetime.Lifetime.Scoped;
+
+}
diff --git a/src/Bindicate/Attributes/Singleton/AddKeyedSingletonAttribute.cs b/src/Bindicate/Attributes/Singleton/AddKeyedSingletonAttribute.cs
@@ -0,0 +1,14 @@
+namespace Bindicate.Attributes.Singleton;
+
+/// <summary>
+/// Specifies that a service should be registered with the dependency injection container with a specified key.
+/// </summary>
+public class AddKeyedSingletonAttribute : BaseKeyedServiceAttribute
+{
+    public AddKeyedSingletonAttribute(object key, Type serviceType)
+        : base(key, serviceType)
+    {
+    }
+
+    public override Lifetime.Lifetime Lifetime => Bindicate.Lifetime.Lifetime.Singleton;
+}
diff --git a/src/Bindicate/Attributes/Transient/AddKeyedTransientAttribute.cs b/src/Bindicate/Attributes/Transient/AddKeyedTransientAttribute.cs
@@ -0,0 +1,14 @@
+namespace Bindicate.Attributes.Transient;
+
+/// <summary>
+/// Specifies that a service should be registered with the dependency injection container with a specified key.
+/// </summary>
+public class AddKeyedTransientAttribute : BaseKeyedServiceAttribute
+{
+    public AddKeyedTransientAttribute(object key, Type serviceType)
+        : base(key, serviceType)
+    {
+    }
+
+    public override Lifetime.Lifetime Lifetime => Bindicate.Lifetime.Lifetime.Transient;
+}
diff --git a/src/Bindicate/Bindicate.csproj b/src/Bindicate/Bindicate.csproj
@@ -13,7 +13,7 @@
     <PackageTags>di, ioc, service, collection, extensions, attribute</PackageTags>
     <PackageReleaseNotes>Add support for IOptions</PackageReleaseNotes>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
-    <Version>1.3</Version>
+    <Version>1.5</Version>
   </PropertyGroup>
 
   <ItemGroup>
@@ -28,9 +28,9 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
   </ItemGroup>
 
 </Project>