Merge pull request #327 from dotnetcore/dev

catcherwong · web-flow · commit c842bfe2bc1f · 2021-10-07T08:57:31.000+08:00
v1.4.1
diff --git a/build/releasenotes.props b/build/releasenotes.props
@@ -1,19 +1,20 @@
 <Project>
   <PropertyGroup>
     <EasyCachingCorePackageNotes>
-      1. Support distributed lock.
+      1. Expose raw cache database.
     </EasyCachingCorePackageNotes>
     <EasyCachingMemcachedPackageNotes>
-      1. Support distributed lock.
+      1. Expose raw cache database.
     </EasyCachingMemcachedPackageNotes>
     <EasyCachingRedisPackageNotes>
-      1. Support distributed lock.
+      1. Expose raw cache database.
+      2. Support KeyPrefix.
     </EasyCachingRedisPackageNotes>
     <EasyCachingSQLitePackageNotes>
-      1. Upgrading dependencies.
+      1. Expose raw cache database.
     </EasyCachingSQLitePackageNotes>
     <EasyCachingInMemoryPackageNotes>
-      1. Upgrading dependencies.
+      1. Expose raw cache database.
     </EasyCachingInMemoryPackageNotes>
     <EasyCachingHybridPackageNotes>
       1. Upgrading dependencies.
@@ -52,7 +53,7 @@
       1. Upgrading dependencies.
     </EasyCachingDiskPackageNotes>
     <EasyCachingLiteDBPackageNotes>
-      1. Upgrading dependencies.
+      1. Expose raw cache database.
     </EasyCachingLiteDBPackageNotes>
     <EasyCachingSTJsonPackageNotes>
       1. Upgrading dependencies.
diff --git a/build/version.props b/build/version.props
@@ -1,24 +1,24 @@
 <Project>
 	<PropertyGroup>
-		<EasyCachingCorePackageVersion>1.4.0</EasyCachingCorePackageVersion>
-		<EasyCachingMemcachedPackageVersion>1.4.0</EasyCachingMemcachedPackageVersion>
-		<EasyCachingRedisPackageVersion>1.4.0</EasyCachingRedisPackageVersion>
-		<EasyCachingSQLitePackageVersion>1.4.0</EasyCachingSQLitePackageVersion>
-		<EasyCachingInMemoryPackageVersion>1.4.0</EasyCachingInMemoryPackageVersion>
-		<EasyCachingHybridPackageVersion>1.4.0</EasyCachingHybridPackageVersion>
-		<EasyCachingAspectCorePackageVersion>1.4.0</EasyCachingAspectCorePackageVersion>
-		<EasyCachingCastlePackageVersion>1.4.0</EasyCachingCastlePackageVersion>
-		<EasyCachingResponseCachingPackageVersion>1.4.0</EasyCachingResponseCachingPackageVersion>
-		<EasyCachingJsonPackageVersion>1.4.0</EasyCachingJsonPackageVersion>
-		<EasyCachingMessagePackPackageVersion>1.4.0</EasyCachingMessagePackPackageVersion>
-		<EasyCachingProtobufPackageVersion>1.4.0</EasyCachingProtobufPackageVersion>
-		<EasyCachingCSRedisPackageVersion>1.4.0</EasyCachingCSRedisPackageVersion>
-		<EasyCachingRedisBusPackageVersion>1.4.0</EasyCachingRedisBusPackageVersion>
-		<EasyCachingCSRedisBusPackageVersion>1.4.0</EasyCachingCSRedisBusPackageVersion>
-		<EasyCachingRabbitBusPackageVersion>1.4.0</EasyCachingRabbitBusPackageVersion>
-		<EasyCachingDiskPackageVersion>1.4.0</EasyCachingDiskPackageVersion>
-		<EasyCachingMsExtPackageVersion>1.4.0</EasyCachingMsExtPackageVersion>
-		<EasyCachingLiteDBPackageVersion>1.4.0</EasyCachingLiteDBPackageVersion>
-		<EasyCachingSTJsonPackageVersion>1.4.0</EasyCachingSTJsonPackageVersion>
+		<EasyCachingCorePackageVersion>1.4.1</EasyCachingCorePackageVersion>
+		<EasyCachingMemcachedPackageVersion>1.4.1</EasyCachingMemcachedPackageVersion>
+		<EasyCachingRedisPackageVersion>1.4.1</EasyCachingRedisPackageVersion>
+		<EasyCachingSQLitePackageVersion>1.4.1</EasyCachingSQLitePackageVersion>
+		<EasyCachingInMemoryPackageVersion>1.4.1</EasyCachingInMemoryPackageVersion>
+		<EasyCachingHybridPackageVersion>1.4.1</EasyCachingHybridPackageVersion>
+		<EasyCachingAspectCorePackageVersion>1.4.1</EasyCachingAspectCorePackageVersion>
+		<EasyCachingCastlePackageVersion>1.4.1</EasyCachingCastlePackageVersion>
+		<EasyCachingResponseCachingPackageVersion>1.4.1</EasyCachingResponseCachingPackageVersion>
+		<EasyCachingJsonPackageVersion>1.4.1</EasyCachingJsonPackageVersion>
+		<EasyCachingMessagePackPackageVersion>1.4.1</EasyCachingMessagePackPackageVersion>
+		<EasyCachingProtobufPackageVersion>1.4.1</EasyCachingProtobufPackageVersion>
+		<EasyCachingCSRedisPackageVersion>1.4.1</EasyCachingCSRedisPackageVersion>
+		<EasyCachingRedisBusPackageVersion>1.4.1</EasyCachingRedisBusPackageVersion>
+		<EasyCachingCSRedisBusPackageVersion>1.4.1</EasyCachingCSRedisBusPackageVersion>
+		<EasyCachingRabbitBusPackageVersion>1.4.1</EasyCachingRabbitBusPackageVersion>
+		<EasyCachingDiskPackageVersion>1.4.1</EasyCachingDiskPackageVersion>
+		<EasyCachingMsExtPackageVersion>1.4.1</EasyCachingMsExtPackageVersion>
+		<EasyCachingLiteDBPackageVersion>1.4.1</EasyCachingLiteDBPackageVersion>
+		<EasyCachingSTJsonPackageVersion>1.4.1</EasyCachingSTJsonPackageVersion>
 	</PropertyGroup>
 </Project>
diff --git a/src/EasyCaching.CSRedis/DefaultCSRedisCachingProvider.cs b/src/EasyCaching.CSRedis/DefaultCSRedisCachingProvider.cs
@@ -3,7 +3,7 @@
     using EasyCaching.Core;
     using EasyCaching.Core.DistributedLock;
     using EasyCaching.Core.Serialization;
-using EasyCaching.CSRedis.DistributedLock;
+    using EasyCaching.CSRedis.DistributedLock;
     using global::CSRedis;
     using Microsoft.Extensions.Logging;
     using System;
@@ -482,9 +482,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.Core/EasyCachingAbstractProvider.cs b/src/EasyCaching.Core/EasyCachingAbstractProvider.cs
@@ -31,6 +31,8 @@ public abstract class EasyCachingAbstractProvider : IEasyCachingProvider
         public CachingProviderType CachingProviderType => this.ProviderType;
         public CacheStats CacheStats => this.ProviderStats;
 
+        public object Database => BaseGetDatabse();
+
         protected EasyCachingAbstractProvider() { }
 
         protected EasyCachingAbstractProvider(IDistributedLockFactory lockFactory, BaseProviderOptions options)
@@ -39,6 +41,7 @@ protected EasyCachingAbstractProvider(IDistributedLockFactory lockFactory, BaseP
             _options = options;
         }
 
+        public abstract object BaseGetDatabse();
         public abstract bool BaseExists(string cacheKey);
         public abstract Task<bool> BaseExistsAsync(string cacheKey);
         public abstract void BaseFlush();
diff --git a/src/EasyCaching.Core/IEasyCachingProvider.cs b/src/EasyCaching.Core/IEasyCachingProvider.cs
@@ -115,5 +115,10 @@ public interface IEasyCachingProvider : IEasyCachingProviderBase
         /// </summary>
         /// <returns></returns>
         ProviderInfo GetProviderInfo();
