fix:ICacheClient、IDistributedCacheClient、IMultilevelCacheClient object can't release (#492)

* fix:ICacheClient、IDistributedCacheClient、IMultilevelCacheClient object can't release

* style:change cache unit test method

* feat: IDistributedCacheClientFactory.Create a object instance to support being released

* style:rename IDistributedCacheClientDisposeWrapper to IManualDistributedCacheClient

Author: MapleWithoutWords

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/CacheClientBase.cs

@@ -1,4 +1,4 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
@@ -7,7 +7,6 @@ public abstract class CacheClientBase : ICacheClient
 {
     public abstract IEnumerable<T?> GetList<T>(params string[] keys);
 
-
     public abstract Task<IEnumerable<T?>> GetListAsync<T>(params string[] keys);
 
     public virtual void Set<T>(string key, T value, DateTimeOffset? absoluteExpiration, Action<CacheOptions>? action = null)

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Default/DistributedCacheClientFactoryBase.cs

@@ -1,16 +1,16 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public class DistributedCacheClientFactoryBase : CacheClientFactoryBase<IDistributedCacheClient>, IDistributedCacheClientFactory
+public class DistributedCacheClientFactoryBase : CacheClientFactoryBase<IManualDistributedCacheClient>, IDistributedCacheClientFactory
 {
     protected override string DefaultServiceNotFoundMessage
         => "Default DistributedCache not found, you need to add it, like services.AddStackExchangeRedisCache()";
 
     protected override string SpecifyServiceNotFoundMessage => "Please make sure you have used [{0}] DistributedCache, it was not found";
 
-    protected override MasaFactoryOptions<CacheRelationOptions<IDistributedCacheClient>> FactoryOptions => _optionsMonitor.CurrentValue;
+    protected override MasaFactoryOptions<CacheRelationOptions<IManualDistributedCacheClient>> FactoryOptions => _optionsMonitor.CurrentValue;
 
     private readonly IOptionsMonitor<DistributedCacheFactoryOptions> _optionsMonitor;
 

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Default/MultilevelCacheClientFactoryBase.cs

@@ -1,16 +1,16 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public class MultilevelCacheClientFactoryBase : CacheClientFactoryBase<IMultilevelCacheClient>, IMultilevelCacheClientFactory
+public class MultilevelCacheClientFactoryBase : CacheClientFactoryBase<IManualMultilevelCacheClient>, IMultilevelCacheClientFactory
 {
     protected override string DefaultServiceNotFoundMessage
         => "Default MultilevelCache not found, you need to add it, like services.AddMultilevelCache()";
 
     protected override string SpecifyServiceNotFoundMessage => "Please make sure you have used [{0}] MultilevelCache, it was not found";
 
-    protected override MasaFactoryOptions<CacheRelationOptions<IMultilevelCacheClient>> FactoryOptions => _optionsMonitor.CurrentValue;
+    protected override MasaFactoryOptions<CacheRelationOptions<IManualMultilevelCacheClient>> FactoryOptions => _optionsMonitor.CurrentValue;
 
     private readonly IOptionsMonitor<MultilevelCacheFactoryOptions> _optionsMonitor;
 

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/DistributedCacheClientBase.cs

@@ -1,9 +1,9 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public abstract class DistributedCacheClientBase : CacheClientBase, IDistributedCacheClient
+public abstract class DistributedCacheClientBase : CacheClientBase, IManualDistributedCacheClient
 {
     public abstract T? Get<T>(string key, Action<CacheOptions>? action = null);
 
@@ -129,4 +129,14 @@ public abstract Task<long> KeyExpireAsync<T>(
         IEnumerable<string> keys,
         CacheEntryOptions? options = null,
         Action<CacheOptions>? action = null);
+
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
+
+    protected virtual void Dispose(bool disposing)
+    {
+    }
 }

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Extensions/ServiceCollectionExtensions.Core.cs

@@ -16,6 +16,8 @@ public static IServiceCollection TryAddDistributedCacheCore(IServiceCollection s
         services.TryAddSingleton<IDistributedCacheClientFactory, DistributedCacheClientFactoryBase>();
         services.TryAddSingleton(serviceProvider
             => serviceProvider.GetRequiredService<IDistributedCacheClientFactory>().Create());
+        services.TryAddSingleton(typeof(IDistributedCacheClient), serviceProvider
+            => serviceProvider.GetRequiredService<IManualDistributedCacheClient>());
 
         services.TryAddSingleton<ITypeAliasFactory, DefaultTypeAliasFactory>();
         services.Configure<TypeAliasFactoryOptions>(options => options.TryAdd(name));
@@ -27,6 +29,8 @@ public static IServiceCollection TryAddMultilevelCacheCore(IServiceCollection se
         services.TryAddSingleton<IMultilevelCacheClientFactory, MultilevelCacheClientFactoryBase>();
         services.TryAddSingleton(serviceProvider
             => serviceProvider.GetRequiredService<IMultilevelCacheClientFactory>().Create());
+        services.TryAddSingleton(typeof(IMultilevelCacheClient), serviceProvider
+            => serviceProvider.GetRequiredService<IManualMultilevelCacheClient>());
 
         services.TryAddSingleton<ITypeAliasFactory, DefaultTypeAliasFactory>();
         services.Configure<TypeAliasFactoryOptions>(options => options.TryAdd(name));

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/ICacheClient.cs

@@ -1,11 +1,11 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
 public interface ICacheClient
 {
-   IEnumerable<T?> GetList<T>(params string[] keys);
+    IEnumerable<T?> GetList<T>(params string[] keys);
 
     Task<IEnumerable<T?>> GetListAsync<T>(params string[] keys);
 

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/IDistributedCacheClientFactory.cs

@@ -1,9 +1,9 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public interface IDistributedCacheClientFactory : ICacheClientFactory<IDistributedCacheClient>
+public interface IDistributedCacheClientFactory : ICacheClientFactory<IManualDistributedCacheClient>
 {
 
 }

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/IManualDistributedCacheClient.cs

@@ -0,0 +1,8 @@
+// Copyright (c) MASA Stack All rights reserved.
+// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+
+namespace Masa.BuildingBlocks.Caching;
+
+public interface IManualDistributedCacheClient : IDistributedCacheClient, IDisposable
+{
+}

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/IManualMultilevelCacheClient.cs

@@ -0,0 +1,8 @@
+// Copyright (c) MASA Stack All rights reserved.
+// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+
+namespace Masa.BuildingBlocks.Caching;
+
+public interface IManualMultilevelCacheClient : IMultilevelCacheClient, IDisposable
+{
+}

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/IMultilevelCacheClientFactory.cs

@@ -1,9 +1,9 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public interface IMultilevelCacheClientFactory: ICacheClientFactory<IMultilevelCacheClient>
+public interface IMultilevelCacheClientFactory: ICacheClientFactory<IManualMultilevelCacheClient>
 {
 
 }

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/MultilevelCacheClientBase.cs

@@ -1,9 +1,9 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public abstract class MultilevelCacheClientBase : CacheClientBase, IMultilevelCacheClient
+public abstract class MultilevelCacheClientBase : CacheClientBase, IManualMultilevelCacheClient
 {
     /// <summary>
     /// Get cache
@@ -173,4 +173,14 @@ public abstract Task SetListAsync<T>(
         Dictionary<string, T?> keyValues,
         CombinedCacheEntryOptions? options,
         Action<CacheOptions>? action = null);
+
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
+
+    protected virtual void Dispose(bool disposing)
+    {
+    }
 }

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Options/CacheRelationOptions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Options/DistributedCacheFactoryOptions.cs

@@ -1,9 +1,9 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public class DistributedCacheFactoryOptions : MasaFactoryOptions<CacheRelationOptions<IDistributedCacheClient>>
+public class DistributedCacheFactoryOptions : MasaFactoryOptions<CacheRelationOptions<IManualDistributedCacheClient>>
 {
 
 }

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Options/MultilevelCacheFactoryOptions.cs

@@ -1,9 +1,9 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.BuildingBlocks.Caching;
 
-public class MultilevelCacheFactoryOptions: MasaFactoryOptions<CacheRelationOptions<IMultilevelCacheClient>>
+public class MultilevelCacheFactoryOptions: MasaFactoryOptions<CacheRelationOptions<IManualMultilevelCacheClient>>
 {
 
 }

src/Contrib/Caching/Distributed/Masa.Contrib.Caching.Distributed.StackExchangeRedis/Extensions/DistributedCacheOptionsExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright (c) MASA Stack All rights reserved.
+// 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
@@ -78,7 +78,7 @@ private static DistributedCacheOptions UseStackExchangeRedisCache(
             if (options.Options.Any(opt => opt.Name == distributedOptions.Name))
                 return;
 
-            var cacheRelationOptions = new CacheRelationOptions<IDistributedCacheClient>(distributedOptions.Name, serviceProvider =>
+            var cacheRelationOptions = new CacheRelationOptions<IManualDistributedCacheClient>(distributedOptions.Name, serviceProvider =>
             {
                 var distributedCacheClient = new RedisCacheClient(
                     serviceProvider.GetRequiredService<IOptionsMonitor<RedisConfigurationOptions>>(),
@@ -123,7 +123,7 @@ internal static void UseStackExchangeRedisCache(
             if (options.Options.Any(opt => opt.Name == name))
                 return;
 
-            var cacheRelationOptions = new CacheRelationOptions<IDistributedCacheClient>(name, serviceProvider =>
+            var cacheRelationOptions = new CacheRelationOptions<IManualDistributedCacheClient>(name, serviceProvider =>
             {
                 var distributedCacheClient = new RedisCacheClient(
                     redisConfigurationOptions,

src/Contrib/Caching/Distributed/Masa.Contrib.Caching.Distributed.StackExchangeRedis/RedisCacheClient.cs

@@ -1,4 +1,4 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.Contrib.Caching.Distributed.StackExchangeRedis;
@@ -17,7 +17,7 @@ public RedisCacheClient(IOptionsMonitor<RedisConfigurationOptions> redisConfigur
         {
             if (optionName == name)
             {
-                RefreshRedisConfigurationOptions(option);
+                InitializeRedisConfigurationOptions(option);
                 GlobalCacheOptions = option.GlobalCacheOptions;
             }
         });
@@ -576,20 +576,6 @@ public override Task<long> KeyExpireAsync<T>(
 
     #region Private methods
 
-    private void RefreshRedisConfigurationOptions(RedisConfigurationOptions redisConfigurationOptions)
-    {
-        IConnectionMultiplexer? connection = ConnectionMultiplexer.Connect(redisConfigurationOptions);
-        Db = connection.GetDatabase();
-        Subscriber = connection.GetSubscriber();
-
-        GlobalCacheEntryOptions = new CacheEntryOptions
-        {
-            AbsoluteExpiration = redisConfigurationOptions.AbsoluteExpiration,
-            AbsoluteExpirationRelativeToNow = redisConfigurationOptions.AbsoluteExpirationRelativeToNow,
-            SlidingExpiration = redisConfigurationOptions.SlidingExpiration
-        };
-    }
-
     private RedisValue[] GetRedisValues(CacheEntryOptions? options, Func<RedisValue[]>? func = null)
     {
         var creationTime = DateTimeOffset.UtcNow;
@@ -696,5 +682,4 @@ private string FormatKeyPattern<T>(string keyPattern,
     }
 
     #endregion
-
 }

src/Contrib/Caching/Distributed/Masa.Contrib.Caching.Distributed.StackExchangeRedis/RedisCacheClientBase.cs

@@ -1,4 +1,4 @@
-// Copyright (c) MASA Stack All rights reserved.
+// Copyright (c) MASA Stack All rights reserved.
 // Licensed under the MIT License. See LICENSE.txt in the project root for license information.
 
 namespace Masa.Contrib.Caching.Distributed.StackExchangeRedis;
@@ -8,6 +8,7 @@ public abstract class RedisCacheClientBase : DistributedCacheClientBase
     protected static readonly Guid UniquelyIdentifies = Guid.NewGuid();
     protected ISubscriber Subscriber;
     protected IDatabase Db;
+    protected IConnectionMultiplexer? Connection;
     protected readonly JsonSerializerOptions GlobalJsonSerializerOptions;
     protected CacheEntryOptions GlobalCacheEntryOptions;
     protected CacheOptions GlobalCacheOptions;
@@ -17,17 +18,24 @@ protected RedisCacheClientBase(RedisConfigurationOptions redisConfigurationOptio
     {
         GlobalCacheOptions = redisConfigurationOptions.GlobalCacheOptions;
         var redisConfiguration = GetRedisConfigurationOptions(redisConfigurationOptions);
-        IConnectionMultiplexer? connection = ConnectionMultiplexer.Connect(redisConfiguration);
-        Db = connection.GetDatabase();
-        Subscriber = connection.GetSubscriber();
+        InitializeRedisConfigurationOptions(redisConfiguration);
 
         GlobalJsonSerializerOptions = jsonSerializerOptions ?? new JsonSerializerOptions().EnableDynamicTypes();
+    }
+
+    protected void InitializeRedisConfigurationOptions(RedisConfigurationOptions redisConfigurationOptions)
+    {
+        Dispose();
+
+        Connection = ConnectionMultiplexer.Connect(redisConfigurationOptions);
+        Db = Connection.GetDatabase();
+        Subscriber = Connection.GetSubscriber();
 
         GlobalCacheEntryOptions = new CacheEntryOptions
         {
-            AbsoluteExpiration = redisConfiguration.AbsoluteExpiration,
-            AbsoluteExpirationRelativeToNow = redisConfiguration.AbsoluteExpirationRelativeToNow,
-            SlidingExpiration = redisConfiguration.SlidingExpiration
+            AbsoluteExpiration = redisConfigurationOptions.AbsoluteExpiration,
+            AbsoluteExpirationRelativeToNow = redisConfigurationOptions.AbsoluteExpirationRelativeToNow,
+            SlidingExpiration = redisConfigurationOptions.SlidingExpiration
         };
     }
 
@@ -236,4 +244,10 @@ private static DataCacheModel MapMetadataByAutomatic(string key, RedisValue[] re
         }
         return new DataCacheModel(key, absoluteExpiration, slidingExpiration, data);
     }
+
+    protected override void Dispose(bool disposing)
+    {
+        Connection?.Dispose();
+        base.Dispose(disposing);
+    }
 }