RedisExplorer 1.0.0-develop

RedisExplorer

A meta library attempting to offer extended Redis-related features and optimizations to other implementations (such as Microsoft.Extensions.Caching.StackExchangeRedis).

Heavily inspired by / re-uses:

• uses https://github.com/StackExchange/StackExchange.Redis
• uses https://github.com/samcook/RedLock.net
• uses https://github.com/redis/NRedisStack
• re-uses parts of code from Microsoft.Extensions.Caching.StackExchangeRedis
• re-uses parts of code from https://github.com/Remora/Remora.Discord/ and it's caching implementations/abstractions/configuration

Features

• Locks via https://github.com/samcook/RedLock.net
• Configurable caching settings per type based on https://github.com/Remora/Remora.Discord/
• Redis stack support via https://github.com/redis/NRedisStack
• IDistributedCache implementation based on Microsoft's with a bunch of tweaks, especially to atomic get and refresh operation now doing expiration math server-side with a single round-trip
• Additional methods that will handle de/serialization automatically based on configured JsonSerializerSettings
• Every operation is atomic (uses a Lua script)

Description

Library was mainly created to optimize operations done by Microsoft.Extensions.Caching.StackExchangeRedis plus connect a few other libraries together.

The main service implements IDistributedCache and registers itself as such with the DI container (and as it's own interface - IRedisExplorer).

Access to the underlying services is provided through appropriate methods on IRedisExplorer - GetDatabase, GetMultiplexer and their async versions - should you need to do something 'unusual'.

The library uses Lua scripts for every operation it performs so if you're using a proxy the library will try to perform an optimized approach to utilizing scripts - every operation will be attempted directly with a SHA1 of the script (EVALSHA) instead of allowing StackExchange.Redis to decide which way to go about the script, if it fails it will be retried with a full script with NoScriptCache flag. This approach utilizes a kind-of non-documented feature of EVAL command (EVAL caches the script on call - performs a silent SCRIPT LOAD), and should result in an eventual consistency (at some point all nodes will have the script cached and no retries will be performed until the script cache is flushed). You can opt-out of this feature by settings UseBandwidthOptimizationForProxies to false on RedisCacheOptions.

Installation

To register the services use the extension method on IServiceCollection (it's similar to the one provided by Microsoft.Extensions.Caching.StackExchangeRedis):

services.AddRedisExplorer(redisSetupAction);

or if you only need the optimized implementation of IDistributedCache then

services.AddRedisExplorerDistributedCache(redisSetupAction);

These will overwrite any other implementation of IDistributedCache currently registered with the container.

If you wish to configure the JsonSerializerOptions used for de/serializing:

services.Configure<JsonSerializerOptions>(RedisExplorer.JsonOptionsName, yourOptions);

Documentation

Documentation available at https://mikym.github.io/RedisExplorer/