+
+        /// <summary>
+        /// Get or sets the provider's database
+        /// </summary>
+        object Database { get; }
     }
 }
diff --git a/src/EasyCaching.Disk/DefaultDiskCachingProvider.cs b/src/EasyCaching.Disk/DefaultDiskCachingProvider.cs
@@ -673,9 +673,8 @@ private void DeleteDirectory(string path)
             }
         }
 
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => throw new Exception("Disk provider don't support this ");
     }
 }
diff --git a/src/EasyCaching.InMemory/DefaultInMemoryCachingProvider.cs b/src/EasyCaching.InMemory/DefaultInMemoryCachingProvider.cs
@@ -375,9 +375,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.LiteDB/DefaultLiteDBCachingProvider.cs b/src/EasyCaching.LiteDB/DefaultLiteDBCachingProvider.cs
@@ -402,9 +402,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.Memcached/DefaultMemcachedCachingProvider.cs b/src/EasyCaching.Memcached/DefaultMemcachedCachingProvider.cs
@@ -412,6 +412,8 @@ public override ProviderInfo BaseGetProviderInfo()
             return _info;
         }
 
+        public override object BaseGetDatabse() => _memcachedClient;
+
         private void OnCacheHit(string cacheKey)
         {
             CacheStats.OnHit();
diff --git a/src/EasyCaching.Redis/Configurations/RedisDBOptions.cs b/src/EasyCaching.Redis/Configurations/RedisDBOptions.cs
@@ -24,5 +24,10 @@ public class RedisDBOptions : BaseRedisOptions
         /// Specifies the time in milliseconds that the system should allow for synchronous operations (defaults to 5 seconds)
         /// </summary>
         public int SyncTimeout { get; set; }
+
+        /// <summary>
+        /// Gets or sets the Redis database KeyPrefix will use.
+        /// </summary>
+        public string KeyPrefix { get; set; }
     }
 }
diff --git a/src/EasyCaching.Redis/Configurations/RedisDatabaseProvider.cs b/src/EasyCaching.Redis/Configurations/RedisDatabaseProvider.cs
@@ -1,6 +1,7 @@
 ﻿namespace EasyCaching.Redis
 {
     using StackExchange.Redis;
+    using StackExchange.Redis.KeyspaceIsolation;
     using System;
     using System.Collections.Generic;
     using System.Linq;
@@ -20,7 +21,7 @@ public class RedisDatabaseProvider : IRedisDatabaseProvider
         /// The connection multiplexer.
         /// </summary>
         private Lazy<ConnectionMultiplexer> _connectionMultiplexer;
-        
+
         public RedisDatabaseProvider(string name, RedisOptions options)
         {
             _options = options.DBConfig;
@@ -39,7 +40,11 @@ public IDatabase GetDatabase()
         {
             try
             {
-                return _connectionMultiplexer.Value.GetDatabase();
+
+                var database = _connectionMultiplexer.Value.GetDatabase();
+                if (!string.IsNullOrEmpty(_options.KeyPrefix))
+                    database = database.WithKeyPrefix(_options.KeyPrefix);
+                return database;
             }
             catch (Exception)
             {
diff --git a/src/EasyCaching.Redis/DefaultRedisCachingProvider.cs b/src/EasyCaching.Redis/DefaultRedisCachingProvider.cs
@@ -512,9 +512,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/src/EasyCaching.SQLite/DefaultSQLiteCachingProvider.cs b/src/EasyCaching.SQLite/DefaultSQLiteCachingProvider.cs
@@ -413,9 +413,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)
         /// Get te information of this provider.
         /// </summary>
         /// <returns></returns>
-        public override ProviderInfo BaseGetProviderInfo()
-        {
-            return _info;
-        }
+        public override ProviderInfo BaseGetProviderInfo() => _info;
+
+        public override object BaseGetDatabse() => _cache;
     }
 }
diff --git a/test/EasyCaching.UnitTests/CachingTests/CSRedisCachingProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/CSRedisCachingProviderTest.cs
@@ -38,6 +38,23 @@ protected override IEasyCachingProvider CreateCachingProvider(Action<BaseProvide
             IServiceProvider serviceProvider = services.BuildServiceProvider();
             return serviceProvider.GetService<IEasyCachingProvider>();
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<EasyCachingCSRedisClient>(db);
+        }
+
+        [Fact]
+        public void GetDatabase_And_Use_Raw_Method_Should_Succeed()
+        {
+            var db = (EasyCachingCSRedisClient)_provider.Database;
+            var flag = db.Ping();
+            Assert.True(flag);
+        }
     }
 
     public class CSRedisCachingProviderWithNamedSerTest
