refactor: RefactoringCaching

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

@@ -0,0 +1,55 @@
+// 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 CacheClientBase : ICacheClient
+{
+    public abstract T? Get<T>(string key);
+
+    public abstract Task<T?> GetAsync<T>(string key);
+
+    public IEnumerable<T?> GetList<T>(params string[] keys)
+        => GetList<T>(GetKeys(keys));
+
+    public abstract IEnumerable<T?> GetList<T>(IEnumerable<string> keys);
+
+    public Task<IEnumerable<T?>> GetListAsync<T>(params string[] keys)
+        => GetListAsync<T>(GetKeys(keys));
+
+    public abstract Task<IEnumerable<T?>> GetListAsync<T>(IEnumerable<string> keys);
+
+    public virtual void Set<T>(string key, T value, DateTimeOffset absoluteExpiration)
+        => Set(key, value, new CacheEntryOptions(absoluteExpiration));
+
+    public virtual void Set<T>(string key, T value, TimeSpan absoluteExpirationRelativeToNow)
+        => Set(key, value, new CacheEntryOptions(absoluteExpirationRelativeToNow));
+
+    public abstract void Set<T>(string key, T value, CacheEntryOptions? options = null);
+
+    public virtual Task SetAsync<T>(string key, T value, DateTimeOffset absoluteExpiration)
+        => SetAsync(key, value, new CacheEntryOptions(absoluteExpiration));
+
+    public virtual Task SetAsync<T>(string key, T value, TimeSpan absoluteExpirationRelativeToNow)
+        => SetAsync(key, value, new CacheEntryOptions(absoluteExpirationRelativeToNow));
+
+    public abstract Task SetAsync<T>(string key, T value, CacheEntryOptions? options = null);
+
+    public virtual void SetList<T>(Dictionary<string, T?> keyValues, DateTimeOffset absoluteExpiration)
+        => SetList(keyValues, new CacheEntryOptions(absoluteExpiration));
+
+    public virtual void SetList<T>(Dictionary<string, T?> keyValues, TimeSpan absoluteExpirationRelativeToNow)
+        => SetList(keyValues, new CacheEntryOptions(absoluteExpirationRelativeToNow));
+
+    public abstract void SetList<T>(Dictionary<string, T?> keyValues, CacheEntryOptions? options = null);
+
+    public virtual Task SetListAsync<T>(Dictionary<string, T?> keyValues, DateTimeOffset absoluteExpiration)
+        => SetListAsync(keyValues, new CacheEntryOptions(absoluteExpiration));
+
+    public virtual Task SetListAsync<T>(Dictionary<string, T?> keyValues, TimeSpan absoluteExpirationRelativeToNow)
+        => SetListAsync(keyValues, new CacheEntryOptions(absoluteExpirationRelativeToNow));
+
+    public abstract Task SetListAsync<T>(Dictionary<string, T?> keyValues, CacheEntryOptions? options = null);
+
+    protected static IEnumerable<string> GetKeys(params string[] keys) => keys;
+}

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/CacheEntry.cs

@@ -0,0 +1,20 @@
+// 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 CacheEntry<T> : CacheEntryOptions<T>
+{
+    public T Value { get; }
+
+    public CacheEntry(T value)
+    {
+        Value = value;
+    }
+
+    public CacheEntry(T value, DateTimeOffset absoluteExpiration) : this(value)
+        => AbsoluteExpiration = absoluteExpiration;
+
+    public CacheEntry(T value, TimeSpan absoluteExpirationRelativeToNow) : this(value)
+        => AbsoluteExpirationRelativeToNow = absoluteExpirationRelativeToNow;
+}

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/CombinedCacheEntry.cs

@@ -0,0 +1,11 @@
+// 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 CombinedCacheEntry<T>
+{
+    public CacheEntryOptions? MemoryCacheEntryOptions { get; set; }
+
+    public Func<CacheEntry<T>> DistributedCacheEntryFunc { get; set; }
+}

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Default/CacheClientFactoryBase.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.
+
+namespace Masa.BuildingBlocks.Caching;
+
+public abstract class CacheClientFactoryBase<TService> : MasaFactoryBase<TService, CacheRelationOptions<TService>>,
+    ICacheClientFactory<TService> where TService : class
+{
+    protected CacheClientFactoryBase(IServiceProvider serviceProvider) : base(serviceProvider)
+    {
+    }
+}

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

@@ -0,0 +1,21 @@
+// 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
+{
+    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;
+
+    private readonly IOptionsMonitor<DistributedCacheFactoryOptions> _optionsMonitor;
+
+    public DistributedCacheClientFactoryBase(IServiceProvider serviceProvider) : base(serviceProvider)
+    {
+        _optionsMonitor = serviceProvider.GetRequiredService<IOptionsMonitor<DistributedCacheFactoryOptions>>();
+    }
+}

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

