ZiggyCreatures.FusionCache
0.20.0-preview2
Prefix Reserved
See the version list below for details.
dotnet add package ZiggyCreatures.FusionCache --version 0.20.0-preview2
NuGet\Install-Package ZiggyCreatures.FusionCache -Version 0.20.0-preview2
<PackageReference Include="ZiggyCreatures.FusionCache" Version="0.20.0-preview2" />
paket add ZiggyCreatures.FusionCache --version 0.20.0-preview2
#r "nuget: ZiggyCreatures.FusionCache, 0.20.0-preview2"
// Install ZiggyCreatures.FusionCache as a Cake Addin #addin nuget:?package=ZiggyCreatures.FusionCache&version=0.20.0-preview2&prerelease // Install ZiggyCreatures.FusionCache as a Cake Tool #tool nuget:?package=ZiggyCreatures.FusionCache&version=0.20.0-preview2&prerelease
FusionCache
FusionCache is an easy to use, high performance and robust cache with an optional distributed 2nd layer and some advanced features.
It was born after years of dealing with all sorts of different types of caches: memory caching, distributed caching, http caching, CDNs, browser cache, offline cache, you name it. So I've tried to put together these experiences and came up with FusionCache.
It uses a memory cache (any impl of the standard IMemoryCache
interface) as the primary backing store and optionally a distributed, 2nd level cache (any impl of the standard IDistributedCache
interface) as a secondary backing store for better resilience and higher performance, for example in a multi-node scenario or to avoid the typical effects of a cold start (initial empty cache, maybe after a restart).
Optionally, it can also use a backplane: in a multi-node scenario this will send notifications to the other nodes to keep each node's memory cache perfectly synchronized, without any additional work.
FusionCache also includes some advanced features like a fail-safe mechanism, cache stampede prevention, fine grained soft/hard timeouts with background factory completion, customizable extensive logging and more (see below).
🏆 Award
On August 2021, FusionCache received the Google Open Source Peer Bonus Award. Here is the official blogpost.
✔ Features
These are the key features of FusionCache:
- 🚀 Cache Stampede prevention: using the optimized
GetOrSet[Async]
method prevents multiple concurrent factory calls per key, with a guarantee that only 1 factory will be called at the same time for the same key (this avoids overloading the data source when no data is in the cache or when a cache entry expires) - 🔀 Optional 2nd level: FusionCache can transparently handle an optional 2nd level cache: anything that implements the standard
IDistributedCache
interface is supported (eg: Redis, MongoDB, SqlServer, etc) - 📢 Backplane: when using a distributed cache as a 2nd layer in a multi-node scenario, you can also enable a backplane to immediately notify the other nodes about changes in the cache, to keep everything synchronized without having to do anything
- 💣 Fail-Safe: enabling the fail-safe mechanism prevents throwing an exception when a factory or a distributed cache call would fail, by reusing an expired entry as a temporary fallback, all transparently and with no additional code required
- ⏱ Soft/Hard timeouts: advanced timeouts management prevents waiting for too long when calling a factory or the distributed cache, to avoid hanging your application. It is possible to specify both soft and hard timeouts, and thanks to automatic background completion no data will be wasted
- 🧙♂️ Adaptive Caching: there are times when you don't know upfront what the cache duration for a piece of data should be, maybe because it depends on the object being cached itself. Adaptive caching solves this elegantly
- ⚡ High performance: FusionCache is optimized to minimize CPU usage and memory allocations to get better performance and lower the cost of your infrastructure all while obtaining a more stable, error resilient application
- 💫 Natively sync/async: full native support for both the synchronous and asynchronous programming model, with sync/async methods working together harmoniously
- 📞 Events: there's a comprehensive set of events to subscribe to regarding core events inside of a FusionCache instance, both at a high level and at lower levels (memory/distributed layers)
- 🧩 Plugins: thanks to a plugin subsystem it is possible to extend FusionCache with additional behavior, like adding support for metrics, statistics, etc...
- 📜 Logging: comprehensive, structured, detailed and customizable logging via the standard
ILogger
interface (you can use Serilog, NLog, etc) - 🔃 Dependency Injection: how to work with FusionCache + DI in .NET
⭐ Quick Start
FusionCache can be installed via the nuget UI (search for the ZiggyCreatures.FusionCache
package) or via the nuget package manager console:
PM> Install-Package ZiggyCreatures.FusionCache
As an example, imagine having a method that retrieves a product from your database:
Product GetProductFromDb(int id) {
// YOUR DATABASE CALL HERE
}
💡 This is using the sync programming model, but it would be equally valid with the newer async one for even better performance.
To start using FusionCache the first thing is create a cache instance:
var cache = new FusionCache(new FusionCacheOptions());
If instead you are using DI (Dependency Injection) use this:
services.AddFusionCache();
We can also specify some global options, like a default FusionCacheEntryOptions
object to serve as a default for each call we'll make, with a duration of 2 minutes
and a Low
priority:
var cache = new FusionCache(new FusionCacheOptions() {
DefaultEntryOptions = new FusionCacheEntryOptions {
Duration = TimeSpan.FromMinutes(2),
Priority = CacheItemPriority.Low
}
});
Or, using DI, like this:
services.AddFusionCache(options => {
options.DefaultEntryOptions = new FusionCacheEntryOptions {
Duration = TimeSpan.FromMinutes(2),
Priority = CacheItemPriority.Low
}
});
Now, to get the product from the cache and, if not there, get it from the database in an optimized way and cache it for 30 sec
simply do this:
var id = 42;
cache.GetOrSet<Product>(
$"product:{id}",
_ => GetProductFromDb(id),
TimeSpan.FromSeconds(30)
);
That's it 🎉
📖 Documentation
A complete documentation, including examples and common use cases, is available at the official repo page on GitHub.
🧰 Supported Platforms
FusionCache targets .NET Standard 2.0
so any compatible .NET implementation is fine: this means .NET Framework
(the old one), .NET Core 2+
and .NET 5/6+
(the new ones), Mono
5.4+ and more (see here for a complete rundown).
NOTE: if you are running on .NET Framework 4.6.1 and want to use .NET Standard packages Microsoft suggests to upgrade to .NET Framework 4.7.2 or higher (see the .NET Standard Documentation) to avoid some known dependency issues.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Extensions.Caching.Memory (>= 3.1.10)
- System.Threading.Tasks.Extensions (>= 4.5.4)
NuGet packages (27)
Showing the top 5 NuGet packages that depend on ZiggyCreatures.FusionCache:
Package | Downloads |
---|---|
ZiggyCreatures.FusionCache.Backplane.StackExchangeRedis
FusionCache backplane for Redis based on the StackExchange.Redis library |
|
ZiggyCreatures.FusionCache.Serialization.NewtonsoftJson
FusionCache serializer based on Newtonsoft Json.NET |
|
ZiggyCreatures.FusionCache.Serialization.SystemTextJson
FusionCache serializer based on System.Text.Json |
|
Auth0Net.DependencyInjection
Dependency Injection, HttpClientFactory & ASP.NET Core extensions for Auth0.NET |
|
ZiggyCreatures.FusionCache.OpenTelemetry
Add native OpenTelemetry support to FusionCache. |
GitHub repositories (8)
Showing the top 5 popular GitHub repositories that depend on ZiggyCreatures.FusionCache:
Repository | Stars |
---|---|
Azure/data-api-builder
Data API builder provides modern REST and GraphQL endpoints to your Azure Databases and on-prem stores.
|
|
neozhu/CleanArchitectureWithBlazorServer
This is a repository for creating a Blazor Server dashboard application following the principles of Clean Architecture
|
|
TurnerSoftware/CacheTower
An efficient multi-layered caching system for .NET
|
|
ikyriak/IdempotentAPI
A .NET library that handles the HTTP write operations (POST and PATCH) that can affect only once for the given request data and idempotency-key by using an ASP.NET Core attribute (filter).
|
|
JasonBock/Rocks
A mocking library based on the Compiler APIs (Roslyn + Mocks)
|
Version | Downloads | Last updated | |
---|---|---|---|
2.0.0-preview-3 | 1,006 | 12/9/2024 | |
2.0.0-preview-2 | 1,529 | 11/14/2024 | |
2.0.0-preview-1 | 944 | 11/10/2024 | |
1.4.1 | 156,040 | 10/27/2024 | |
1.4.0 | 283,672 | 9/15/2024 | |
1.3.0 | 323,309 | 8/4/2024 | |
1.2.0 | 360,288 | 6/2/2024 | |
1.2.0-preview1 | 892 | 5/19/2024 | |
1.1.0 | 163,382 | 4/24/2024 | |
1.0.0 | 258,479 | 2/29/2024 | |
1.0.0-preview2 | 4,448 | 2/23/2024 | |
1.0.0-preview1 | 1,266 | 2/11/2024 | |
0.26.0 | 137,294 | 2/11/2024 | |
0.25.0 | 6,942 | 2/4/2024 | |
0.25.0-preview1 | 1,376 | 1/14/2024 | |
0.24.0 | 316,389 | 11/12/2023 | |
0.24.0-preview1 | 1,924 | 9/3/2023 | |
0.23.0 | 364,794 | 8/1/2023 | |
0.22.0 | 60,151 | 7/9/2023 | |
0.21.0 | 869,958 | 5/28/2023 | |
0.21.0-preview2 | 1,810 | 5/21/2023 | |
0.21.0-preview1 | 1,769 | 5/1/2023 | |
0.20.0 | 156,616 | 4/8/2023 | |
0.20.0-preview2 | 1,663 | 3/29/2023 | |
0.20.0-preview1 | 1,968 | 3/3/2023 | |
0.19.0 | 168,621 | 2/12/2023 | |
0.18.0 | 112,150 | 12/18/2022 | |
0.17.0 | 18,876 | 12/4/2022 | |
0.16.0 | 20,462 | 11/12/2022 | |
0.15.0 | 225,267 | 10/26/2022 | |
0.14.0 | 10,835 | 10/18/2022 | |
0.13.0 | 109,070 | 8/14/2022 | |
0.12.0 | 8,639 | 7/19/2022 | |
0.11.1 | 2,974 | 7/15/2022 | |
0.11.0 | 3,011 | 7/12/2022 | |
0.10.0 | 160,730 | 5/1/2022 | |
0.10.0-preview1 | 1,644 | 4/23/2022 | |
0.9.0 | 69,434 | 2/17/2022 | |
0.1.10-beta3 | 3,378 | 2/14/2022 | |
0.1.10-beta2 | 1,684 | 2/11/2022 | |
0.1.10-beta1 | 1,629 | 2/9/2022 | |
0.1.10-alpha2 | 1,705 | 1/30/2022 | |
0.1.10-alpha1 | 1,518 | 1/27/2022 | |
0.1.9 | 52,379 | 11/23/2021 | |
0.1.8 | 7,326 | 11/23/2021 | |
0.1.7 | 19,913 | 10/16/2021 | |
0.1.6 | 36,574 | 8/1/2021 | |
0.1.5 | 5,077 | 6/29/2021 | |
0.1.4 | 4,654 | 6/5/2021 | |
0.1.3 | 4,236 | 4/3/2021 | |
0.1.2 | 14,807 | 2/26/2021 | |
0.1.1 | 2,792 | 1/19/2021 | |
0.1.0 | 3,000 | 12/31/2020 |
!!! THIS IS A PREVIEW RELEASE !!!
- Added: Named Caches support
- Added: Builder Pattern support
- Added: CacheKeyPrefix
- Added: Infinity handling
- Added: Custom plugins log levels