diff --git a/test/EasyCaching.UnitTests/CachingTests/HybridCachingTest.cs b/test/EasyCaching.UnitTests/CachingTests/HybridCachingTest.cs
@@ -221,6 +221,22 @@ public async Task Distributed_Set_Async_Throw_Exception_Should_Not_Break()
             Assert.Equal(default(string), res.Value);
         }
 
+        [Fact]
+        public void Iss_311_Test()
+        {
+            var cacheKey = $"{_namespace}_iss311_{Guid.NewGuid()}";
+
+            hybridCaching_1.Set(cacheKey, "val", TimeSpan.FromSeconds(30));
+
+            var afterSet = hybridCaching_1.Exists(cacheKey);
+            Assert.True(afterSet);
+
+            hybridCaching_1.Remove(cacheKey);
+
+            var afterRemove = hybridCaching_1.Exists(cacheKey);
+            Assert.False(afterRemove);
+        }
+
         private void FakeCreatProvider()
         {
             A.CallTo(() => fakeFactory.GetCachingProvider("m1")).Returns(new FakeLocalCachingProvider());
diff --git a/test/EasyCaching.UnitTests/CachingTests/LiteDBCachingTest.cs b/test/EasyCaching.UnitTests/CachingTests/LiteDBCachingTest.cs
@@ -9,6 +9,7 @@
     using System.IO;
     using System.Threading.Tasks;
     using Xunit;
+    using global::LiteDB;
 
     public class LiteDBCachingTest : BaseCachingProviderTest
     {
@@ -45,6 +46,15 @@ protected override Task GetAsync_Parallel_Should_Succeed()
         protected override void Get_Parallel_Should_Succeed()
         {
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsAssignableFrom<ILiteCollection<CacheItem>>(db);
+        }
     }
 
 
diff --git a/test/EasyCaching.UnitTests/CachingTests/MemcachedProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/MemcachedProviderTest.cs
@@ -186,8 +186,24 @@ private void GetCacheItem(string cacheKey, string prefix)
             var val = _provider.Get<string>(cacheKey);
             Assert.False(val.HasValue);
         }
-    }
 
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<EasyCachingMemcachedClient>(db);
+        }
+
+        [Fact]
+        public void GetDatabase_And_Use_Raw_Method_Should_Succeed()
+        {
+            var db = (EasyCachingMemcachedClient)_provider.Database;
+            var stats = db.Stats();
+            Assert.NotNull(stats);
+        }
+    }
 
     public class MemcachedProviderWithFactoryTest : BaseCachingProviderWithFactoryTest
     {
diff --git a/test/EasyCaching.UnitTests/CachingTests/MemoryCachingProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/MemoryCachingProviderTest.cs
@@ -109,7 +109,17 @@ public void Issues150_DeepClone_Object_Test()
 
             Assert.Equal("catcherwong", res2.Value.Name);
         }
+
+        [Fact]
+        public void GetDatabase_Should_Succeed()
+        {
+            var db = _provider.Database;
+
+            Assert.NotNull(db);
+            Assert.IsType<InMemoryCaching>(db);
+        }
     }