@@ -0,0 +1,21 @@
+// 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
+{
+    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;
+
+    private readonly IOptionsMonitor<MultilevelCacheFactoryOptions> _optionsMonitor;
+
+    public MultilevelCacheClientFactoryBase(IServiceProvider serviceProvider) : base(serviceProvider)
+    {
+        _optionsMonitor = serviceProvider.GetRequiredService<IOptionsMonitor<MultilevelCacheFactoryOptions>>();
+    }
+}

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

@@ -0,0 +1,71 @@
+// 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 T? GetOrSet<T>(string key, Func<CacheEntry<T>> setter);
+
+    public abstract Task<T?> GetOrSetAsync<T>(string key, Func<CacheEntry<T>> setter);
+
+    public void Refresh(params string[] keys) => Refresh(GetKeys(keys));
+
+    public abstract void Refresh(IEnumerable<string> keys);
+
+    public Task RefreshAsync(params string[] keys) => RefreshAsync(GetKeys(keys));
+
+    public abstract Task RefreshAsync(IEnumerable<string> keys);
+
+    public virtual void Remove(params string[] keys) => Remove(GetKeys(keys));
+
+    public abstract void Remove(IEnumerable<string> keys);
+
+    public Task RemoveAsync(params string[] keys) => RemoveAsync(GetKeys(keys));
+
+    public abstract Task RemoveAsync(IEnumerable<string> keys);
+
+    public abstract bool Exists(string key);
+
+    public abstract Task<bool> ExistsAsync(string key);
+
+    public abstract IEnumerable<string> GetKeys(string keyPattern);
+
+    public abstract Task<IEnumerable<string>> GetKeysAsync(string keyPattern);
+
+    public abstract IEnumerable<KeyValuePair<string, T?>> GetByKeyPattern<T>(string keyPattern);
+
+    public abstract Task<IEnumerable<KeyValuePair<string, T?>>> GetByKeyPatternAsync<T>(string keyPattern);
+
+    public abstract void Publish(string channel, Action<PublishOptions> options);
+
+    public abstract Task PublishAsync(string channel, Action<PublishOptions> options);
+
+    public abstract void Subscribe<T>(string channel, Action<SubscribeOptions<T>> options);
+
+    public abstract Task SubscribeAsync<T>(string channel, Action<SubscribeOptions<T>> options);
+
+    public abstract Task<long> HashIncrementAsync(string key, long value = 1);
+
+    public abstract Task<long> HashDecrementAsync(string key, long value = 1, long defaultMinVal = 0);
+
+    public virtual bool KeyExpire(string key, TimeSpan absoluteExpirationRelativeToNow)
+        => KeyExpire(key, new CacheEntryOptions(absoluteExpirationRelativeToNow));
+
+    public virtual bool KeyExpire(string key, DateTimeOffset absoluteExpiration)
+        => KeyExpire(key, new CacheEntryOptions(absoluteExpiration));
+
+    public abstract bool KeyExpire(string key, CacheEntryOptions? options = null);
+
+    public abstract long KeyExpire(IEnumerable<string> keys, CacheEntryOptions? options = null);
+
+    public virtual Task<bool> KeyExpireAsync(string key, DateTimeOffset absoluteExpiration)
+        => KeyExpireAsync(key, new CacheEntryOptions(absoluteExpiration));
+
+    public virtual Task<bool> KeyExpireAsync(string key, TimeSpan absoluteExpirationRelativeToNow)
+        => KeyExpireAsync(key, new CacheEntryOptions(absoluteExpirationRelativeToNow));
+
+    public abstract Task<bool> KeyExpireAsync(string key, CacheEntryOptions? options = null);
+
+    public abstract Task<long> KeyExpireAsync(IEnumerable<string> keys, CacheEntryOptions? options = null);
+}

src/Utils/Caching/Masa.Utils.Caching.Core/Models/SubscribeKeyTypes.cs → src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Enumerations/SubscribeKeyType.cs

@@ -1,12 +1,12 @@
-// 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.Utils.Caching.Core.Models;
+namespace Masa.BuildingBlocks.Caching;
 
 /// <summary>
 /// The subscribe key type.
 /// </summary>
