refactor: Refactoring IdGenerator (#574)

* refactor: Refactoring IdGenerator

* chore: Dealing with Code Smells

* rename: TestGetDistibutedLockFaieldAsync -> TestGetDistributedLockFailedAsync

* test: Update UnitTest

Author: zhenlei520

src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/IdGenerator/DefaultIdGeneratorFactory.cs

@@ -1,48 +1,25 @@
 // Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
+// ReSharper disable once CheckNamespace
+
 namespace Masa.BuildingBlocks.Data;
 
-public class DefaultIdGeneratorFactory : MasaFactoryBase<IIdGenerator, IdGeneratorRelationOptions>,
-    IIdGeneratorFactory
+public class DefaultIdGeneratorFactory : IIdGeneratorFactory
 {
-    private IGuidGenerator? _guidGenerator;
-    private ISequentialGuidGenerator? _sequentialGuidGenerator;
-    private ISnowflakeGenerator? _snowflakeGenerator;
-
-    public IGuidGenerator GuidGenerator => _guidGenerator ??=
-        ServiceProvider.GetService<IGuidGenerator>() ?? throw new Exception($"Unsupported {nameof(GuidGenerator)}");
-
-    public ISequentialGuidGenerator SequentialGuidGenerator => _sequentialGuidGenerator ??=
-        ServiceProvider.GetService<ISequentialGuidGenerator>() ?? throw new Exception($"Unsupported {nameof(SequentialGuidGenerator)}");
-
-    public ISnowflakeGenerator SnowflakeGenerator => _snowflakeGenerator ??=
-        ServiceProvider.GetService<ISnowflakeGenerator>() ?? throw new Exception($"Unsupported {nameof(SnowflakeGenerator)}");
-
-    protected override string DefaultServiceNotFoundMessage { get; } =
-        "No default IdGenerator found, you may need service.AddSimpleGuidGenerator()";
-
-    protected override string SpecifyServiceNotFoundMessage { get; } =
-        "Please make sure you have used [{0}] IdGenerator, it was not found";
+    public IGuidGenerator? GuidGenerator { get; }
 
-    protected override MasaFactoryOptions<IdGeneratorRelationOptions> FactoryOptions => _options.CurrentValue;
+    public ISequentialGuidGenerator? SequentialGuidGenerator { get; }
 
-    private readonly IOptionsMonitor<IdGeneratorFactoryOptions> _options;
-
-    public DefaultIdGeneratorFactory(IServiceProvider serviceProvider) : base(serviceProvider)
-    {
-        _options = serviceProvider.GetRequiredService<IOptionsMonitor<IdGeneratorFactoryOptions>>();
-    }
-
-    public IIdGenerator<TOut> Create<TOut>() where TOut : notnull
-    {
-        var idGenerator = Create();
-        return idGenerator as IIdGenerator<TOut> ?? throw new Exception($"Unsupported {nameof(IIdGenerator<TOut>)}");
-    }
+    public ISnowflakeGenerator? SnowflakeGenerator { get; }
 
-    public IIdGenerator<TOut> Create<TOut>(string name) where TOut : notnull
+    public DefaultIdGeneratorFactory(
+        IGuidGenerator? guidGenerator = null,
+        ISequentialGuidGenerator? sequentialGuidGenerator = null,
+        ISnowflakeGenerator? snowflakeGenerator = null)
     {
-        var idGenerator = Create(name);
-        return idGenerator as IIdGenerator<TOut> ?? throw new Exception($"Unsupported {nameof(IIdGenerator<TOut>)}");
+        GuidGenerator = guidGenerator;
+        SequentialGuidGenerator = sequentialGuidGenerator;
+        SnowflakeGenerator = snowflakeGenerator;
     }
 }

src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/IdGenerator/Extensions/ServiceCollectionExtensions.cs

@@ -1,14 +1,23 @@
 // Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
+[assembly: InternalsVisibleTo("Masa.Contrib.Data.IdGenerator.NormalGuid")]
+[assembly: InternalsVisibleTo("Masa.Contrib.Data.IdGenerator.SequentialGuid")]
+[assembly: InternalsVisibleTo("Masa.Contrib.Data.IdGenerator.Snowflake")]
+
 // ReSharper disable once CheckNamespace
+
 namespace Microsoft.Extensions.DependencyInjection;
 
 public static partial class ServiceCollectionExtensions
 {
-    public static IServiceCollection AddIdGeneratorCore(this IServiceCollection services)
+    public static IServiceCollection AddIdGenerator(this IServiceCollection services, Action<IdGeneratorOptions> configure)
     {
-        services.AddSingleton<IIdGeneratorFactory, DefaultIdGeneratorFactory>();
+        services.TryAddSingleton<IIdGeneratorFactory, DefaultIdGeneratorFactory>();
+
+        var idGeneratorOptions = new IdGeneratorOptions(services);
+        configure.Invoke(idGeneratorOptions);
+        MasaApp.TrySetServiceCollection(services);
         return services;
     }
 }

src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/IdGenerator/IIdGeneratorFactory.cs

@@ -3,15 +3,11 @@
 
 namespace Masa.BuildingBlocks.Data;
 
-public interface IIdGeneratorFactory : IMasaFactory<IIdGenerator>
+public interface IIdGeneratorFactory
 {
-    IGuidGenerator GuidGenerator { get; }
+    IGuidGenerator? GuidGenerator { get; }
 
-    ISequentialGuidGenerator SequentialGuidGenerator { get; }
+    ISequentialGuidGenerator? SequentialGuidGenerator { get; }
 
-    ISnowflakeGenerator SnowflakeGenerator { get; }
-
-    IIdGenerator<TOut> Create<TOut>() where TOut : notnull;
-
-    IIdGenerator<TOut> Create<TOut>(string name) where TOut : notnull;
+    ISnowflakeGenerator? SnowflakeGenerator { get; }
 }

src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/IdGenerator/Options/IdGeneratorRelationOptions.cs src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/IdGenerator/IdGeneratorOptions.cs

@@ -3,10 +3,12 @@
 
 namespace Masa.BuildingBlocks.Data;
 
-public class IdGeneratorRelationOptions : MasaRelationOptions<IIdGenerator>
+public class IdGeneratorOptions
 {
-    public IdGeneratorRelationOptions(string name)
-        : base(name)
+    public IServiceCollection Services { get; }
+
+    public IdGeneratorOptions(IServiceCollection services)
     {
+        Services = services;
     }
 }

src/BuildingBlocks/Data/Masa.BuildingBlocks.Data/IdGenerator/Options/IdGeneratorFactoryOptions.cs

@@ -7,7 +7,7 @@ namespace Masa.Contrib.Data.IdGenerator.NormalGuid.Tests;
 public class NormalGuidGeneratorTest
 {
     [TestMethod]
-    public void TestNormarlGuidReturnIdGeneratorIsNotNull()
+    public void TestNormalGuidReturnIdGeneratorIsNotNull()
     {
         var services = new ServiceCollection();
         services.AddSimpleGuidGenerator();
@@ -17,55 +17,23 @@ public void TestNormarlGuidReturnIdGeneratorIsNotNull()
         Assert.IsTrue(idGenerator.GetType() == typeof(NormalGuidGenerator));
 
         Assert.IsNotNull(serviceProvider.GetService<IIdGenerator>());
-    }
-
-    [TestMethod]
-    public void TestNormarlGuidByMasaAppReturnIdGeneratorIsNotNull()
-    {
-        var services = new ServiceCollection();
-        services.TestAddSimpleGuidGenerator();
-        var idGenerator = MasaApp.GetService<IIdGenerator<Guid>>();
-        Assert.IsNotNull(idGenerator);
-        Assert.IsTrue(idGenerator.GetType() == typeof(NormalGuidGenerator));
 
-        Assert.IsNotNull(MasaApp.GetService<IIdGenerator>());
+        Assert.IsTrue(IdGeneratorFactory.GuidGenerator.GetType() == typeof(NormalGuidGenerator));
     }
 
     [TestMethod]
-    public void TestNormarlGuidByCustomNameReturnIdGeneratorIsNotNull()
+    public void TestNormalGuidByCustomNameReturnIdGeneratorIsNotNull()
     {
         var services = new ServiceCollection();
-        services.TestAddSimpleGuidGenerator("normal");
-        var idGeneratorFactory = MasaApp.GetService<IIdGeneratorFactory>();
+        services.AddSimpleGuidGenerator();
+        var serviceProvider = services.BuildServiceProvider();
+        var idGeneratorFactory = serviceProvider.GetService<IIdGeneratorFactory>();
         Assert.IsNotNull(idGeneratorFactory);
 
-        var idGenerator = idGeneratorFactory.Create("normal");
+        var idGenerator = idGeneratorFactory.GuidGenerator;
         Assert.IsNotNull(idGenerator);
         Assert.IsTrue(idGenerator.GetType() == typeof(NormalGuidGenerator));
-    }
-
-    [TestMethod]
-    public void TestNormarlGuidByNameIsNullReturnArgumentNullException()
-    {
-        var services = new ServiceCollection();
-        Assert.ThrowsException<ArgumentNullException>(() => services.TestAddSimpleGuidGenerator(null!));
-    }
-
-    [TestMethod]
-    public void TestAddMultiSequentialGuidReturnIdGeneratorCountIs1()
-    {
-        var services = new ServiceCollection();
-        services.TestAddSimpleGuidGenerator().TestAddSimpleGuidGenerator();
-
-        Assert.IsTrue(services.Count(d => d.ServiceType == typeof(IIdGenerator<Guid>)) == 1);
-    }
-
-    [TestMethod]
-    public void TestNewId()
-    {
-        var services = new ServiceCollection();
-        services.TestAddSimpleGuidGenerator();
 
-        Assert.AreNotEqual(Guid.Empty, MasaApp.GetRequiredService<IIdGenerator<Guid>>().NewId());
+        Assert.IsTrue(IdGeneratorFactory.GuidGenerator.GetType() == typeof(NormalGuidGenerator));
     }
 }

src/Contrib/Data/IdGenerator/NormalGuid/Masa.Contrib.Data.IdGenerator.NormalGuid.Tests/NormalGuidGeneratorTest.cs

@@ -0,0 +1,26 @@
+// Copyright (c) MASA Stack All rights reserved.
+// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+
+// ReSharper disable once CheckNamespace
+
+namespace Masa.BuildingBlocks.Data;
+
+public static class IdGeneratorOptionsExtensions
+{
+    public static void UseSimpleGuidGenerator(this IdGeneratorOptions options)
+    {
+        if (options.Services.Any(service => service.ImplementationType == typeof(SimpleGuidGeneratorProvider))) return;
+
+        options.Services.AddSingleton<SimpleGuidGeneratorProvider>();
+
+        options.Services.AddSingleton<IGuidGenerator, NormalGuidGenerator>();
+        options.Services.TryAddSingleton<IIdGenerator<Guid>>(serviceProvider => serviceProvider.GetRequiredService<IGuidGenerator>());
+        options.Services.TryAddSingleton<IIdGenerator>(serviceProvider => serviceProvider.GetRequiredService<IGuidGenerator>());
+    }
+
+    #pragma warning disable S2094
+    private sealed class SimpleGuidGeneratorProvider
+    {
+    }
+    #pragma warning restore S2094
+}

src/Contrib/Data/IdGenerator/NormalGuid/Masa.Contrib.Data.IdGenerator.NormalGuid/Extensions/IdGeneratorOptionsExtensions.cs

@@ -0,0 +1,12 @@
+// Copyright (c) MASA Stack All rights reserved.
+// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+
+// ReSharper disable once CheckNamespace
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+public static class ServiceCollectionExtensions
+{
+    public static IServiceCollection AddSimpleGuidGenerator(this IServiceCollection services)
+        => services.AddIdGenerator(options => options.UseSimpleGuidGenerator());
+}

src/Contrib/Data/IdGenerator/NormalGuid/Masa.Contrib.Data.IdGenerator.NormalGuid/Extensions/ServiceCollectionExtensions.cs

@@ -3,4 +3,6 @@
 
 global using Masa.BuildingBlocks.Data;
 global using Masa.Contrib.Data.IdGenerator.NormalGuid;
+global using Microsoft.Extensions.DependencyInjection;
+global using Microsoft.Extensions.DependencyInjection.Extensions;
 global using System.Runtime.CompilerServices;