Skip to main content

Redis Cache Implementation In .NetCore Web API Using Distributed Caching Technique(Redis Docker Instance)

Redis Cache:

Redis is an open-source in-memory data structure store, used as a database, cache. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, etc.

Setup Redis Docker Instance:

For this sample to use Redis instance locally we will use Docker. If you don't have any prior knowledge of docker, not a problem just follow the steps below. Click here for a video session on Redis docker setup
Note:
Skip this section if you already have redis direct instance or azure or any cloud provider that have redis
Step1:
Download docker into our local system "https://docs.docker.com/desktop/". Docker was available for all desktop operating systems.
Step2:
After downloading the docker installer, then install it. Now to run any docker containers(eg: Redis, MongoDB, PostgreSQL, etc) this docker instance we just installed should be active(should be running).
Step3:
Now we need to pull the docker Redis image from the docker hub "https://hub.docker.com/_/redis".
Command To Pull Redis Image:
docker pull redis
Step4:
The final step to run the docker Redis image container by mapping our local system port. By default, the Redis instance runs with the '6379' default port inside of the docker container. So to access the Redis we need to port mapping on starting off the container.
Command To Start Redis Container:
docker run --name your_containerName -p your_PortNumber:6379 -d redis
The '--name your_containerName' flag to specify the Redis container name. The '-p your_PortNumber:6379' mapping the Redis port '6379' to our local machine port all our application will use local machine port to communicate with Redis. The '-d' flag represents to run the container in the detached mode which means run in the background. At the last of the command 'redis' to specify the image to run in our container.
Step5:
After creating a docker container, it will be stored in our local machine so to start again the container any time run the following command
docker start your_container_name

Step6:(Optional Step)
Let test our Redis instance

Command To Use Redis CLI
docker exec -it your_docker_container_name redis-cli

Create A Sample API Project:

Let's understand the flow of Redis cache by implementing a sample API application.

Install StackExchange.Redis Package:

Package Manager:
Install-Package Microsoft.Extensions.Caching.StackExchangeRedis
CLI Command:
dotnet add pakcage Microsoft.Extensions.Caching.StackExchangeRedis

Sample Todos Endpoint:

Let's begin by creating a sample 'Todos' endpoint where we are going to integrate Redis cache in upcoming steps.
Controllers/TodosController.cs:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;

namespace Redis.Sample.Api.Controllers
{
  [Route("api/[controller]")]
  [ApiController]
  public class TodosController : ControllerBase
  {
	List<string> todos = new List<string> { "shopping", "Watch Movie", "Gardening" };
	
