Skip to main content

Use Azure Cache For Redis In AspNetCore Application Using Distributed Cache Technique[.NET6]

In this article, we are going to do a small demo on integrating Azure Redis Cache into the AspNetCore Application using Distributed cache technique.

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, stored sets with range queries, etc.
Let's understand the flow of Redis cache in a web application:
  • Users request a page from the web application.
  • Web application queries the Redis store, if the data exists, then fetches the data and returns the response directly to the user.
  • If no data is in the Redis store, the application queries the database and fetches the data, next save the same data into the Redis store so that subsequent user request can consume the data from the Redis store directly, finally returns the response to the users.

Create A Azure Redis Cache:

Step:1
Create and sign-in into the Azure portal(https://portal.azure.com/)

Step:2
On the Azure portal home page click on 'Create a resource'.
Step:3
On the 'Create a resource' page select the 'Databases' and then select 'Azure Cache for Redis'.
Step4:
(1)On the 'New Redis Cache' page, enter the project details.
  • Subscription- Choose your subscription plan from the dropdown.
  • Resource group - Either create a new resource group or select an existing group from the drop-down.
  • DNS name- Enter the name of your Redis instance subdomain name.
  • Location- Choose your server location from the dropdown.
  • Cache type- Select pricing plans for Redis usage. no free plans on it.
(2)Choose your type of 'Network Connectivity'.
(3)In the 'Advanced' tab you can choose the version of the Redis instance.
(4)The 'Tags', name/value pairs is an optional section.
(5)Finally, select 'Review+ Create', on successful validation, select 'create', on success in a few minutes our Redis instance will be ready.

IDistributedCache Interface:

IDistributedCache interface is implemented from the 'Microsoft.Extensions.Caching.Distributed' library. IDistributedCache 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. IDistributedCache supports the default dependency injection of .NET Core, so it can be easily injected into 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 - fetches the cached data by the key passed.
  • Set, SetAsync - saves the data to the cache-store.
  • Remove, RemoveAsync - removes the cached data specific to key passed.

Create A .NET6 Web API Project:

Let's create a .Net6 Web API sample application to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor.
CLI command
dotnet new webapi -o Your_Project_Name

Install NuGet Package:

Package Manager:
Install-Package Microsoft.Extensions.Caching.StackExchangeRedis -Version 6.0.1

.NET CLI:
dotnet add package Microsoft.Extensions.Caching.StackExchangeRedis --version 6.0.1

Configure Azure Redis ConnectionString:

(1)On the Azure portal home page click on 'Resource groups'.
(2) On the 'Resource groups' page, select the resource group that has our Azure cache for Redis.
(3) Now click 'Azure Cache for Redis' instance.
(4) Now under 'Settings' select 'Access Keys', then copy the connection string either primary or secondary connection string.

Now copied Redis connection string needs to add to our Web API project.
appsettings.Development.json:
  
"ConnectionStrings": {
    "AzureRedisConnection":"Your_Azure_Redis_Connection_Value"
}
Now register the Redis Cache service into the 'Program.cs' file.
Program.cs:
builder.Services.AddStackExchangeRedisCache(options => {
    options.Configuration = builder.Configuration.GetConnectionString("AzureRedisConnection");
});
  • Here registered the 'AddStackExchangeRedisCache' service.
  • The 'Configuration' property is assigned with the Azure Redis connection string value.

Create A Sample API Response Model:

Let's create a sample class that will be our response object model like the 'Car.cs' file in the 'Models' folder.
Models/Cars.cs:
namespace Dot6.AzureRedis.Learn.Models;

public class Car
{
    public int Id { get; set; }
    public int Year { get; set; }
    public string Manufacturer { get; set; }
    public string Model { get; set; }
}

Create A Sample API Controller:

Let's create a sample API controller like 'CarController.cs'.
Controllers/CarController.cs:
using System.Text;
using System.Text.Json;
using Dot6.AzureRedis.Learn.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Caching.Distributed;

namespace Dot6.AzureRedis.Learn.Controllers;

[ApiController]
[Route("[controller]")]
public class CarController : ControllerBase
{
    private readonly List<Car> fakeDatabase = new List<Car>
    {
        new Car
        {
            Id = 1,
            Manufacturer = "Honda",
            Model = "Civic",
            Year = 2021
        },
        new Car
        {
            Id = 2,
            Manufacturer = "Kia",
            Year = 2021,
            Model ="Seltos"
        }
    };
    private readonly IDistributedCache _cache;
    public CarController(IDistributedCache cache)
    {
        _cache = cache;
    }
}
  • (Line: 13-29) The 'fakeDatabase' variable contains mock or test data for our demo, in real-time application data will be fetched from the database.
  • (Line: 31) The 'Microsoft.Extensions.Caching.Distributed.IDistributedCache' interface is injected into the controller.

Use GetAsync And SetAsync:

GetAsync - This asynchronous method fetches the byte array of data from the Redis-store for a specified key.

SetAsync - This asynchronous method saves the byte array of data with a key for it like a dictionary. If we intended to save any object or collection of objects into the Redis-store then we serialize our data to a string, then string to byte array of data.

Let's create a sample API action method that uses our Redis-store.
Controllers/CarController.cs:
[HttpGet]
public async Task<IActionResult> Get()
{
	var carsFromRedis = await _cache.GetAsync("carstore");
	if ((carsFromRedis?.Count() ?? 0) > 0)
	{
		var carsString = Encoding.UTF8.GetString(carsFromRedis);
		var cars = JsonSerializer.Deserialize<List<Car>>(carsString);
		return Ok(new { LoadedFromRedis = true, Data = cars });
	}

	var fakeDatabaseString = JsonSerializer.Serialize(fakeDatabase);
	var fakeDatabaseByteArray = Encoding.UTF8.GetBytes(fakeDatabaseString);
	await _cache.SetAsync("carstore", fakeDatabaseByteArray);
	return Ok(new { LoadedFromRedis = false, Data = fakeDatabase });
}
  • (Line: 4) Using 'GetAsync("key")' trying to fetch byte array of data from the store.
  • (Line: 5) Checking whether we got a response from the Redis store.
  • (Line: 7) Converting the byte array of data into the string.
  • (Line: 8) Converting the string to the collection of 'Car' types.
  • (Line: 9) Returning API response, here for our understanding added a flag property like 'LoadedFromRedis' to our response.
  • (Line: 12) If the data does not exist in the Redis store this line of code starts executing. Here serializing the collection of 'car' types to string.
  • (Line: 13) Converting string result to byte array.
  • (Line: 14) Using 'SetAsync' with help of 'key' and 'value'(byte array of data) stored into the Redis store so that the next client request to API endpoint can return a response directly from Redis store.
Now run the application, for the first request in the response we can observe 'LoadedFromRedis' return a false value.

Now for the second request, the 'LoadedFromRedis' property returns true, which confirms data coming from the Redis-store.

Cache Expiration:

The cache should have an expiry date. To define expiration we have two options that 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 their values automatically.

Sliding Expiration - Maximum time period to store data without consuming by the application. 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 is 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.

Let's update our action method logic to use expiration.
Controllers/CarController.cs:
[HttpGet]
public async Task<IActionResult> Get()
{
	var carsFromRedis = await _cache.GetAsync("carstore");
	if ((carsFromRedis?.Count() ?? 0) > 0)
	{
		var carsString = Encoding.UTF8.GetString(carsFromRedis);
		var cars = JsonSerializer.Deserialize<List<Car>>(carsString);
		return Ok(new { LoadedFromRedis = true, Data = cars });
	}

	var fakeDatabaseString = JsonSerializer.Serialize(fakeDatabase);
	var fakeDatabaseByteArray = Encoding.UTF8.GetBytes(fakeDatabaseString);
	var expiration = new DistributedCacheEntryOptions{
		AbsoluteExpirationRelativeToNow = TimeSpan.FromSeconds(20),
		SlidingExpiration = TimeSpan.FromSeconds(19)
	};
	await _cache.SetAsync("carstore", fakeDatabaseByteArray, expiration);
	return Ok(new { LoadedFromRedis = false, Data = fakeDatabase });
}
  • (Line: 14-17) Defined 'Absolute Expiraiton' and 'Sliding Expiration' for our Redis-store.
  • (Line: 18) The 'SetAsync' had an overloaded method that can accept the expiration object.

Use RemoveAsync:

It is always good to have an endpoint to clear the data in Redis-store. The 'RemoveAsync' method will remove our cached data with respect to the key passed to it.
Controllers/CarController.cs:
[HttpGet]
[Route("remove")]
public async Task<IActionResult> Remove()
{
	await _cache.RemoveAsync("carstore");
	return Ok();
}

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping Up:

Hopefully, I think this article delivered some useful information on Use Azure Cache For Redis in the AspNetCore Application Distributed Cache technique. using I love to have your feedback, suggestions, and better techniques in the comment section below.

Follow Me:

Comments

Popular posts from this blog

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

.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

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

.NET Core MVC Application File Upload To Physical Location With Buffered Technique

Buffering Technique In File Upload: The server will use its Memory(RAM) or Disk Storage to save the files on receiving a file upload request from the client.  Usage of Memory(RAM) or Disk depends on the number of file requests and the size of the file.  Any single buffered file exceeding 64KB is moved from Memory to a temp file on disk.  If an application receives heavy traffic of uploading files there might be a chance of out of Disk or RAM memory which leads to crash application. So this Buffer technique used for small files uploading. In the following article, we create a sample for the file uploading using .NET Core MVC application. Create The .NET Core MVC Project: Let's create a .NET Core MVC project, here for this sample I'm using Visual Studio Code as below.   Check the link to use the Visual Studio Code for .NET Core Application . IFormFile: Microsoft.AspNetCore.Http.IFormFile used for file upload with buffered technique. On uploading files f

Ionic Picker Sample Code In Angular

Introduction: Ionic Picker(ion-picker) is a popup slides up from the bottom of the device screen, which contains rows with selectable column separated items. The main building block of ion-picker as follows: PickerController PickerOptions PickerController: PickerController object helps in creating an ion-picker overlay. create(opts?: Opts): Promise<Overlay> PickerController create method helps in create the picker overlay with the picker options PickerOptions: PickerOptions is a configuration object used by PickerController to display ion-picker. Single Column Ionic Picker: single.item.picker.ts: import { Component } from "@angular/core"; import { PickerController } from "@ionic/angular"; import { PickerOptions } from "@ionic/core"; @Component({ selector: "single-column-picker", templateUrl:"single.item.picker.html" }) export class SingleItemPicker { animals: string[] = ["Tiger&quo

.Net Core HttpClient JSON Extension Methods Using System.Net.Http.Json Package

.Net Core 3.0 onwards Microsoft brought up a new package called System.Net.Http.Json. This new package provides JSON extension methods for HttpClient. These JSON extension methods will have a prebuild mechanism for serializing or deserializing response data or payload of HttpClient call. System.Net.Http.Json extension methods that are provided to HttpClient, few of them are mentioned below. GetFromJsonAsync PostAsJsonAsync PutAsJsonAsync ReadFromJsonAsync In this article, we understand System.Net.Http.Json package by implementing the HttpClient samples by with and without JSON extension methods and compare them. Create A .Net Core Web API Sample Application: Let's create a .Net Core sample Web API application, from this application we will consume another Web API by implementing HttpClient calls. We can create a Web API sample application using IDE like Visual Studio 2019(Supports .Net Core 3.0 plus) or  Visual Studio Code . Create A Typed Client: In .Net Core using the Http