@ -15,10 +15,36 @@ namespace Volo.Abp.Caching
/// Represents a distributed cache of <typeparamref name="TCacheItem" /> type.
/// Represents a distributed cache of <typeparamref name="TCacheItem" /> type.
/// </summary>
/// </summary>
/// <typeparam name="TCacheItem">The type of cache item being cached.</typeparam>
/// <typeparam name="TCacheItem">The type of cache item being cached.</typeparam>
public class DistributedCache < TCacheItem > : IDistributedCache < TCacheItem > public class DistributedCache < TCacheItem > : DistributedCache < TCacheItem , string > , IDistributedCache < TCacheItem >
where TCacheItem : class where TCacheItem : class
{ {
public ILogger < DistributedCache < TCacheItem > > Logger { get ; set ; } public DistributedCache (
IOptions < CacheOptions > cacheOption ,
IOptions < DistributedCacheOptions > distributedCacheOption ,
IDistributedCache cache ,
ICancellationTokenProvider cancellationTokenProvider ,
IDistributedCacheSerializer serializer ,
ICurrentTenant currentTenant ) : base (
cacheOption : cacheOption ,
distributedCacheOption : distributedCacheOption ,
cache : cache ,
cancellationTokenProvider : cancellationTokenProvider ,
serializer : serializer ,
currentTenant : currentTenant )
{
}
}
/// <summary>
/// Represents a distributed cache of <typeparamref name="TCacheItem" /> type.
/// Uses a generic cache key type of <typeparamref name="TCacheKey" /> type.
/// </summary>
/// <typeparam name="TCacheItem">The type of cache item being cached.</typeparam>
/// <typeparam name="TCacheKey">The type of cache key being used.</typeparam>
public class DistributedCache < TCacheItem , TCacheKey > : IDistributedCache < TCacheItem , TCacheKey >
where TCacheItem : class
{
public ILogger < DistributedCache < TCacheItem , TCacheKey > > Logger { get ; set ; }
protected string CacheName { get ; set ; } protected string CacheName { get ; set ; }
@ -36,13 +62,13 @@ namespace Volo.Abp.Caching
protected DistributedCacheEntryOptions DefaultCacheOptions ; protected DistributedCacheEntryOptions DefaultCacheOptions ;
private readonly CacheOptions _ cacheOption ; private readonly AbpDistributed CacheOptions_ cacheOption ;
private readonly DistributedCacheOptions _d istributedCacheOption ; private readonly Abp DistributedCacheOptions_d istributedCacheOption ;
public DistributedCache ( public DistributedCache (
IOptions < CacheOptions > cacheOption , IOptions < AbpDistributed CacheOptions> cacheOption ,
IOptions < DistributedCacheOptions > distributedCacheOption , IOptions < Abp DistributedCacheOptions> distributedCacheOption ,
IDistributedCache cache , IDistributedCache cache ,
ICancellationTokenProvider cancellationTokenProvider , ICancellationTokenProvider cancellationTokenProvider ,
IDistributedCacheSerializer serializer , IDistributedCacheSerializer serializer ,
@ -52,7 +78,7 @@ namespace Volo.Abp.Caching
_ cacheOption = cacheOption . Value ; _ cacheOption = cacheOption . Value ;
Cache = cache ; Cache = cache ;
CancellationTokenProvider = cancellationTokenProvider ; CancellationTokenProvider = cancellationTokenProvider ;
Logger = NullLogger < DistributedCache < TCacheItem > > . Instance ; Logger = NullLogger < DistributedCache < TCacheItem , TCacheKey > > . Instance ;
Serializer = serializer ; Serializer = serializer ;
CurrentTenant = currentTenant ; CurrentTenant = currentTenant ;
@ -60,7 +86,41 @@ namespace Volo.Abp.Caching
SetDefaultOptions ( ) ; SetDefaultOptions ( ) ;
} }
protected virtual string NormalizeKey ( TCacheKey key )
{
var normalizedKey = "c:" + CacheName + ",k:" + _ cacheOption . KeyPrefix + key . ToString ( ) ;
if ( ! IgnoreMultiTenancy & & CurrentTenant . Id . HasValue )
{
normalizedKey = "t:" + CurrentTenant . Id . Value + "," + normalizedKey ;
}
return normalizedKey ;
}
protected virtual DistributedCacheEntryOptions GetDefaultCacheEntryOptions ( )
{
foreach ( var configure in _ cacheOption . CacheConfigurators )
{
var options = configure . Invoke ( CacheName ) ;
if ( options ! = null )
{
return options ;
}
}
return _ cacheOption . GlobalCacheEntryOptions ;
}
protected virtual void SetDefaultOptions ( )
{
CacheName = CacheNameAttribute . GetCacheName ( typeof ( TCacheItem ) ) ;
//IgnoreMultiTenancy
IgnoreMultiTenancy = typeof ( TCacheItem ) . IsDefined ( typeof ( IgnoreMultiTenancyAttribute ) , true ) ;
//Configure default cache entry options
DefaultCacheOptions = GetDefaultCacheEntryOptions ( ) ;
}
/// <summary>
/// <summary>
/// Gets a cache item with the given key. If no cache item is found for the given key then returns null.
/// Gets a cache item with the given key. If no cache item is found for the given key then returns null.
/// </summary>
/// </summary>
@ -68,7 +128,7 @@ namespace Volo.Abp.Caching
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <returns>The cache item, or null.</returns>
/// <returns>The cache item, or null.</returns>
public virtual TCacheItem Get ( public virtual TCacheItem Get (
string key , TCacheKey key ,
bool? hideErrors = null ) bool? hideErrors = null )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -106,8 +166,8 @@ namespace Volo.Abp.Caching
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <returns>The cache item, or null.</returns>
/// <returns>The cache item, or null.</returns>
public virtual async Task < TCacheItem > GetAsync ( public virtual async Task < TCacheItem > GetAsync (
string key , TCacheKey key ,
bool? hideErrors = null , bool? hideErrors = null ,
CancellationToken token = default ) CancellationToken token = default )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -131,7 +191,7 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
if ( cachedBytes = = null ) if ( cachedBytes = = null )
{ {
return null ; return null ;
@ -139,7 +199,6 @@ namespace Volo.Abp.Caching
return Serializer . Deserialize < TCacheItem > ( cachedBytes ) ; return Serializer . Deserialize < TCacheItem > ( cachedBytes ) ;
} }
/// <summary>
/// <summary>
/// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
/// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
/// provided by <paramref name="factory" /> delegate and returns the provided cache item.
/// provided by <paramref name="factory" /> delegate and returns the provided cache item.
@ -149,10 +208,10 @@ namespace Volo.Abp.Caching
/// <param name="optionsFactory">The cache options for the factory delegate.</param>
/// <param name="optionsFactory">The cache options for the factory delegate.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <returns>The cache item.</returns>
/// <returns>The cache item.</returns>
public TCacheItem GetOrAdd ( public virtual TCacheItem GetOrAdd (
string key , TCacheKey key ,
Func < TCacheItem > factory , Func < TCacheItem > factory ,
Func < DistributedCacheEntryOptions > optionsFactory = null , Func < DistributedCacheEntryOptions > optionsFactory = null ,
bool? hideErrors = null ) bool? hideErrors = null )
{ {
var value = Get ( key , hideErrors ) ; var value = Get ( key , hideErrors ) ;
@ -175,7 +234,6 @@ namespace Volo.Abp.Caching
return value ; return value ;
} }
/// <summary>
/// <summary>
/// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
/// Gets or Adds a cache item with the given key. If no cache item is found for the given key then adds a cache item
/// provided by <paramref name="factory" /> delegate and returns the provided cache item.
/// provided by <paramref name="factory" /> delegate and returns the provided cache item.
@ -186,11 +244,11 @@ namespace Volo.Abp.Caching
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <returns>The cache item.</returns>
/// <returns>The cache item.</returns>
public async Task < TCacheItem > GetOrAddAsync ( public virtual async Task < TCacheItem > GetOrAddAsync (
string key , TCacheKey key ,
Func < Task < TCacheItem > > factory , Func < Task < TCacheItem > > factory ,
Func < DistributedCacheEntryOptions > optionsFactory = null , Func < DistributedCacheEntryOptions > optionsFactory = null ,
bool? hideErrors = null , bool? hideErrors = null ,
CancellationToken token = default ) CancellationToken token = default )
{ {
token = CancellationTokenProvider . FallbackToProvider ( token ) ; token = CancellationTokenProvider . FallbackToProvider ( token ) ;
@ -214,7 +272,6 @@ namespace Volo.Abp.Caching
return value ; return value ;
} }
/// <summary>
/// <summary>
/// Sets the cache item value for the provided key.
/// Sets the cache item value for the provided key.
/// </summary>
/// </summary>
@ -223,9 +280,9 @@ namespace Volo.Abp.Caching
/// <param name="options">The cache options for the value.</param>
/// <param name="options">The cache options for the value.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
public virtual void Set ( public virtual void Set (
string key , TCacheKey key ,
TCacheItem value , TCacheItem value ,
DistributedCacheEntryOptions options = null , DistributedCacheEntryOptions options = null ,
bool? hideErrors = null ) bool? hideErrors = null )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -249,7 +306,6 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
} }
/// <summary>
/// <summary>
/// Sets the cache item value for the provided key.
/// Sets the cache item value for the provided key.
/// </summary>
/// </summary>
@ -260,10 +316,10 @@ namespace Volo.Abp.Caching
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
/// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
public virtual async Task SetAsync ( public virtual async Task SetAsync (
string key , TCacheKey key ,
TCacheItem value , TCacheItem value ,
DistributedCacheEntryOptions options = null , DistributedCacheEntryOptions options = null ,
bool? hideErrors = null , bool? hideErrors = null ,
CancellationToken token = default ) CancellationToken token = default )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -288,15 +344,14 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
} }
/// <summary>
/// <summary>
/// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
/// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
/// </summary>
/// </summary>
/// <param name="key">The key of cached item to be retrieved from the cache.</param>
/// <param name="key">The key of cached item to be retrieved from the cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
public virtual void Refresh ( public virtual void Refresh (
string key , TCacheKey key , bool?
bool? hideErrors = null ) hideErrors = null )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -315,7 +370,6 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
} }
/// <summary>
/// <summary>
/// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
/// Refreshes the cache value of the given key, and resets its sliding expiration timeout.
/// </summary>
/// </summary>
@ -324,8 +378,8 @@ namespace Volo.Abp.Caching
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
/// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
public virtual async Task RefreshAsync ( public virtual async Task RefreshAsync (
string key , TCacheKey key ,
bool? hideErrors = null , bool? hideErrors = null ,
CancellationToken token = default ) CancellationToken token = default )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -345,15 +399,13 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
} }
/// <summary>
/// <summary>
/// Removes the cache item for given key from cache.
/// Removes the cache item for given key from cache.
/// </summary>
/// </summary>
/// <param name="key">The key of cached item to be retrieved from the cache.</param>
/// <param name="key">The key of cached item to be retrieved from the cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
/// <param name="hideErrors">Indicates to throw or hide the exceptions for the distributed cache.</param>
public virtual void Remove ( public virtual void Remove (
string key , TCacheKey key ,
bool? hideErrors = null ) bool? hideErrors = null )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -372,7 +424,6 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
} }
/// <summary>
/// <summary>
/// Removes the cache item for given key from cache.
/// Removes the cache item for given key from cache.
/// </summary>
/// </summary>
@ -381,8 +432,8 @@ namespace Volo.Abp.Caching
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <param name="token">The <see cref="T:System.Threading.CancellationToken" /> for the task.</param>
/// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
/// <returns>The <see cref="T:System.Threading.Tasks.Task" /> indicating that the operation is asynchronous.</returns>
public virtual async Task RemoveAsync ( public virtual async Task RemoveAsync (
string key , TCacheKey key ,
bool? hideErrors = null , bool? hideErrors = null ,
CancellationToken token = default ) CancellationToken token = default )
{ {
hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ; hideErrors = hideErrors ? ? _d istributedCacheOption . HideErrors ;
@ -401,42 +452,8 @@ namespace Volo.Abp.Caching
throw ; throw ;
} }
} }
protected virtual string NormalizeKey ( string key ) }
{
var normalizedKey = "c:" + CacheName + ",k:" + _ cacheOption . KeyPrefix + key ;
if ( ! IgnoreMultiTenancy & & CurrentTenant . Id . HasValue )
{
normalizedKey = "t:" + CurrentTenant . Id . Value + "," + normalizedKey ;
}
return normalizedKey ;
}
protected virtual DistributedCacheEntryOptions GetDefaultCacheEntryOptions ( )
{
foreach ( var configure in _ cacheOption . CacheConfigurators )
{
var options = configure . Invoke ( CacheName ) ;
if ( options ! = null )
{
return options ;
}
}
return _ cacheOption . GlobalCacheEntryOptions ;
}
protected virtual void SetDefaultOptions ( )
{
CacheName = CacheNameAttribute . GetCacheName ( typeof ( TCacheItem ) ) ;
//IgnoreMultiTenancy
IgnoreMultiTenancy = typeof ( TCacheItem ) . IsDefined ( typeof ( IgnoreMultiTenancyAttribute ) , true ) ;
//Configure default cache entry options
DefaultCacheOptions = GetDefaultCacheEntryOptions ( ) ;
}
}
} }
liangshiwei
7 years ago