-public enum SubscribeKeyTypes
+public enum SubscribeKeyType
 {
     ValueTypeFullName = 1,
 

src/Utils/Caching/Masa.Utils.Caching.Core/Models/SubscribeOperation.cs → src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Enumerations/SubscribeOperation.cs

@@ -1,14 +1,10 @@
-// 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.Utils.Caching.Core.Models;
+namespace Masa.BuildingBlocks.Caching;
 
-/// <summary>
-/// The subscribe operation.
-/// </summary>
 public enum SubscribeOperation
 {
     Set = 1,
-
     Remove = 2
 }

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

@@ -0,0 +1,23 @@
+// Copyright (c) MASA Stack All rights reserved.
+// Licensed under the MIT License. See LICENSE.txt in the project root for license information.
+
+namespace Microsoft.Extensions.DependencyInjection;
+
+public static class ServiceCollectionExtensions
+{
+    public static IServiceCollection TryAddDistributedCacheCore(this IServiceCollection services)
+    {
+        services.TryAddSingleton<IDistributedCacheClientFactory, DistributedCacheClientFactoryBase>();
+        services.TryAddSingleton(serviceProvider
+            => serviceProvider.GetRequiredService<IDistributedCacheClientFactory>().Create());
+        return services;
+    }
+
+    public static IServiceCollection TryAddMultilevelCacheCore(this IServiceCollection services)
+    {
+        services.TryAddSingleton<IMultilevelCacheClientFactory, MultilevelCacheClientFactoryBase>();
+        services.TryAddSingleton(serviceProvider
+            => serviceProvider.GetRequiredService<IMultilevelCacheClientFactory>().Create());
+        return services;
+    }
+}

src/Utils/Caching/Masa.Utils.Caching.Core/Helpers/SubscribeHelper.cs → src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/Helper/SubscribeHelper.cs

@@ -1,11 +1,8 @@
-// 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.Utils.Caching.Core.Helpers;
+namespace Masa.BuildingBlocks.Caching;
 
-/// <summary>
-/// The subscribe helper.
-/// </summary>
 public static class SubscribeHelper
 {
     /// <summary>
@@ -39,16 +36,16 @@ public static string FormatMemoryCacheKey<T>(string key)
     /// <param name="type">The type.</param>
     /// <param name="prefix">The prefix.</param>
     /// <returns>A string.</returns>
-    public static string FormatSubscribeChannel<T>(string key, SubscribeKeyTypes type, string prefix = "")
+    public static string FormatSubscribeChannel<T>(string key, SubscribeKeyType type, string prefix = "")
     {
         var valueTypeFullName = typeof(T).FullName!;
         switch (type)
         {
-            case SubscribeKeyTypes.ValueTypeFullName:
+            case SubscribeKeyType.ValueTypeFullName:
                 return valueTypeFullName;
-            case SubscribeKeyTypes.ValueTypeFullNameAndKey:
+            case SubscribeKeyType.ValueTypeFullNameAndKey:
                 return $"[{valueTypeFullName}]{key}";
-            case SubscribeKeyTypes.SpecificPrefix:
+            case SubscribeKeyType.SpecificPrefix:
                 return $"{prefix}{key}";
             default:
                 throw new NotImplementedException();

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

@@ -0,0 +1,43 @@
+// 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
+{
+    T? Get<T>(string key);
+
+    Task<T?> GetAsync<T>(string key);
+
+    IEnumerable<T?> GetList<T>(params string[] keys);
+
+    IEnumerable<T?> GetList<T>(IEnumerable<string> keys);
+
+    Task<IEnumerable<T?>> GetListAsync<T>(params string[] keys);
+
+    Task<IEnumerable<T?>> GetListAsync<T>(IEnumerable<string> keys);
+
+    void Set<T>(string key, T value, DateTimeOffset absoluteExpiration);
+
+    void Set<T>(string key, T value, TimeSpan absoluteExpirationRelativeToNow);
+
+    void Set<T>(string key, T value, CacheEntryOptions? options = null);
+
+    Task SetAsync<T>(string key, T value, DateTimeOffset absoluteExpiration);
+
+    Task SetAsync<T>(string key, T value, TimeSpan absoluteExpirationRelativeToNow);
+
+    Task SetAsync<T>(string key, T value, CacheEntryOptions? options = null);
+
+    void SetList<T>(Dictionary<string, T?> keyValues, DateTimeOffset absoluteExpiration);
+
+    void SetList<T>(Dictionary<string, T?> keyValues, TimeSpan absoluteExpirationRelativeToNow);
+
+    void SetList<T>(Dictionary<string, T?> keyValues, CacheEntryOptions? options = null);
+
+    Task SetListAsync<T>(Dictionary<string, T?> keyValues, DateTimeOffset absoluteExpiration);
+
+    Task SetListAsync<T>(Dictionary<string, T?> keyValues, TimeSpan absoluteExpirationRelativeToNow);
+
+    Task SetListAsync<T>(Dictionary<string, T?> keyValues, CacheEntryOptions? options = null);
+}

src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/ICacheClientFactory.cs

@@ -0,0 +1,9 @@
+// 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 ICacheClientFactory<out TService> : IMasaFactory<TService> where TService : class
+{
+
+}

src/Utils/Caching/Masa.Utils.Caching.Core/DependencyInjection/ICachingBuilder.cs → src/BuildingBlocks/Caching/Masa.BuildingBlocks.Caching/ICachingBuilder.cs

@@ -1,11 +1,8 @@
-// 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.Utils.Caching.Core.DependencyInjection;
+namespace Masa.BuildingBlocks.Caching;
 
-/// <summary>
-/// A builder for configuring named <see cref="ICachingBuilder"/> instances.
-/// </summary>
 public interface ICachingBuilder
 {
     /// <summary>