ActionCache 0.0.2

ActionCache

• Quickstart
  • Register with IMemoryCache
  • Register with Redis
  • Register both IMemoryCache and Redis
  • Basic Usage
  • Cache Key Creation
  • Cache Eviction

Register with IMemoryCache

Use the AddActionCacheMemory extension method to register IMemoryCache as the cache store. The configuration for MemoryCacheOptions is exposed as an optional parameter.

builder.Services.AddActionCacheMemory();

Register with Redis

Use the AddActionCacheRedis extension method to register Redis as the cache store. The configuration for RedisCacheOptions is exposed as an optional parameter.

builder.Services.AddActionCacheRedis(options => 
    options.Configuration = ...);

Register both IMemoryCache and Redis

The two caches can be combined. The IMemoryCache instance will be checked for a cache hit before Redis.

builder.Services.AddActionCacheMemory();
builder.Services.AddActionCacheRedis(options => 
    options.Configuration = ...);

Basic Usage

Add an ActionCacheAttribute to any controller actions that should be cached. There is a mandatory parameter for the cache namespace which will prefix all entries with whatever is specified.

[HttpPost]
[Route("/")]
[ActionCache(Namespace = "MyNamespace")]
public IActionResult Post() 
{
}

[!IMPORTANT] The current implementation only supports action return types of IActionResult. Specifically, the action filter that populates the cache looks for an OkObjectResult returned from the controller action.

Cache Key Creation

An ActionCacheKeyAttribute can be applied to any parameters. In the case of a complex object, the instance will be serialized as JSON an appended to the cache entry key.

[HttpPost]
[Route("/")]
[ActionCache(Namespace = "MyNamespace")]
public IActionResult Post(
    [ActionCacheKey(Order = 1)]int id, 
    [ActionCacheKey(Order = 2)]DateTime date,
    [ActionCacheKey(Order = 3)]SampleModel model
)
{
}

[!NOTE] Any route data from the request, i.e. the area, controller and action names are also added to the key. This is helpful for the case of automatic cache rehydration which will be part of a future release.

Cache Eviction

An ActionCacheEvictionAttribute can be applied to a controller action. Cache eviction occurs at the namespace level. In the example below, both MyNamespace and MyOtherNamespace would have their entries evicted on a successful execution of the action.

[HttpDelete]
[Route("/")]
[ActionCacheEviction(Namespaces = "MyNamespace, MyOtherNamespace")]
public IActionResult Delete()
{
}