	[Route("all")]
	public async Task<IActionResult> GetAll()
	{
		List<string> myTodos = todos;
		bool IsCached = false;
		return Ok(new { IsCached, myTodos });
	}
  }
}
  • Here implemented endpoint that returns simple static todos list collection(in a real-time application we have to fetch data from a database, for demo purpose I'm simply using static todos collection). 
  • The 'IsCached' property helps to identify whether data loaded from the cache or not(we will make its value dynamic in upcoming steps)

Configure AddStackExchangeRedisCache Service:

To integrate Redis functionality configure the 'AddStackExchangeRedisCache()' service in startup file.
Startup.cs:(ConfigureServices Method)
services.AddStackExchangeRedisCache(options => {
 options.Configuration = "localhost:5003";
});
  • For 'Configuration' we passed the Redis connection string(Here my docker Redis instance exposed to my machine with port 5003).

IDistributedCache Interface:

IDistributedCache Interface is implemented from the 'Microsoft.Extensions.Caching.Distributed' library. IDistributeCache is not specific to Redis Cache, but it was implemented like generic which supports all kinds of Distributed Cache like Redis, SQL Server Cache, etc. IDistributeCache supports the default dependency inject of .NET Core, so it can be easily injected in the application where ever needed. IDistributedCache Interface holds a set of methods that helps to work with cache, some of the methods like as below.
  • Get, GetAsync, GetStringAsync - fetches the cached data by the key passed to the method.
  • Set, SetAsync, SetStringAsync - saves the data to the cache table with a specific key.
  • Remove, RemoveAsync - removes the cached data with specific to key passed.
Now inject the IDistributedCache interface into our Todos endpoint controller.
Controllers/TodosController.cs:
namespace Redis.Sample.Api.Controllers
{
  [Route("api/[controller]")]
  [ApiController]
  public class TodosController : ControllerBase
  {
    List<string> todos = new List<string> { "shopping", "Watch Movie", "Gardening" };
    private readonly IDistributedCache _distributedCache;
    public TodosController(IDistributedCache distributedCache)
    {
	 _distributedCache = distributedCache;
    }
  }
}

Use SetStringAsync And GetStringAsync:

SetStringAsync - This asynchronous method used to save the string of data with a key for it like a dictionary. If we intended to save any object or collection of an object into Redis then we can serialize them to string and store in the cache.

GetStringAsync - This asynchronous method used to fetch the stored string data from the cache-store using its respective key value.

Let us now store our todos data to Redis cache, so update our endpoint action method as below.
Controllers/TodosController.cs:
[HttpGet]
[Route("all")]
public async Task<IActionResult> GetAll()
{
  List<string> myTodos = new List<string>();
  bool IsCached = false;
  string cachedTodosString = string.Empty;
  cachedTodosString = await _distributedCache.GetStringAsync("_todos");
  if (!string.IsNullOrEmpty(cachedTodosString))
  {
   // loaded data from the redis cache.
   myTodos = JsonSerializer.Deserialize<List<string>>(cachedTodosString);
   IsCached = true;
  }
  else
  {
   // loading from code (in real-time from database)
   // then saving to the redis cache 
   myTodos = todos;
   IsCached = false;
   cachedTodosString = JsonSerializer.Serialize<List<string>>(todos);
   await _distributedCache.SetStringAsync("_todos", cachedTodosString);
  }
  return Ok(new { IsCached, myTodos });
}
  • (Line: 5) The 'myTodos' variable to store our final result of todos collection.
  • (Line: 6)  The 'IsCached' variable indicates data loaded from Redis cache or not. The variable added for understanding purposes.
  • (Line: 8) The 'GetStringAsync('your_key')' method to fetch the value Redis cache based on the key.
  • (Line: 9) Checks data exist in the cache-store.
  • (Line: 12) Since we get string data from the Redis cache, then we need to deserialize them to respective object types.
  • (Line: 15-23) If data doesn't exist in Redis.
  • (Line: 19) Assigning our static todo data to our result variable(in real-time application fetch data from database)
  • (Line: 21) Serializing our todos collection to string.
  • (Line: 22) The 'SetStringAsync('your_key','your_string_value')' method to store data to Redis with respective of the given key.
Now run the application, for the first time data will be loaded directly and store in the Redis cache
Now access endpoint again, now data gets loaded from the Redis cache.
You confirm data storing correctly or not in docker redis-cli.

InstanceName Option:

The 'key' name we used here like '_todos' to store data in Redis cache. In real-time we may build multiple applications that all are going to share Redis cache, in this case, simple key names(eg: '_todos') may get conflicted between the application. So to avoid this kind of issue dotnet provides as a global setting to set a key prefix which is like a namespace. The best value to assign value to a key prefix is the project name.
Startup.cs:
services.AddStackExchangeRedisCache(options => {
  options.Configuration = "localhost:5003";
  options.InstanceName = "Redis.Sample.Api";
});
  • (Line: 3) The 'InstanceName' will be prefixed to every Redis key while saving data and also prefix with the key to fetching the data.

Cache Expiration:

The cache should have an expiry date. To define expiration we have two options which are mandatory for a good coding approach.
  • Absolute Expiration.
  • Sliding Expiration.
Absolute Expiration - Maximum time period to store in the cache. After expiration Redis will automatically delete all keys and its values automatically.

Sliding Expiration - Maximum time period to store data without consuming by the applications. If an application not using any particular keys for a specific time it is always good to clear them from the cache before its Absolute Expiration. This type of expiration will be called a Sliding Expiration. One important thing to remember Sliding Expiration always less than Absolute Expiration time. If you set Sliding Expiration more than Absolute Expiration id doesn't make any sense because data will be cleared after the Absolute Expiration time.
Controllers/TodosController.cs:
[HttpGet]
[Route("all")]
public async Task<IActionResult> GetAll()
{
  List<string> myTodos = new List<string>();
  bool IsCached = false;
  string cachedTodosString = string.Empty;
  cachedTodosString = await _distributedCache.GetStringAsync("_todos");
  if (!string.IsNullOrEmpty(cachedTodosString))
  {
   // loaded data from the redis cache.
   myTodos = JsonSerializer.Deserialize<List<string>>(cachedTodosString);
   IsCached = true;
  }
  else
  {
   // loading from code (in real-time from database)
   // then saving to the redis cache 
   myTodos = todos;
   IsCached = false;
   cachedTodosString = JsonSerializer.Serialize<List<string>>(todos);
   var expiryOptions = new DistributedCacheEntryOptions()
   {
	AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(60),
	SlidingExpiration = TimeSpan.FromSeconds(30)
   };
   await _distributedCache.SetStringAsync("_todos", cachedTodosString, expiryOptions);
  }
  return Ok(new { IsCached, myTodos });
}
  • (Line: 22-26) Creating 'Absolute Expiration' and 'Sliding Expiration'. The time specified for sliding expiration set less than absolute expiration.
  • (Line: 27) The 'SetStringAsync()' method is an overloaded method that takes expiration configuration as an input value.

Remove Cache:

It is always good to have an endpoint to clear the cache. The 'RemoveAsync' methods will remove our cached data with respect to the key passed to it.
Controllers/TodosController.cs:
[HttpGet]
[Route("clear-cache")]
public async Task<IActionResult> ClearCache(string key)
{
  await _distributedCache.RemoveAsync(key);
  return Ok(new { Message = $"cleared cache for key -{key}" });
}
That's all about the core topics and their implementation for integrating Redis cache into our API.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on setting up a Redis instance using docker and then consuming the Redis cache into our dotnet core API application. I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:

Follow Me:

Comments

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

Endpoint Routing In Asp.Net Core

How Routing Works In  Core 2.1 And Below Versions?: In Asp.Net Core routing is configured using app.UseRouter() or app.UseMvc() middleware. app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); Here in Dotnet Core version 2.1 or below versions on the execution of route middleware request will be navigated appropriate controller matched to the route. An operation or functionality which is dependent on route URL or route values and that need to be implemented before the execution of route middleware can be done by accessing the route path from the current request context as below app.Use(async (context, next) => { if(context.Request.Path.Value.IndexOf("oldvehicle") != -1) { context.Response.Redirect("vehicle"); } else { await next(); } }); app.UseMvc(routes => { routes.MapRoute( name: "vehicleRoute", template: "vehicle", defaul

Asp.Net Core MVC Form Validation Techniques

Introduction: Form validations in any applications are like assures that a valid data is storing on servers. All programing frameworks have their own individual implementations for form validations. In Dotnet Core MVC application server-side validations carried on by the models with the help of Data Annotations and the client-side validations carried by the plugin jQuery Unobtrusive Validation. jQuery Unobtrusive Validation is a custom library developed by Microsoft based on the popular library  jQuery Validate . In this article, we are going to learn how the model validation and client-side validation works in Asp.Net Core MVC Application with sample examples. Getting Started: Let's create an Asp.Net Core MVC application project using preferred editors like Microsoft Visual Studio or Microsoft Visual Studio Code. Here I'm using Visual Studio. Let's create an MVC controller and name it as 'PersonController.cs' and add an action method as bel

NestJS File Upload

In this article, we are going to understand the steps to create a file uploading endpoint in the NestJS application. Key Features In NestJS File Upload: Let us know some key features of NestJS file upload before implementing a sample application. FileInterceptor: The 'FileInterceptor' will be decorated on top of the file upload endpoint. This interceptor will read single file data from the form posted to the endpoint. export declare function FilesInterceptor(fieldName: string, localOptions?: MulterOptions): Type<NestInterceptor>; Here we can observe the 'fieldName' first input parameter this value should be a match with our 'name' attribute value on the form file input field. So our interceptor read our files that are attached to the file input field. Another input parameter of 'MulterOptions' that provides configuration like file destination path, customizing file name, etc. FilesInterceptor: The 'FilesInterceptor' will be decorated on t