LiteX.Cache.Redis
5.0.0
See the version list below for details.
dotnet add package LiteX.Cache.Redis --version 5.0.0
NuGet\Install-Package LiteX.Cache.Redis -Version 5.0.0
<PackageReference Include="LiteX.Cache.Redis" Version="5.0.0" />
paket add LiteX.Cache.Redis --version 5.0.0
#r "nuget: LiteX.Cache.Redis, 5.0.0"
// Install LiteX.Cache.Redis as a Cake Addin #addin nuget:?package=LiteX.Cache.Redis&version=5.0.0 // Install LiteX.Cache.Redis as a Cake Tool #tool nuget:?package=LiteX.Cache.Redis&version=5.0.0
LiteX Redis Cache
LiteX.Cache.Redis is a redis caching lib which is based on LiteX.Cache.Core and StackExchange.Redis.
When you use this library, it means that you will handle the data of your redis servers. As usual, we will use it as distributed caching.
How to use ?
Install Nuget packages
Run the nuget command for installing the client as,
Install-Package LiteX.Cache.Core
Install-Package LiteX.Cache.Redis
Configuration
AppSettings
{
"RedisConfig": {
"RedisCachingConnectionString": "127.0.0.1:6379,ssl=False",
"PersistDataProtectionKeysToRedis": false
}
}
Startup Configuration
public class Startup
{
public IConfiguration configuration { get; }
public Startup(IConfiguration configuration)
{
this.configuration = configuration;
}
public void ConfigureServices(IServiceCollection services)
{
// 1. Use default configuration from appsettings.json's 'RedisConfig'
services.AddLiteXRedisCache();
//OR
// 2. Load configuration settings using options.
services.AddLiteXRedisCache(option =>
{
option.RedisCachingConnectionString = "127.0.0.1:6379,ssl=False";
});
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var redisConfig = new RedisConfig();
services.AddLiteXRedisCache(redisConfig);
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
}
}
Use in Controller or Business layer
The following code show how to use EasyCachingProvider in ASP.NET Core Web API.
public class CustomerController : Controller
{
#region Fields
private readonly ILiteXCacheManager _cacheManager;
#endregion
#region Ctor
/// <summary>
/// Ctor
/// </summary>
/// <param name="cacheManager"></param>
public CustomerController(ILiteXCacheManager cacheManager)
{
_cacheManager = cacheManager;
}
#endregion
#region Methods
/// <summary>
/// Get a cached item. If it's not in the cache yet, then load and cache it
/// </summary>
/// <returns></returns>
public IActionResult CacheCustomers()
{
IList<Customer> customers;
//cacheable key
var key = "customers";
customers = _cacheManager.Get(key, () =>
{
var result = new List<Customer>();
result = GetCustomers().ToList();
return result;
});
return Ok(customers);
}
/// <summary>
/// Get a cached item. If it's not in the cache yet, then load and cache it
/// </summary>
/// <param name="cacheTime">Cache time in minutes (0 - do not cache)</param>
/// <returns></returns>
public IActionResult CacheCustomers(int cacheTime)
{
IList<Customer> customers;
//cacheable key
var cacheKey = "customers";
customers = _cacheManager.Get(cacheKey, cacheTime, () =>
{
var result = new List<Customer>();
result = GetCustomers().ToList();
return result;
});
return Ok(customers);
}
/// <summary>
/// Get a cached item. If it's not in the cache yet, then load and cache it manually
/// </summary>
/// <param name="customerId"></param>
/// <returns></returns>
public IActionResult CacheCustomer(int customerId)
{
Customer customer = null;
var cacheKey = $"customer-{customerId}";
customer = _cacheManager.Get<Customer>(cacheKey);
if (customer == default(Customer))
{
//no value in the cache yet
//let's load customer and cache the result
customer = GetCustomerById(customerId);
_cacheManager.Set(cacheKey, customer, 60);
}
return Ok(customer);
}
/// <summary>
/// Remove cached item(s).
/// </summary>
/// <returns></returns>
public IActionResult RemoveCachedCustomers()
{
//cacheable key
var cacheKey = "customers";
_cacheManager.Remove(cacheKey);
// OR
var cacheKeyPattern = "customers-";
// remove by pattern
_cacheManager.RemoveByPattern(cacheKeyPattern);
return Ok();
}
#endregion
#region Utilities
private IList<Customer> GetCustomers()
{
IList<Customer> customers = new List<Customer>();
customers.Add(new Customer() { Id = 1, Username = "ashish", Email = "toaashishpatel@outlook.com" });
return customers;
}
private Customer GetCustomerById(int id)
{
Customer customer = null;
customer = GetCustomers().ToList().FirstOrDefault(x => x.Id == id);
return customer;
}
#endregion
}
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- LiteX.Cache.Core (>= 2.0.0)
- Microsoft.Extensions.Configuration (>= 2.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 2.0.0)
- Microsoft.Extensions.DependencyInjection (>= 2.0.0)
- Newtonsoft.Json (>= 11.0.2)
- RedLock.net.StrongName (>= 2.0.0)
- StackExchange.Redis.StrongName (>= 1.2.6)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
9.0.0 | 631 | 1/1/2021 |
8.1.0 | 890 | 4/4/2020 |
8.0.0 | 1,419 | 9/19/2019 |
7.0.3 | 2,166 | 1/31/2019 |
7.0.2 | 1,964 | 8/25/2018 |
7.0.1 | 850 | 8/9/2018 |
7.0.0 | 973 | 6/30/2018 |
6.2.0 | 1,051 | 6/23/2018 |
6.1.0 | 1,037 | 6/18/2018 |
6.0.0 | 1,005 | 6/2/2018 |
5.0.0 | 962 | 5/7/2018 |
4.0.0 | 1,101 | 5/4/2018 |
3.0.0 | 1,079 | 4/25/2018 |
2.0.0 | 1,019 | 4/22/2018 |
1.0.0 | 1,072 | 4/20/2018 |
Core configuration changes.
Advanced configuration options.
Added advanced options (e.g. CacheProviderType, IsDistributedCache)
Bug fixing.