ServiceStack.Redis.Extension.AspNetCore 1.1.1

Distributed cache implementation of ServiceStack.Redis.Core for ASP.NET Core

Install-Package ServiceStack.Redis.Extension.AspNetCore -Version 1.1.1
dotnet add package ServiceStack.Redis.Extension.AspNetCore --version 1.1.1
<PackageReference Include="ServiceStack.Redis.Extension.AspNetCore" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ServiceStack.Redis.Extension.AspNetCore --version 1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ServiceStack.Redis.Extension.AspNetCore, 1.1.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ServiceStack.Redis.Extension.AspNetCore as a Cake Addin
#addin nuget:?package=ServiceStack.Redis.Extension.AspNetCore&version=1.1.1

// Install ServiceStack.Redis.Extension.AspNetCore as a Cake Tool
#tool nuget:?package=ServiceStack.Redis.Extension.AspNetCore&version=1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ServiceStack.Redis.Extension.AspNetCore

Distributed cache implementation of ServiceStack.Redis.Core

Install Package

https://www.nuget.org/packages/ServiceStack.Redis.Extension.AspNetCore

Configure

Startup.cs

Single Server

public void ConfigureServices(IServiceCollection services)
{
    services.AddDistributedServiceStackRedisCache(options =>
    {
        // default single server: 127.0.0.1:6379
        // services.AddServiceStackRedisCache();
        
        // customize single server
        services.AddServiceStackRedisCache(options =>{
        	options.SingleServer = "123456@127.0.0.1:6379";
        });
    }
                                                  
    services.AddControllers();
}

Read and write separation

public void ConfigureServices(IServiceCollection services)
{
    services.AddServiceStackRedisCache(options =>
    {
        options.ReadWriteServers = new[]
        {
            "192.168.1.1:6379", "123456@192.168.1.2:6379", "123456@192.168.1.3:6379", "123456@192.168.1.4:6379"
        };
        options.ReadOnlyServers = new[]
        {
            "192.168.1.1:6379", "123456@192.168.1.3:6379"
        };
    });

    services.AddControllers();
}

Load from configuration

public void ConfigureServices(IServiceCollection services)
{
   
services.AddServiceStackRedisCache(Configuration.GetSection("ServiceStackRedisOptions"));

    services.AddControllers();
}

appsettings.Development.json

{
  "ServiceStackRedisOptions": {
    "SingleServer": "1234546@127.0.0.1:6379"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

appsetting.json

{
  "ServiceStackRedisOptions": {
    "ReadWriteServers": ["192.168.1.1:6379", "123456@192.168.1.2:6379", "123456@192.168.1.3:6379", "123456@192.168.1.4:6379"],
    "ReadOnlyServers": ["192.168.1.1:6379", "123456@192.168.1.3:6379"] 
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

ServiceStack.Redis Options

public class ServiceStackRedisOptions
{
    /// <summary>
    ///     单机的地址,例如:127.0.0.1:6379(默认值)。如果你只用到一个Redis服务端,那么配置此项即可。
    /// </summary>
    public string SingleServer { get; set; } = "127.0.0.1:6379";

    /// <summary>
    ///     读写的地址,例如:{ "192.168.1.1:6379","123456@192.168.1.2:6379","123456@192.168.1.3:6379","123456@192.168.1.4:6379" }
    /// </summary>
    public string[] ReadWriteServers { get; set; }

    /// <summary>
    ///     只读地址,例如:{ "192.168.1.1:6379","123456@192.168.1.3:6379" }
    /// </summary>
    public string[] ReadOnlyServers { get; set; }

    /// <summary>
    ///     MaxWritePoolSize写的频率比读低。默认值 8
    /// </summary>
    public int MaxWritePoolSize { get; set; } = 8;

    /// <summary>
    ///     MaxReadPoolSize读的频繁比较多。默认值 12,Redis官方声明最大连接数为1W,但是连接数要控制。
    /// </summary>
    public int MaxReadPoolSize { get; set; } = 12;

    /// <summary>
    ///     连接最大的空闲时间。默认值 60,Redis官方默认是240
    /// </summary>
    public int IdleTimeOutSecs { get; set; } = 60;

    /// <summary>
    ///     连接超时时间,毫秒。默认值 6000
    /// </summary>
    public int ConnectTimeout { get; set; } = 6000;

    /// <summary>
    ///     数据发送超时时间,毫秒。默认值 6000
    /// </summary>
    public int SendTimeout { get; set; } = 6000;

    /// <summary>
    ///     数据接收超时时间,毫秒。默认值 6000
    /// </summary>
    public int ReceiveTimeout { get; set; } = 6000;

    /// <summary>
    ///     连接池取链接的超时时间,毫秒。默认值 6000
    /// </summary>
    public int PoolTimeout { get; set; } = 6000;

    /// <summary>
    ///     默认的数据库。默认值 0,Redis官方默认也是0
    /// </summary>
    public long DefaultDb { get; set; } = 0;
}

Usage

WeatherForecastController.cs

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;
    private readonly IServiceStackRedisCache _redisCache;

    public WeatherForecastController(ILogger<WeatherForecastController> logger, IServiceStackRedisCache redisCache)
    {
        _logger = logger;
        this._redisCache = redisCache;
    }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        var array = _redisCache.Get<WeatherForecast[]>("WeatherForecast");
        if (array == null)
        {
            var rng = new Random();
            array = Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            }).ToArray();

            // Cache for 30 minutes
            _redisCache.Set("WeatherForecast", array, 60 * 1 * 30);
        }

        return array;
    }
}

ServiceStack.Redis.Extension.AspNetCore

Distributed cache implementation of ServiceStack.Redis.Core

Install Package

https://www.nuget.org/packages/ServiceStack.Redis.Extension.AspNetCore

Configure

Startup.cs

Single Server

public void ConfigureServices(IServiceCollection services)
{
    services.AddDistributedServiceStackRedisCache(options =>
    {
        // default single server: 127.0.0.1:6379
        // services.AddServiceStackRedisCache();
        
        // customize single server
        services.AddServiceStackRedisCache(options =>{
        	options.SingleServer = "123456@127.0.0.1:6379";
        });
    }
                                                  
    services.AddControllers();
}

Read and write separation

public void ConfigureServices(IServiceCollection services)
{
    services.AddServiceStackRedisCache(options =>
    {
        options.ReadWriteServers = new[]
        {
            "192.168.1.1:6379", "123456@192.168.1.2:6379", "123456@192.168.1.3:6379", "123456@192.168.1.4:6379"
        };
        options.ReadOnlyServers = new[]
        {
            "192.168.1.1:6379", "123456@192.168.1.3:6379"
        };
    });

    services.AddControllers();
}

Load from configuration

public void ConfigureServices(IServiceCollection services)
{
   
services.AddServiceStackRedisCache(Configuration.GetSection("ServiceStackRedisOptions"));

    services.AddControllers();
}

appsettings.Development.json

{
  "ServiceStackRedisOptions": {
    "SingleServer": "1234546@127.0.0.1:6379"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

appsetting.json

{
  "ServiceStackRedisOptions": {
    "ReadWriteServers": ["192.168.1.1:6379", "123456@192.168.1.2:6379", "123456@192.168.1.3:6379", "123456@192.168.1.4:6379"],
    "ReadOnlyServers": ["192.168.1.1:6379", "123456@192.168.1.3:6379"] 
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

ServiceStack.Redis Options

public class ServiceStackRedisOptions
{
    /// <summary>
    ///     单机的地址,例如:127.0.0.1:6379(默认值)。如果你只用到一个Redis服务端,那么配置此项即可。
    /// </summary>
    public string SingleServer { get; set; } = "127.0.0.1:6379";

    /// <summary>
    ///     读写的地址,例如:{ "192.168.1.1:6379","123456@192.168.1.2:6379","123456@192.168.1.3:6379","123456@192.168.1.4:6379" }
    /// </summary>
    public string[] ReadWriteServers { get; set; }

    /// <summary>
    ///     只读地址,例如:{ "192.168.1.1:6379","123456@192.168.1.3:6379" }
    /// </summary>
    public string[] ReadOnlyServers { get; set; }

    /// <summary>
    ///     MaxWritePoolSize写的频率比读低。默认值 8
    /// </summary>
    public int MaxWritePoolSize { get; set; } = 8;

    /// <summary>
    ///     MaxReadPoolSize读的频繁比较多。默认值 12,Redis官方声明最大连接数为1W,但是连接数要控制。
    /// </summary>
    public int MaxReadPoolSize { get; set; } = 12;

    /// <summary>
    ///     连接最大的空闲时间。默认值 60,Redis官方默认是240
    /// </summary>
    public int IdleTimeOutSecs { get; set; } = 60;

    /// <summary>
    ///     连接超时时间,毫秒。默认值 6000
    /// </summary>
    public int ConnectTimeout { get; set; } = 6000;

    /// <summary>
    ///     数据发送超时时间,毫秒。默认值 6000
    /// </summary>
    public int SendTimeout { get; set; } = 6000;

    /// <summary>
    ///     数据接收超时时间,毫秒。默认值 6000
    /// </summary>
    public int ReceiveTimeout { get; set; } = 6000;

    /// <summary>
    ///     连接池取链接的超时时间,毫秒。默认值 6000
    /// </summary>
    public int PoolTimeout { get; set; } = 6000;

    /// <summary>
    ///     默认的数据库。默认值 0,Redis官方默认也是0
    /// </summary>
    public long DefaultDb { get; set; } = 0;
}

Usage

WeatherForecastController.cs

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;
    private readonly IServiceStackRedisCache _redisCache;

    public WeatherForecastController(ILogger<WeatherForecastController> logger, IServiceStackRedisCache redisCache)
    {
        _logger = logger;
        this._redisCache = redisCache;
    }

    [HttpGet]
    public IEnumerable<WeatherForecast> Get()
    {
        var array = _redisCache.Get<WeatherForecast[]>("WeatherForecast");
        if (array == null)
        {
            var rng = new Random();
            array = Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            }).ToArray();

            // Cache for 30 minutes
            _redisCache.Set("WeatherForecast", array, 60 * 1 * 30);
        }

        return array;
    }
}

Release Notes

Remove 6000 requests per hour restrictions for multi-version

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.1.1 486 12/11/2020
1.1.0 243 12/5/2020
1.0.3 178 11/21/2020
1.0.2 179 11/21/2020