NewLife.Redis.Extensions

NewLife.Redis.Extensions

ASP.NET Core Redis Deep Integration Extensions

NewLife.Redis.Extensions is the official ASP.NET Core integration package for NewLife.Redis, providing out-of-the-box support for IDistributedCache distributed caching, IDataProtection key persistence, and automatic DI registration.

🆕 This is the successor to the deprecated NewLife.Extensions.Caching.Redis (v5.5). If you are using the old package, see the Migration Guide.

Feature Overview

Installation

dotnet add package NewLife.Redis.Extensions

Quick Start

Register Services

using NewLife.Redis.Extensions;

var builder = WebApplication.CreateBuilder(args);

// One-liner: registers FullRedis / IDistributedCache / ICache / ICacheProvider
builder.Services.AddDistributedRedisCache(options =>
{
    options.Server   = "127.0.0.1:6379";
    options.Password = "pass";
    options.Db       = 0;
    options.Prefix   = "myapp:";
});

Using IDistributedCache

public class HomeController : Controller
{
    private readonly IDistributedCache _cache;

    public HomeController(IDistributedCache cache)
    {
        _cache = cache;
    }

    public async Task<IActionResult> Index()
    {
        var value = await _cache.GetStringAsync("greeting");
        if (value == null)
        {
            value = "Hello, Redis!";
            await _cache.SetStringAsync("greeting", value,
                new DistributedCacheEntryOptions { AbsoluteExpirationRelativeToNow = TimeSpan.FromHours(1) });
        }
        return Content(value);
    }
}

Using FullRedis for Complete Redis Access

Since RedisCache inherits from FullRedis, you can use all Redis data structures directly after injection:

public class UserService
{
    private readonly FullRedis _redis;

    public UserService(FullRedis redis)
    {
        _redis = redis;
    }

    public void SaveUser(User user)
    {
        var list = _redis.GetList<User>("users");
        list.Add(user);

        var hash = _redis.GetDictionary<String>("user:" + user.Id);
        hash["Name"]  = user.Name;
        hash["Email"] = user.Email;
    }
}

Data Protection Key Persistence

builder.Services.AddDataProtection()
    .PersistKeysToRedis(redis, "DataProtection-Keys");

For more Redis operations, see the NewLife.Redis main documentation.

Migrating from the Old Package

This is the direct successor to NewLife.Extensions.Caching.Redis (v5.5), offering better architecture and more features:

Migration Steps:

1. Uninstall the old package, install the new one
2. Change namespace: NewLife.Extensions.Caching.Redis → NewLife.Redis.Extensions
3. Switch DI registration: services.AddRedis(configString) → services.AddDistributedRedisCache(options => {...})

Related Links

• NewLife.Redis Main Repository
• NewLife.Redis Documentation (Chinese)
• NuGet Package
• NewLife Team Website