+
     public class MemoryCachingProviderWithFactoryTest : BaseCachingProviderWithFactoryTest
     {
         public MemoryCachingProviderWithFactoryTest()
diff --git a/test/EasyCaching.UnitTests/CachingTests/RedisCachingProviderTest.cs b/test/EasyCaching.UnitTests/CachingTests/RedisCachingProviderTest.cs
diff --git a/test/EasyCaching.UnitTests/Diagnostics/MyCachingProvider.cs b/test/EasyCaching.UnitTests/Diagnostics/MyCachingProvider.cs
diff --git a/test/EasyCaching.UnitTests/Fake/FakeDistributedCachingProvider.cs b/test/EasyCaching.UnitTests/Fake/FakeDistributedCachingProvider.cs
diff --git a/test/EasyCaching.UnitTests/Fake/FakeLocalCachingProvider.cs b/test/EasyCaching.UnitTests/Fake/FakeLocalCachingProvider.cs

Original file line number	Diff line number	Diff line change
`@@ -115,5 +115,10 @@ public interface IEasyCachingProvider : IEasyCachingProviderBase`
`115`	`115`	`/// </summary>`
`116`	`116`	`/// <returns></returns>`
`117`	`117`	`ProviderInfo GetProviderInfo();`
	`118`	`+`
	`119`	`+ /// <summary>`
	`120`	`+ /// Get or sets the provider's database`
	`121`	`+ /// </summary>`
	`122`	`+ object Database { get; }`
`118`	`123`	`}`
`119`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -673,9 +673,8 @@ private void DeleteDirectory(string path)`
`673`	`673`	`}`
`674`	`674`	`}`
`675`	`675`
`676`		`- public override ProviderInfo BaseGetProviderInfo()`
`677`		`- {`
`678`		`- return _info;`
`679`		`- }`
	`676`	`+ public override ProviderInfo BaseGetProviderInfo() => _info;`
	`677`	`+`
	`678`	`+ public override object BaseGetDatabse() => throw new Exception("Disk provider don't support this ");`
`680`	`679`	`}`
`681`	`680`	`}`
Original file line number	Diff line number	Diff line change
`@@ -375,9 +375,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)`
`375`	`375`	`/// Get te information of this provider.`
`376`	`376`	`/// </summary>`
`377`	`377`	`/// <returns></returns>`
`378`		`- public override ProviderInfo BaseGetProviderInfo()`
`379`		`- {`
`380`		`- return _info;`
`381`		`- }`
	`378`	`+ public override ProviderInfo BaseGetProviderInfo() => _info;`
	`379`	`+`
	`380`	`+ public override object BaseGetDatabse() => _cache;`
`382`	`381`	`}`
`383`	`382`	`}`
Original file line number	Diff line number	Diff line change
`@@ -402,9 +402,8 @@ public override TimeSpan BaseGetExpiration(string cacheKey)`
`402`	`402`	`/// Get te information of this provider.`
`403`	`403`	`/// </summary>`
`404`	`404`	`/// <returns></returns>`
`405`		`- public override ProviderInfo BaseGetProviderInfo()`
`406`		`- {`
`407`		`- return _info;`
`408`		`- }`
	`405`	`+ public override ProviderInfo BaseGetProviderInfo() => _info;`
	`406`	`+`
	`407`	`+ public override object BaseGetDatabse() => _cache;`
`409`	`408`	`}`
`410`	`409`	`}`
Original file line number	Diff line number	Diff line change
`@@ -412,6 +412,8 @@ public override ProviderInfo BaseGetProviderInfo()`
`412`	`412`	`return _info;`
`413`	`413`	`}`
`414`	`414`
	`415`	`+ public override object BaseGetDatabse() => _memcachedClient;`
	`416`	`+`
`415`	`417`	`private void OnCacheHit(string cacheKey)`
`416`	`418`	`{`
`417`	`419`	`CacheStats.OnHit();`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,10 @@ public class RedisDBOptions : BaseRedisOptions`
`24`	`24`	`/// Specifies the time in milliseconds that the system should allow for synchronous operations (defaults to 5 seconds)`
`25`	`25`	`/// </summary>`
`26`	`26`	`public int SyncTimeout { get; set; }`
	`27`	`+`
	`28`	`+ /// <summary>`
	`29`	`+ /// Gets or sets the Redis database KeyPrefix will use.`
	`30`	`+ /// </summary>`
	`31`	`+ public string KeyPrefix { get; set; }`
`27`	`32`	`}`
`28`	`33`	`}`