https://github.com/intelligenthack/intelligentcache
A distributed cache backed by Redis
https://github.com/intelligenthack/intelligentcache
Last synced: about 1 year ago
JSON representation
A distributed cache backed by Redis
- Host: GitHub
- URL: https://github.com/intelligenthack/intelligentcache
- Owner: intelligenthack
- License: mit
- Created: 2020-08-11T09:02:32.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T14:48:58.000Z (almost 3 years ago)
- Last Synced: 2024-12-13T03:38:25.186Z (over 1 year ago)
- Language: C#
- Size: 202 KB
- Stars: 18
- Watchers: 6
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Intelligent Cache
This package implements a distributed cache monad ("pattern") and currently supports single and multiple layers of caching, in memory and via Redis.
To use the pattern, you will interact with an object of type ICache, where you can use the following operations:
```c#
// Get something from the cache, on cache fail the Func is called to refresh the value and stored
var foo = myCache.GetSet("foo-cache-key", ()=>{ return foo-from-db(); }, Timespan.FromHours(1) );
// alternatively
// Invalidate the cache, in case we've modified foo in the db so the cache is stale
myCache.Invalidate("foo-cache-key");
```
The `ICache` object can be of different kinds -- we currently offer a memory cache for local caching and a Redis cache for distributed caching. What makes the pattern a monad is that different caches can be *composed* and this allows seamless multilayer caching.
For example, to implement a multilayer cache with a local layer and a Redis layer:
```c#
var memoryCache = new MemoryCache(/* params */);
var redisCache = new RedisCache(/* params */);
var cache = new CompositeCache(memoryCache, redisCache);
```
Note that this cache does not invalidate correctly in a web farm environment: Invalidations will work on the local server and Redis but not the other web farm webservers. In order to propagate invalidation, we introduced two new composable ICache objects: `RedisInvalidationSender` and `RedisInvalidationReceiver`.
In order to create a local cache that invalidates when the remote cache is nuked, you can follow this composition pattern:
```c#
ISubscriber subscriber = GetRedisSubscriber();
var invalidationChannel = "cache-invalidations";
var cache = new CompositeCache(
new RedisInvalidationReceiver(
new MemoryCache(/* arguments */),
subscriber,
invalidationChannel
),
new CompositeCache(
new RedisCache(/* arguments */),
new RedisInvalidationSender(subscriber, invalidationChannel)
)
);
```
Take in account that when a `calculateValue` function returns a `null` value nothing is cached and a `null` value is returned back to the caller.
# Details
- [API Documentation](doc/api-documentation.md)
- [Using with Asp.Net-Core](doc/dotnet-core.md)
- [Architecture](doc/architecture.md)
- [Requirements and best practices](doc/best-practices.md)
# Upgrading from a previous version
This package follows [semantic versioning](https://semver.org/), which means that upgrading to a higher MINOR or PATCH version should always work. Upgrading to a higher MAJOR version will require code changes. Make sure to read the release notes before upgrading.
# Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
# License
This code is released under the MIT license. Please refer to [LICENSE.md](LICENSE.md) for details.