CommunityAbp.AspNetZero.FusionCache — nugetz
pkg
kfrancis/ CommunityAbp.AspNetZero.FusionCache v0.1.0 .NET 9.0
FusionCache integration for AspNetZero/ABP Framework with hybrid caching and advanced resiliency features
Get Started dotnet CLI PackageReference Package Manager
$ dotnet add package CommunityAbp.AspNetZero.FusionCacheReadme ABP FusionCache Integration
This package integrates FusionCache into ASP.NET Zero and ABP Framework applications, providing a drop-in replacement for the standard Redis cache with advanced resiliency features and hybrid caching capabilities.
Features
Hybrid Caching : Combines L1 (in-memory) and L2 (distributed) caching layers for optimal performanceFail-Safe Mode : Automatically serves stale data when the cache backend is unavailableCache Stampede Protection : Prevents multiple concurrent requests from overwhelming your data sourceMulti-Tenancy Support : Tenant-aware cache key normalization and isolationRedis Backplane : Synchronizes cache across multiple application instancesEager Refresh : Proactively refreshes cache entries before expirationEasy Configuration : Fluent API for simple setup and customization
Installation
Basic Installation (In-Memory Only)
Install the core package:
dotnet add package CommunityAbp.AspNetZero.FusionCache
Redis Integration
For distributed caching with Redis, install the Redis package:
dotnet add package CommunityAbp.AspNetZero.FusionCache.Redis
Quick Start
ASP.NET Core / ABP vNext
1. Basic Configuration (In-Memory Only) public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// Add FusionCache with default options
services.AddAbpFusionCache(options =>
{
options.DefaultCacheDuration = TimeSpan.FromMinutes(30);
options.EnableFailSafe = true;
options.EnableCacheStampedeProtection = true;
});
}
}
2. With Redis Distributed Cache public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// Add FusionCache
services.AddAbpFusionCache(options =>
{
options.EnableDistributedCache = true;
options.EnableBackplane = true;
});
// Add Redis integration
services.AddAbpFusionCacheRedis(Configuration, options =>
{
options.ConnectionString = "localhost:6379";
options.EnableBackplane = true;
options.InstanceName = "MyApp:";
});
}
}
ABP Framework (Classic) Configure FusionCache in your module's PreInitialize method:
[DependsOn(typeof(AbpKernelModule))]
public class MyApplicationModule : AbpModule
{
public override void PreInitialize()
{
// Enable FusionCache
Configuration.Caching.UseFusionCache(options =>
{
options.DefaultCacheDuration = TimeSpan.FromMinutes(30);
options.EnableFailSafe = true;
options.EnableMultiTenancy = true;
});
}
}
Configuration Options
Core Options (AbpFusionCacheOptions) Property Type Default Description DefaultCacheDurationTimeSpan30 minutes Default duration for cached items EnableMemoryCachebooltrueEnable L1 in-memory caching EnableDistributedCacheboolfalseEnable L2 distributed caching EnableFailSafebooltrueServe stale data when cache backend is unavailable EnableCacheStampedeProtectionbooltruePrevent cache stampede scenarios EnableEagerRefreshboolfalseProactively refresh cache before expiration EagerRefreshThresholdfloat0.9fThreshold (0-1) for eager refresh trigger EnableMultiTenancybooltrueEnable tenant-aware caching KeyPrefixstring"AbpCache"Prefix for all cache keys EnableBackplaneboolfalseEnable distributed cache synchronization
Redis Options (AbpFusionCacheRedisOptions) Property Type Default Description ConnectionStringstringnullRedis connection string Databaseint0Redis database index EnableBackplaneboolfalseEnable Redis backplane for cache sync BackplaneChannelPrefixstring"AbpFusionCache"Prefix for backplane channels ConnectTimeoutTimeSpan5 seconds Connection timeout SyncTimeoutTimeSpan5 seconds Synchronous operation timeout InstanceNamestring"AbpFusionCache"Cache instance name
Usage Examples
Basic Cache Operations public class ProductService
{
private readonly ICacheManager _cacheManager;
public ProductService(ICacheManager cacheManager)
{
_cacheManager = cacheManager;
}
public async Task<Product> GetProductAsync(int productId)
{
var cache = _cacheManager.GetCache("ProductCache");
return await cache.GetAsync(
productId.ToString(),
async () => await LoadProductFromDatabase(productId)
);
}
private async Task<Product> LoadProductFromDatabase(int productId)
{
// Your data loading logic
}
}
Custom Cache Duration public async Task<Product> GetProductAsync(int productId)
{
var cache = _cacheManager.GetCache("ProductCache");
return await cache.GetAsync(
productId.ToString(),
async () => await LoadProductFromDatabase(productId),
slidingExpireTime: TimeSpan.FromMinutes(10)
);
}
Multi-Tenancy Support The cache automatically handles tenant isolation:
// Cache keys are automatically prefixed with tenant ID
var tenantProduct = await cache.GetAsync(
"product:123",
async () => await GetTenantProduct(123)
);
// Different tenants get different cache entries for the same key
Connection String Configuration The Redis integration looks for connection strings in this order:
AbpFusionCacheRedisOptions.ConnectionStringConnectionStrings:Redis in appsettings.jsonRedis:Configuration in appsettings.json
Example appsettings.json {
"ConnectionStrings": {
"Default": "Server=localhost;Database=MyApp;...",
"Redis": "localhost:6379,password=mypassword"
},
"Redis": {
"Configuration": "localhost:6379"
}
}
Advanced Scenarios
Custom Cache Configuration per Cache Name Configuration.Caching.Configure("UserCache", cache =>
{
cache.DefaultSlidingExpireTime = TimeSpan.FromHours(1);
});
Configuration.Caching.Configure("ProductCache", cache =>
{
cache.DefaultSlidingExpireTime = TimeSpan.FromMinutes(15);
});
Fail-Safe with Custom Timeouts services.AddAbpFusionCache(options =>
{
options.EnableFailSafe = true;
options.DefaultCacheDuration = TimeSpan.FromMinutes(30);
// Stale data will be served for up to 1 hour if backend is down
});
High-Availability Setup with Redis Backplane services.AddAbpFusionCache(options =>
{
options.EnableDistributedCache = true;
options.EnableBackplane = true;
options.EnableFailSafe = true;
});
services.AddAbpFusionCacheRedis(Configuration, options =>
{
options.ConnectionString = "redis-cluster:6379,redis-cluster:6380";
options.EnableBackplane = true;
options.BackplaneChannelPrefix = "MyApp:Cache:";
});
Eager Refresh for Critical Data services.AddAbpFusionCache(options =>
{
options.EnableEagerRefresh = true;
options.EagerRefreshThreshold = 0.9f; // Refresh at 90% of lifetime
});
Multi-Tenancy Behavior When multi-tenancy is enabled, the cache automatically:
Tenant-specific data : Shorter cache duration (75% of default) for fresher dataHost data : Longer cache duration (150% of default) for shared dataAutomatic key isolation : Tenant ID is automatically included in cache keysFail-safe tuning : Different fail-safe windows for tenant vs. host data
Performance Considerations
Memory vs. Distributed Cache
L1 (Memory Cache) : Ultra-fast, but per-instance (not shared)L2 (Distributed Cache) : Slower, but shared across instancesHybrid Mode : Best of both worlds - fast reads with shared data
Recommended Settings Single Instance (Development)
options.EnableMemoryCache = true;
options.EnableDistributedCache = false;
Multi-Instance (Production)
options.EnableMemoryCache = true;
options.EnableDistributedCache = true;
options.EnableBackplane = true;
Troubleshooting
Cache Not Working
Verify FusionCache is registered: Check that AddAbpFusionCache() is called
Check Redis connection: Ensure Redis is running and connection string is correct
Review logs: FusionCache logs cache operations at various levels
Stale Data Issues
Ensure backplane is enabled if running multiple instances
Verify backplane channel prefix is consistent across instances
Check network connectivity between instances and Redis
High Memory Usage
Reduce DefaultCacheDuration to expire items sooner
Disable EnableMemoryCache if distributed cache is sufficient
Implement cache eviction policies using ASP.NET Core's MemoryCacheOptions
Dependencies
ABP Framework : 10.3.x or higherFusionCache : 2.4.x or higher.NET : 8.0 or 9.0Redis (optional): Any version supported by StackExchange.Redis
Contributing Contributions are welcome! Please feel free to submit a Pull Request.
License This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
Support For issues, questions, or contributions, please visit:
