Redis 中文文档

EasyCaching is an open source caching library that contains basic usages and some advanced usages of caching which can help us to handle caching more easily!

CI Build Status


Platform Build Server Master Status Dev Status
:--- :--- :--- :---
Github Action Linux/Windows

Nuget Packages


Package Name Version Downloads
:--- :--- :---
EasyCaching.Core
EasyCaching.InMemory
EasyCaching.Redis
EasyCaching.Memcached
EasyCaching.SQLite
EasyCaching.HybridCache
EasyCaching.CSRedis
EasyCaching.Interceptor.Castle
EasyCaching.Interceptor.AspectCore
EasyCaching.Serialization.MessagePack
EasyCaching.Serialization.Json
EasyCaching.Serialization.Protobuf
EasyCaching.Bus.RabbitMQ
EasyCaching.Bus.Redis
EasyCaching.Bus.CSRedis
EasyCaching.ResponseCaching
EasyCaching.Disk
EasyCaching.LiteDB
EasyCaching.Serialization.SystemTextJson

Basic Usages


Step 1 : Install the package


Choose caching provider that you need and install it via Nuget.

  1. ``` sh
  2. Install-Package EasyCaching.InMemory
  3. Install-Package EasyCaching.Redis
  4. Install-Package EasyCaching.SQLite
  5. Install-Package EasyCaching.Memcached

  7. ```

Step 2 : Configure Startup class


Each caching provider has it's own configuration options.

Here is a sample configuration for InMemory and Redis caching provider.

  1. ``` cs
  2. public class Startup
  3. {
  4.     //...

  6.     public void ConfigureServices(IServiceCollection services)
  7.     {
  8.         //configuration
  9.         services.AddEasyCaching(options =>
  10.         {
  11.             //use memory cache that named default
  12.             options.UseInMemory("default");

  14.             // // use memory cache with your own configuration
  15.             // options.UseInMemory(config =>
  16.             // {
  17.             //     config.DBConfig = new InMemoryCachingOptions
  18.             //     {
  19.             //         // scan time, default value is 60s
  20.             //         ExpirationScanFrequency = 60,
  21.             //         // total count of cache items, default value is 10000
  22.             //         SizeLimit = 100
  23.             //     };
  24.             //     // the max random second will be added to cache's expiration, default value is 120
  25.             //     config.MaxRdSecond = 120;
  26.             //     // whether enable logging, default is false
  27.             //     config.EnableLogging = false;
  28.             //     // mutex key's alive time(ms), default is 5000
  29.             //     config.LockMs = 5000;
  30.             //     // when mutex key alive, it will sleep some time, default is 300
  31.             //     config.SleepMs = 300;
  32.             // }, "m2");

  34.             //use redis cache that named redis1
  35.             options.UseRedis(config =>
  36.             {
  37.                 config.DBConfig.Endpoints.Add(new ServerEndPoint("127.0.0.1", 6379));
  38.             }, "redis1")
  39.             .WithMessagePack()//with messagepack serialization
  40.             ;            
  41.         });    
  42.     }    
  43. }
  44. ```

Step 3 : Write code in your controller


  1. ``` cs
  2. [Route("api/[controller]")]
  3. public class ValuesController : Controller
  4. {
  5.     // //when using single provider
  6.     // private readonly IEasyCachingProvider _provider;
  7.     //when using multiple provider
  8.     private readonly IEasyCachingProviderFactory _factory;

  10.     public ValuesController(
  11.         //IEasyCachingProvider provider,
  12.         IEasyCachingProviderFactory factory
  13.         )
  14.     {
  15.         //this._provider = provider;
  16.         this._factory = factory;
  17.     }

  19.     [HttpGet]
  20.     public string Handle()
  21.     {
  22.         //var provider = _provider;
  23.         //get the provider from factory with its name
  24.         var provider = _factory.GetCachingProvider("redis1");    

  26.         //Set
  27.         provider.Set("demo", "123", TimeSpan.FromMinutes(1));

  29.         //Set Async
  30.         await provider.SetAsync("demo", "123", TimeSpan.FromMinutes(1));                  
  31.     }
  32. }
  33. ```

Documentation


Detailed EasyCaching documentation can be found here.

Extension Libs


EasyCaching.Extensions

EasyCaching.Extensions.EasyCompressor

Examples


See sample

Todo List


See ToDo List

Contributing


Pull requests, issues and commentary!

License