Skip to main content

Use Redis Cache In NestJS Application

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.

Caching can significantly improve application performance and its scalability by reducing the workload to generate the content. If our server application runs on multiple servers then it is easy to share the Redis Cache between them.

Setup Redis Docker Image Container:

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 NestJS Application:

Let's understand step by step implementation authentication in NestJs application, so let's begin our journey by creating a sample application.
Command To Install CLI:
npm i -g @nestjs/cli
Command To Create NestJS App:
nest new your_project_name

Install Cache Npm Packages:

NestJS Cache NPM Packages:
npm install cache-manager
npm install -D @types/cache-manager
npm install cache-manager-redis-store --save

Redis Store Configurations:

Now let's register the CacheModule with the Redis Store configurations in AppModule.
src/app.module.ts:
import { Module, CacheModule } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';
// code hidden for display purpose
@Module({
  imports: [CacheModule.register({
    store:redisStore,
    host: 'localhost',
    port: 5003
  })]
})
export class AppModule {}
  • Imported 'CacheModule' that loads from '@nestjs/common' library. 
  • The 'register' method of CacheModule takes our Redis Store configuration for communication. 
  • The 'store' property assigned with 'redisStore' variable that represents the 'cache-manager-redis-store' library. 
  • The 'host' property must assign our Redis store value since here I'm using a local Redis instance my hostname will be 'localhost'. 
  • The 'post' property contains the Redis store running the port.

Inject CacheManager:

Now in our controllers to communicate with the Redis store we need to inject the CacheManager.
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';

@Controller()
export class AppController {
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
}
  • The 'Cache' type is generic that works with any cache store and provides default methods for cache communication. The 'CACHE_MANAGER' is a lookup for the provider to be injected which means it will inject the cache-store that is registered by the CacheModule, in our sample, it will inject Redis cache-store.

Get And Set Methods:

The 'Set' method is to store our data in the Redis store. The 'Get' method to fetch data from the Redis store.

Let's store a simple string and fetch it from the Redis store by creating a sample endpoint.
src/app.controller.cs:
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';

