imperugo/StackExchange.Redis.Extensions

imperugo 资料

最近记录的来源活动: 2026年8月3日 13:14

SkillsMP 收录数据更新: 2026年10月17日 00:09

已收集 skills: 3

GitHub 星标: 628
GitHub Forks: 178

仓库 README

仓库 README 来源：README.md

查看 README 源文件

展开完整 README

# StackExchange.Redis.Extensions **StackExchange.Redis.Extensions** is a library that extends [StackExchange.Redis](https://github.com/StackExchange/StackExchange.Redis), making it easier to work with Redis in .NET applications. It wraps the base library with serialization, connection pooling, and higher-level APIs so you can store and retrieve complex objects without writing boilerplate code. [![CI](https://github.com/imperugo/StackExchange.Redis.Extensions/actions/workflows/ci.yml/badge.svg)](https://github.com/imperugo/StackExchange.Redis.Extensions/actions/workflows/ci.yml) [![CodeQL](https://github.com/imperugo/StackExchange.Redis.Extensions/actions/workflows/codeql.yml/badge.svg)](https://github.com/imperugo/StackExchange.Redis.Extensions/actions/workflows/codeql.yml) [![NuGet](https://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Core.svg?style=flat&label=NuGet)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Core/) ![Tests](https://img.shields.io/badge/tests-1600%2B%20passing-brightgreen) ![.NET](https://img.shields.io/badge/.NET-8%20%7C%209%20%7C%2010-blue) > **AI-Ready:** This library provides an [`llms.txt`](llms.txt) file for AI coding assistants and a Claude Code plugin for configuration, scaffolding, and troubleshooting. > > ```bash > claude plugin add imperugo/StackExchange.Redis.Extensions > ``` > Then use `/redis-configure`, `/redis-scaffold`, or `/redis-diagnose` in Claude Code. ## Features - Store and retrieve complex .NET objects with automatic serialization - Multiple serialization providers (System.Text.Json, Newtonsoft, Protobuf, MsgPack, MemoryPack, and more) - Connection pooling with LeastLoaded and RoundRobin strategies - Pub/Sub messaging with typed handlers - Hash operations with per-field expiry (Redis 7.4+) - GeoSpatial indexes (GEOADD, GEOSEARCH, GEODIST, etc.) - Redis Streams with consumer group support - Set, List, and Sorted Set operations with Set Combine (union, intersect, diff) - HyperLogLog for probabilistic cardinality estimation - Distributed locking with IAsyncDisposable auto-release - Bitmap operations for analytics and feature flags - Lua scripting for atomic server-side operations - Key tagging and search - Key management (rename, type, dump/restore) - Atomic counters (StringIncrement/StringDecrement) - Transparent compression (GZip, Brotli, LZ4, Snappy, Zstandard) - `IDistributedCache` adapter (Microsoft-compatible Hash schema) - ASP.NET Core Health Check for connection pool monitoring - Azure Managed Identity support - ASP.NET Core integration with DI and .NET 8+ Keyed Services - Multiple named Redis instances with `[FromKeyedServices]` support - OpenTelemetry integration - .NET Standard 2.1, .NET 8, .NET 9, .NET 10 ## Architecture ```mermaid graph TB App[Your Application] --> DI[ASP.NET Core DI] DI --> Factory[IRedisClientFactory] Factory --> Client1[IRedisClient - Default] Factory --> Client2[IRedisClient - Named] Client1 --> DB[IRedisDatabase] DB --> Pool[Connection Pool Manager] Pool --> C1[Connection 1] Pool --> C2[Connection 2] Pool --> C3[Connection N...] DB --> Ser[ISerializer] Ser --> Comp[CompressedSerializer?] Comp --> Inner[System.Text.Json / Newtonsoft / ...] C1 --> Redis[(Redis Server)] C2 --> Redis C3 --> Redis ``` ## Quick Start ### 1. Install packages ```bash dotnet add package StackExchange.Redis.Extensions.Core dotnet add package StackExchange.Redis.Extensions.System.Text.Json dotnet add package StackExchange.Redis.Extensions.AspNetCore ``` ### 2. Configure in `appsettings.json` ```json { "Redis": { "Password": "", "AllowAdmin": true, "Ssl": false, "ConnectTimeout": 5000, "SyncTimeout": 5000, "Database": 0, "Hosts": [ { "Host": "localhost", "Port": 6379 } ], "PoolSize": 5, "IsDefault": true } } ``` ### 3. Register in DI ```csharp var redisConfig = builder.Configuration.GetSection("Redis").Get<RedisConfiguration>(); builder.Services.AddStackExchangeRedisExtensions<SystemTextJsonSerializer>(redisConfig); ``` ### 4. Use it ```csharp public class MyService(IRedisDatabase redis) { public async Task Example() { // Store an object await redis.AddAsync("user:1", new User { Name = "Ugo", Age = 38 }); // Retrieve it var user = await redis.GetAsync<User>("user:1"); // Store with expiry await redis.AddAsync("session:abc", sessionData, TimeSpan.FromMinutes(30)); // Bulk operations var items = new[] { Tuple.Create("key1", "value1"), Tuple.Create("key2", "value2"), }; await redis.AddAllAsync(items, TimeSpan.FromHours(1)); // Search keys var keys = await redis.SearchKeysAsync("user:*"); } } ``` ## NuGet Packages ### Core | Package | Description | NuGet | |---------|------------|-------| | Core | Core library with abstractions and implementations | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Core.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Core/) | | AspNetCore | ASP.NET Core DI integration and middleware | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.AspNetCore.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.AspNetCore/) | ### Serializers (pick one) | Package | Description | NuGet | |---------|------------|-------| | System.Text.Json | Recommended for most scenarios | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.System.Text.Json.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.System.Text.Json/) | | Newtonsoft | JSON.NET for legacy compatibility | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Newtonsoft.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Newtonsoft/) | | MemoryPack | High-performance binary (net7.0+) | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.MemoryPack.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.MemoryPack/) | | MsgPack | MessagePack binary format | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.MsgPack.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.MsgPack/) | | Protobuf | Protocol Buffers | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Protobuf.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Protobuf/) | | Utf8Json | UTF-8 native JSON | [![NuGet](http://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Utf8Json.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Utf8Json/) | ### Compressors (optional) | Package | Algorithm | Best for | NuGet | |---------|----------|----------|-------| | Compression.LZ4 | LZ4 | Lowest latency | [![NuGet](https://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Compression.LZ4.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Compression.LZ4/) | | Compression.Snappier | Snappy | Low latency | [![NuGet](https://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Compression.Snappier.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Compression.Snappier/) | | Compression.ZstdSharp | Zstandard | Best ratio/speed | [![NuGet](https://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Compression.ZstdSharp.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Compression.ZstdSharp/) | | Compression.GZip | GZip | Wide compatibility | [![NuGet](https://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Compression.GZip.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Compression.GZip/) | | Compression.Brotli | Brotli | Best ratio for text | [![NuGet](https://img.shields.io/nuget/v/StackExchange.Redis.Extensions.Compression.Brotli.svg?style=flat)](https://www.nuget.org/packages/StackExchange.Redis.Extensions.Compression.Brotli/) | ## Usage Examples ### Hash Operations ```csharp // Set a hash field await redis.HashSetAsync("user:1", "name", "Ugo"); await redis.HashSetAsync("user:1", "email", "ugo@example.com"); // Get a hash field var name = await redis.HashGetAsync<string>("user:1", "name"); // Set with per-field expiry (Redis 7.4+) await redis.HashSetWithExpiryAsync("user:1", "session", sessionData, TimeSpan.FromMinutes(30)); // Query field TTL var ttl = await redis.HashFieldGetTimeToLiveAsync("user:1", new[] { "session" }); ``` ### GeoSpatial ```csharp // Add locations await redis.GeoAddAsync("restaurants", new[] { new GeoEntry(13.361389, 38.115556, "Pizzeria Da Michele"), new GeoEntry(15.087269, 37.502669, "Trattoria del Corso"), new GeoEntry(12.496366, 41.902782, "Da Enzo al 29"), }); // Distance between two places var km = await redis.GeoDistanceAsync("restaurants", "Pizzeria Da Michele", "Trattoria del Corso", GeoUnit.Kilometers); // Search within 200km of a point var nearby = await redis.GeoSearchAsync("restaurants", 13.361389, 38.115556, new GeoSearchCircle(200, GeoUnit.Kilometers), count: 10, order: Order.Ascending); ``` ### Redis Streams ```csharp // Publish typed events await redis.StreamAddAsync("orders", "payload", new Order { Id = 1, Total = 99.99m }); // Consumer group workflow await redis.StreamCreateConsumerGroupAsync("orders", "processors"); var entries = await redis.StreamReadGroupAsync("orders", "processors", "worker-1"); foreach (var entry in entries) { // Process the message await redis.StreamAcknowledgeAsync("orders", "processors", entry.Id!); } ``` ### Pub/Sub ```csharp // Subscribe to typed messages await redis.SubscribeAsync<OrderEvent>("orders:new", async order => { Console.WriteLine($"New order: {order.Id}"); }); // Publish await redis.PublishAsync("orders:new", new OrderEvent { Id = 42 }); ``` ### Atomic Counters ```csharp // Increment/decrement with long (default step = 1) var views = await redis.StringIncrementAsync("page:views"); var stock = await redis.StringDecrementAsync("product:123:stock"); // Custom step await redis.StringIncrementAsync("stats:bytes", 1024); // Double precision await redis.StringIncrementAsync("account:balance", 49.99); ``` ### Set Operations ```csharp // Combine sets: union, intersect, difference var allTags = await redis.SetCombineAsync<string>(SetOperation.Union, "user:1:tags", "user:2:tags"); var commonTags = await redis.SetCombineAsync<string>(SetOperation.Intersect, "user:1:tags", "user:2:tags"); // Store result in a new key await redis.SetCombineAndStoreAsync(SetOperation.Union, "all:tags", new[] { "set:a", "set:b", "set:c" }); ``` ### HyperLogLog ```csharp // Count unique visitors await redis.HyperLogLogAddAsync("page:home:visitors", userId); var uniqueCount = await redis.HyperLogLogLengthAsync("page:home:visitors"); // Merge daily counts into a monthly aggregate await redis.HyperLogLogMergeAsync("visitors:2024:01", new[] { "visitors:2024:01:01", "visitors:2024:01:02", "visitors:2024:01:03", }); ``` ### Distributed Lock ```csharp // Acquire a lock with automatic release on dispose await using var lockObj = await redis.LockAcquireAsync( "resource:order:123", expiry: TimeSpan.FromSeconds(30), maxRetries: 5, retryDelay: TimeSpan.FromMilliseconds(200)); if (lockObj is not null) { // Critical section — lock is held await ProcessOrder(123); } // Lock released automatically on dispose ``` ### Bitmap Operations ```csharp // Track daily active users (1 bit per user ID) await redis.StringSetBitAsync("dau:2024-01-15", userId, true); // Count active users var activeCount = await redis.StringBitCountAsync("dau:2024-01-15"); // Compute users active on ALL days (AND operation) await redis.StringBitOperationAsync(Bitwise.And, "wau:all-days", new[] { "dau:2024-01-15", "dau:2024-01-16", "dau:2024-01-17", }); ``` ### Lua Scripting ```csharp // Atomic server-side operations var script = @" local current = tonumber(redis.call('GET', KEYS[1]) or '0') if current < tonumber(ARGV[1]) then return redis.call('INCR', KEYS[1]) end return current"; var result = await redis.ScriptEvaluateAsync( script, new RedisKey[] { "counter:views" }, new RedisValue[] { 100 }); ``` ### Key Management ```csharp // Rename a key await redis.KeyRenameAsync("old-key", "new-key"); // Check key type var type = await redis.KeyTypeAsync("my-key"); // RedisType.String, Set, Hash, ... // Dump and restore (migrate between databases) var dump = await redis.KeyDumpAsync("my-key"); await redis.KeyRestoreAsync("my-key-copy", dump, TimeSpan.FromHours(1)); ``` ### IDistributedCache ```csharp // Register the IDistributedCache adapter (call after AddStackExchangeRedisExtensions) builder.Services.AddStackExchangeRedisExtensions<SystemTextJsonSerializer>(redisConfig); builder.Services.AddRedisDistributedCache(); // Use standard IDistributedCache anywhere public class MyService(IDistributedCache cache) { public async Task CacheData() { await cache.SetAsync("session:abc", data, new DistributedCacheEntryOptions { SlidingExpiration = TimeSpan.FromMinutes(20), AbsoluteExpirationRelativeToNow = TimeSpan.FromHours(4), }); var cached = await cache.GetAsync("session:abc"); } } ``` > **Note:** Uses a Hash-based schema (`data`/`absexp`/`sldexp`) compatible with `Microsoft.Extensions.Caching.StackExchangeRedis`, enabling zero-downtime migration between providers. ### Health Check ```csharp // Register the health check builder.Services.AddHealthChecks() .AddRedisExtensionsHealthCheck(); // Returns: // - Healthy: all pool connections active + PING OK // - Degraded: some connections invalid but Redis responding // - Unhealthy: all connections invalid or PING fails ``` ### Keyed DI Services (.NET 8+) ```csharp // Register with named configurations builder.Services.AddStackExchangeRedisExtensions<SystemTextJsonSerializer>(new[] { new RedisConfiguration { Name = "cache", IsDefault = true, /* ... */ }, new RedisConfiguration { Name = "session", /* ... */ }, }); // Inject by name using [FromKeyedServices] public class MyService( [FromKeyedServices("cache")] IRedisDatabase cacheDb, [FromKeyedServices("session")] IRedisDatabase sessionDb) { // Each resolves to its own Redis instance with isolated connection pool } ``` ### Compression ```csharp // Enable transparent compression with any serializer services.AddStackExchangeRedisExtensions<SystemTextJsonSerializer>(config); services.AddRedisCompression<LZ4Compressor>(); // That's it! // All operations automatically compress/decompress await redis.AddAsync("large-data", myLargeObject); // stored compressed var obj = await redis.GetAsync<MyObject>("large-data"); // decompressed automatically ``` ### Azure Managed Identity ```csharp var config = new RedisConfiguration { /* ... */ }; config.ConfigurationOptionsAsyncHandler = async opts => { await opts.ConfigureForAzureWithTokenCredentialAsync(new DefaultAzureCredential()); return opts; }; ``` ## Connection Pooling ```mermaid graph LR subgraph Pool["Connection Pool (PoolSize=5)"] C1["Connection 1 Outstanding: 3"] C2["Connection 2 Outstanding: 0"] C3["Connection 3 Outstanding: 7"] C4["Connection 4 Outstanding: 1"] C5["Connection 5 Outstanding: 2"] end Op["GetConnection()"] -->|LeastLoaded| C2 Op -->|RoundRobin| C4 style C2 fill:#90EE90 style C4 fill:#87CEEB ``` The pool automatically skips disconnected connections and falls back gracefully when all connections are down, letting StackExchange.Redis's internal reconnection logic recover. | Strategy | Behavior | |----------|----------| | `LeastLoaded` (default) | Picks the connected connection with fewest outstanding commands | | `RoundRobin` | Random selection among connected connections | ## Serialization Behavior All values stored in Redis go through the configured `ISerializer`. This means: - A `string` value `"hello"` is stored as `"\"hello\""` (JSON-encoded) - Use `IRedisDatabase.Database` for raw Redis operations without serialization - All serializers follow the same convention: `null` input produces an empty byte array ## Configuration Reference | Property | Default | Description | |----------|---------|-------------| | `Hosts` | Required | Redis server endpoints | | `Password` | `null` | Redis password | | `Database` | `0` | Database index | | `Ssl` | `false` | Enable TLS | | `PoolSize` | `5` | Number of connections in the pool | | `ConnectionSelectionStrategy` | `LeastLoaded` | Pool selection strategy | | `SyncTimeout` | `5000` | Sync operation timeout (ms) | | `ConnectTimeout` | `5000` | Connection timeout (ms) | | `KeyPrefix` | `""` | Prefix for all keys and channels | | `AllowAdmin` | `false` | Enable admin commands | | `ClientName` | `null` | Connection client name | | `KeepAlive` | `-1` | Heartbeat interval (seconds). -1 = SE.Redis default, 0 = disabled | | `ServiceName` | `null` | Sentinel service name | | `MaxValueLength` | `0` | Max serialized value size (0 = unlimited) | | `WorkCount` | `CPU*2` | I/O threads per SocketManager | | `ConnectRetry` | `null` | Connection retry count | | `CertificateValidation` | `null` | TLS certificate validation callback | | `CertificateSelection` | `null` | TLS client certificate selection callback | | `ConfigurationOptionsAsyncHandler` | `null` | Async callback for custom ConfigurationOptions setup (e.g. Azure) | ## Documentation Full documentation is available in the [doc/](doc/) folder: **Getting Started** - [Setup & Installation](doc/setup-1.md) - [Dependency Injection](doc/dependency-injection.md) - [ASP.NET Core Integration](doc/asp.net-core/README.md) **Configuration** - [Configuration Overview](doc/configuration/README.md) — [JSON](doc/configuration/json-configuration.md) | [C#](doc/configuration/c-configuration.md) | [Connection Pool](doc/configuration/connection-pool.md) **Serializers** - [Serializers Overview](doc/serializers/README.md) — [System.Text.Json](doc/serializers/system.text.json.md) | [Newtonsoft](doc/serializers/newtonsoft-json.net.md) | [MemoryPack](doc/serializers/memoryPack.md) | [MsgPack](doc/serializers/msgpack.md) | [Protobuf](doc/serializers/protobuf.md) **Features** - [Usage Guide](doc/usage/README.md) — Add, Get, Replace, Bulk operations - [GeoSpatial Indexes](doc/geospatial.md) - [VectorSet — AI/ML Similarity Search](doc/vectorset.md) (Redis 8.0+) - [Redis Streams](doc/streams.md) - [Pub/Sub Messaging](doc/pubsub.md) - [HyperLogLog](doc/hyperloglog.md) — Probabilistic cardinality estimation - [Distributed Lock](doc/distributed-lock.md) — Redis-based locking with IAsyncDisposable - [Bitmap Operations](doc/bitmap.md) — Bit-level analytics and feature flags - [Lua Scripting](doc/scripting.md) — Server-side script execution - [Hash Field Expiry](doc/hash-field-expiry.md) (Redis 7.4+) - [Compression](doc/compressors.md) — GZip, Brotli, LZ4, Snappy, Zstandard - [Health Check](doc/health-check.md) - [IDistributedCache Adapter](doc/distributed-cache.md) **Advanced** - [Migration Guide: v12 → v13](doc/migration-v12-to-v13.md) - [Migration Guide: v11 → v12](doc/migration-v11-to-v12.md) - [Logging & Diagnostics](doc/logging.md) - [Multiple Redis Servers](doc/multipleServers.md) — including Keyed DI Services - [Azure Managed Identity](doc/azure-managed-identity.md) - [OpenTelemetry](doc/openTelemetry.md) - [Redis Information Middleware](doc/asp.net-core/expose-redis-information.md) - [NuGet Packages](doc/packages.md) ## Contributing Thanks to all the people who already contributed! <a href="https://github.com/imperugo/StackExchange.Redis.Extensions/graphs/contributors"> <img src="https://contributors-img.web.app/image?repo=imperugo/StackExchange.Redis.Extensions" /> </a> Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request. PRs target the **master** branch only. ## License StackExchange.Redis.Extensions is Copyright © [Ugo Lattanzi](https://www.linkedin.com/in/imperugo/) and other contributors under the [MIT license](LICENSE).

正在加载仓库 README…

这个仓库中的 skills

软件开发工程师

1 个职业分类 · 已分类 100%

skill

职业分类

描述

更新

redis-diagnose

软件开发工程师

Troubleshoot common StackExchange.Redis.Extensions issues — timeouts, connection failures, serialization problems, pool exhaustion, distributed locks, Lua scripting

原文语言：英语

2026-08-03

redis-scaffold

软件开发工程师

Generate code patterns for StackExchange.Redis.Extensions — Streams, Geo, VectorSet, Hash, Pub/Sub, Sets, HyperLogLog, Lock, Bitmap, Scripting, Compression

原文语言：英语

2026-08-03

redis-configure

软件开发工程师

Generate StackExchange.Redis.Extensions configuration and DI registration from natural language requirements

原文语言：英语

2026-07-01

已展示 3 / 3 个已收集 Skill。

用 AI 助手安装

复制这段 Prompt，发给你正在使用的 AI 助手。

Follow https://skillsmp.com/skill-install/prompt.md to install Agent Skills from https://github.com/imperugo/StackExchange.Redis.Extensions.