@Controller()
export class AppController {
  fakeString = "my name is naveen"
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}
  @Get("simple-string-fetch")
  async setGetSimpleString(){
    var value = await this.cacheManager.get('my-string');
    if(value){
      return {
        data: value,
        loadsFrom: 'redis cache'
      }
    }
    await this.cacheManager.set('my-string', this.fakeString,{ttl:300});
    return{
      data:this.fakeString,
      loadsFrom:'fake database'
    }
  }
}
  • (Line: 6) The 'fakeString' variable will be used to store and fetch from the Redis store.
  • (Line: 10) Here first we are trying to fetch the data from the Redis store by using the key 'my-string'.
  • (Line: 11-16) If data exist in the Redis store then returns it as the output of the endpoint.
  • (Line: 17) If data did not exist in the Redis store then we have to store it in the Redis store using my key 'my-string'. The property 'ttl'(Time To Live) set to 300sec(5minutes) as expiration.
  • (Line: 18) Returns the data from the database(Here I'm using the constant variable in real application data needs to be loaded from the database) for the first request.
In the above example, we saved and fetched the simple string from the Redis store. But in the real-time application, we need to store the complex data and fetch it from the Redis store. Our 'Get' and 'Set' method has the capability to save and fetch type objects into the Redis store. Redis stores only the string of data, so if we try to save object data then implicit serialization will be carried out by the 'Set' and 'Get' methods.

Let's create an object that we want to store its data in the Redis store.
src/shared/model/profile.ts:
export interface Profile {
    name:string,
    email:string
}
Let's create a new endpoint that stores the object in the Redis store.
src/app.controller.ts:
import { Controller, Get, Inject, CACHE_MANAGER } from '@nestjs/common';
import {Cache} from 'cache-manager';
import { Profile } from './shared/models/profile';

@Controller()
export class AppController {
  fakeData:Profile = {
    name:'naveen',
    email:'naveen@gmail.com'
  }
  constructor(@Inject(CACHE_MANAGER) private cacheManager: Cache) {}

  @Get("fetch-object-cache")
  async getCache(){
    var data = await this.cacheManager.get<Profile>('my-object');
    if(data){
      return {
        data:data,
        loadsFrom: 'cache'
      };
    }

    await this.cacheManager.set<Profile>('my-object', this.fakeData, {ttl: 300});
return{ data:this.fakeData, loadFrom:'fake data base' } } }

Del And Reset Methods Of Cache-Store:

The cache store provides the method 'del('key')'  used to delete the record from the cache.
await this.cacheManager.del('your_key_to_delte');
The cache store provides the method 'reset()' used to clear the entire Redis store cache.
await this.cacheManager.reset()

Auto Cache Using Interceptor:

Using 'CacheInterceptor' we can enable auto cache on the controller which will affect all 'Get' action methods inside of the controller. In the auto cache, the 'key' value for storing cache will use the route value as key.

Let's update the AppModule to import the 'CacheInterceptor' provider and also need to configure the expiration globally that will be used by the auto cache.
src/app.module.ts:
import { Module, CacheModule, CacheInterceptor } from '@nestjs/common';
import * as redisStore from 'cache-manager-redis-store';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import {APP_INTERCEPTOR} from '@nestjs/core';

@Module({
  imports: [CacheModule.register({
    store:redisStore,
    host: 'localhost',
    port: 5003,
    ttl:300
  })],
  controllers: [AppController],
  providers: [
    {
      provide:APP_INTERCEPTOR,
      useClass: CacheInterceptor
    },
    AppService
  ],
})
export class AppModule {}
  • The 'CacheInterceptor' will enables the auto cache to the application. Its loads from the '@nestjs/common' library. To enable it we need to import it into the provider's array.
  • (Line: 12)Cache expiration time set globally using 'ttl' property. So this expiration will be utilized by the auto cache as well.
Now add the 'UseInterceptors' decorator on top of the controller and passing 'CacheInterceptor' as input which will trigger auto cache for all 'Get' endpoint inside the controller.
src/app.controller.cs:
import { Controller, Get, UseInterceptors, CacheInterceptor } from '@nestjs/common';

import { Profile } from './shared/models/profile';

@Controller()
@UseInterceptors(CacheInterceptor)
export class AppController {
  fakeData:Profile = {
    name:'naen',
    email:'naveen@gmail.com'
  }
  constructor() {}

  @Get("auto-cache")
  get(){
    return this.fakeData;
  }
}


Now to test that auto cache saved to our Redis store, I'm going to check for the 'key' value using the Redis CLI.

Override Auto Cache Key Name And Expiration:

An auto cache by default uses the endpoint rout value as 'key' to store into Redis store and uses the global configuration 'ttl' property for expiration. But we can override them by using decorator like '@CacheKey' to give our own 'key' to store data in the Redis store and '@CacheTTL' to set the expiration time which will override the global expiration.

Let's update our endpoint to use '@CacheKey', '@CacheTTL' decorators.
src/app.controller.cs:
import { Controller, 
Get, UseInterceptors, 
CacheInterceptor, CacheKey, CacheTTL } from '@nestjs/common';
import { Profile } from './shared/models/profile';

@Controller()
@UseInterceptors(CacheInterceptor)
export class AppController {
  fakeData:Profile = {
    name:'naen',
    email:'naveen@gmail.com'
  }
  constructor() {}

  @Get("auto-cache")
  @CacheKey('myCustomKey')
  @CacheTTL(300)
  get(){
    return this.fakeData;
  }
}
  • (Line: 16) The '@CacheKey' decorator to give a custom 'key' name for the auto cache.
  • (Line: 17) The '@CacheTTL' overrides the global expiration and can set the expiration for the action method level.
That's all about the implementation of the Redis store into the NestJS application.

Support Me!
Buy Me A Coffee PayPal Me

Wrapping Up:

Hopefully, I think this article delivered some useful information on Redis Store in the NestJS 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

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