Skip to main content

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 fresh response from server
  • no-store - cache can't store the request or response.

Pragma Header:

Pragma Header used for Http/1.0 request with no-cache directive value. Pragma gets ignored if response decorated with Cache-Control

Vary Header:

Vary Header fields must match with the original request-response and the new request.

ResponseCache Attribute:

Asp.Net Core provided ResponseCache Attribute to enable response cache on MVC/Web API/Razor Pages. This attribute needs to be populated with respective input parameters to generate the cache headers. The following are few input parameters for the cache attribute.
  • Duration - Gets or sets the duration in seconds for which response is cached. This sets "max-age" in "cache-control" header.
  • Location - Gets or sets the location where the data from a particular URL must be cached. It accepts three types of parameters. If Location decorated with "ResponsCacheLocation.Any" works like response cached in both proxies and client and sets "cache-control" header to the public. If Location decorated with "ResponseCacheLocation.Client" works like response cached only in the client and sets "cache-control" header to private. if Location decorated with "ResponseCacheLocation.None" works like "cache-control" and "Pragma" headers set to "no-cache".
  • NoStore - Gets or sets the value which determines whether the data should store or not. When NoStore decorates with 'true' value, it sets the "cache-control" header to "no-store" and ignores the "Location" parameter for values other than "None" and ignores "Duration" as well.
  • VaryByHeader - Gets or sets the value for the "Vary" response header.
  • VaryByQueryKeys - Gets or sets the query keys to "Vary".
Let's start testing the response cache on MVC endpoint using ResponseCache Attribute as below.
HomeController.cs:
[ResponseCache(Duration =120, Location = ResponseCacheLocation.Any, NoStore = false)]
public IActionResult Index()
{
 return View();
}
Above controller decorated with ResponseCache Attribute. Cache duration set to 120 secs, Location set to ResponseCache.Any which results in "public" value for the "cache-control" header.
Now run the application and open developer console and then check cache headers are added to response headers as below.
Now from the picture above "max-age=120" means the browser after receiving the first request with "cache-control" header value with "public" stores the data for 120 secs. So from the next request of the same page from the website will be loads from the disk cache as shown below
After clicking on the home page link from the website as shown in the above picture, we can observe page gets reloaded from the cache as below.
While Testing response caching always click on links within the websites because clicking Href on the website browser will check the previous response headers if they are cached so it will load the page from the cache if headers matched. If we reload the page or clicking the enter button browser search bar browser will request the page from the server.
Now update the ResponseCache Attribute location parameter with a value "ResponseCache.Client" as below
[ResponseCache(Duration =120, Location = ResponseCacheLocation.Client, NoStore = false)]
Now observe the response header where the "cache-control" value set to "private" as below.
Now update the ResponseCache Attribute location parameter with a value "ResponseCache.None" as below.
[ResponseCache(Duration =120, Location = ResponseCacheLocation.None, NoStore = false)]
Now observe the response header where the "cache-control" value set to "no-cache" as below.
Now update the ResponseCache Attribute "NoStore" parameter with a value "true". By setting "true" to "NoStore" will override the "cache-control" value of the "Location " parameter as below.
[ResponseCache(Duration =120, Location = ResponseCacheLocation.Any, NoStore = true)]
Now observe the response header where the "cache-control" value set to  "no-store" as below.

public vs private vs no-cache values of cache-control:

What is a proxy server? - Internet Service Providers may maintain some multiple numbers of proxy servers were to maintain and cache the data to fastly serve the information to their customers.
  • cache-control: public - caching of response both in proxy servers and in client machines(browser).
  • cache-control: private - caching of response only in the client machine.
  • cache-control: no-cache - no caching, every request will be freshly fetched from the server.

VaryByHeader In ResponseCache Attribute:

VaryByHeader in Asp.Net Core represents the Http "Vary" Header. The "Vary" header uses the current request-response header value to be matched with future request header. If headers match future request-response fetch from the cache and if not match fetch response freshly from the server.

The best example to test Http "Vary" Header by populating it with "User-Agent". "User-agent" gives information like the type of client request to the server. In general "User-Agent" will be different for the device to device.

Example of how User-Agent works with response caching?
  • In a website configure home page by enabling response cache attribute with "VaryByHeader" value set to "User-Agent". 
  • Now from desktop access, the home page will be rendered with response header with "Vary". After that click on the home page link to refresh the page since "User-Agent" cache enabled and headers match response will be loaded from the cache. 
  • Now open developers' tools and select the setting to mobile device options and then click on the home page link on the website. Now the device type is changed so the "User-Agent" value will be changed so now the browser will send a fresh request to the server instead of loading a response from the cache.
Now let's do VaryByHeader practically. Update the ResponseCache Attribute "VarByHeader" parameter with the value "User-Agent" as below.
[ResponseCache(Duration =120,VaryByHeader = "User-Agent", Location = ResponseCacheLocation.Any, NoStore = false)]
Now run the application in desktop mode and the "Vary" response header will have value as "User-Agent" as below.
Request User-Agent looks as below.
Now click refresh the page by clicking the home link on the website in desktop device mode. Since user-agent won't change response will be rendered from the cache as below
Now from the developers' tool change settings to mobile devices and click on the home page link. Since device mode changed "User-agent" value will be changed, so browser request data from the server instead of cache as below.
We can observe user agent value will be changed as below.

Cache Profile:

ResponseCache Attribute input parameters may be the same for almost all the action methods in an application. Asp.Net Core provides options like profile cache where all the parameter options are configured startup class with a name to that configuration, that profile name can be used inside the ResponseCache Attribute which removes duplication parameters setting in it.
public void ConfigureServices(IServiceCollection services)
{
 services.AddControllersWithViews(options => {
  options.CacheProfiles.Add("Profile1", new Microsoft.AspNetCore.Mvc.CacheProfile
  {
   Duration = 120,
   Location = Microsoft.AspNetCore.Mvc.ResponseCacheLocation.Any,
   NoStore = false
  });
  options.CacheProfiles.Add("Profile2", new Microsoft.AspNetCore.Mvc.CacheProfile
  {
   VaryByHeader = "User-Agent",
   Duration = 60,
   Location = Microsoft.AspNetCore.Mvc.ResponseCacheLocation.Client,
   NoStore = false
  });
 });
}
Here we have two different cache profiles with their respective settings. We can observe all the parameters we generally configured in ResponseCache Attribute are configured here inside the CacheProfile object."Profile2" cache settings represent caching based on VaryByHeader.

Now update the ResponseCache Attributes with its respective profile names as below.
[ResponseCache(CacheProfileName ="Profile1")]
public IActionResult Index()
{
 return View();
}

[ResponseCache(CacheProfileName = "Profile2")]
public IActionResult Test()
{
 return View();
}

Custom Middleware To Add Cache:

We can add response cache by writing middleware but this implementation by default adds response cache to any page on the application.
Startup.cs:
app.Use(async (context, next) =>
{
 context.Response.GetTypedHeaders().CacheControl =
  new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
  {
   Public = true,
   MaxAge = TimeSpan.FromSeconds(60),
  };
 await next();
});
Here we can observe on every request, response context adding "CacheControl" object.
HomeController.cs:
public IActionResult Index()
{
  return View();
}

Combination Of Custom Cache Middleware And ResponseCache Attribute:

Yes, we can use both of them in our Asp.Net Core applications. But ResponseCache Attribute settings override the middleware settings. So it will help like globally every page will have cache information from the custom middleware and if we want to override those settings to any of the endpoint then we can easily override by implementing ResponseCache Attribute on the particular action method.
For example "MaxAge" set to 180 secs on custom middleware and if we configure ResponseCache Attribute with "Duration" set to 60 secs then a response will be cached for 60secs only.

Wrapping Up:

Hopefully, this article will help to understand Response Cache implementation in the Dotnet core. I will love to have your feedback, suggestions, and better techniques in the comments section.

Refer:

Follow Me:

Comments

Popular posts from this blog

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

GraphQL API Integration In Asp.Net Core Application

Introduction: GraphQL is a query language for your API and a server-side runtime for executing queries by using a type system you define for your data. GraphQL can be integrated into any framework like ASP.NET, Java, NestJs, etc and it isn't tied to any specific database or storage engine and is instead backed by your existing code and data. How GraphQL API Different From Rest API: GraphQL exposes a single end-point or route for the entire application, regardless of its responses or actions. HTTP-POST is the only Http verb recommended by the GraphQL. The client applications (consumers of API) can give instructions to GraphQL API about what type of properties to be returned in the response. Building Blocks Of GraphQL API: The main building blocks of GraphQL API is Schemas and Types.  A 'Schema' in GrpahQL API describes the functionality available to the clients connect to API. Schema mostly consists of GraphQL Object Types, Queries, Mutations, etc. T

ASP.NET Core Web API Versioning

Introduction: An iteration and evolutionary changes of an ASP.NET Core Web API is handled by Versioning. Versioning of an API gives confidence to the clients which consumes API for a long time. Any changes or development of an API will be accessible using the new version and it won't cause issues to the clients consuming the old version of API. When To Use Versioning: Any API response changes. Developing an API by implementing testing levels like 'Alpha', 'Beta', and 'RC' versions before releasing Production. Deprecating an API which means API going to be removed or upgraded by a version within a short period. Versioning Types: Query String Versioning Url Path Versioning Media Type Versioning API Version Nuget: To Configure versioning to AspNet Core Web API Microsoft provided a library(Microsoft.AspNetCore.Mvc.Versioning). So to use the versioning library please install NuGet below.              Install-Package Microsoft.A

.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

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

Blazor Server CRUD Operations

Introduction: Blazor Server is a web framework to develop server-side single-page applications. Blazor is made up of components with the combinations on C#, Html, CSS.  Blazor Server is production-ready from the .Net Core 3.0.  Blazor Server Working Mechanism: Blazor Server is a very light-weight web development framework.  In Blazor Server, not all code gets downloaded to the client browsers. Blazor Server made of components these components can be a block of code or page with respective navigation.  Blazor server application communicates with the server with a SignalR background connection which is inbuilt functionality. Application click,  form submission, change events, application page navigation every operation is carried out by the SignalR connection by communicating with the server.  Blazor updates the Html DOM very gently on every data update without any overhead. Blazor Server application maintains a nice intelligent tree structure to update the required inform

NestJS API CRUD Operations With MongoDB

Introduction: NestJS is a framework used to develop server-side applications. NestJS built on top of Node.js frameworks like Express. It is a combination of Progressive Javascript, Object-Oriented Programming, Functional Programming, and Functional Reactive Programming. Nest CLI Installation: Using Nest CLI we are able to generate the NestJS starter project with the default template. To install Nest CLI globally over our system open command prompt and run the command               npm i -g @nestjs/cli Now create a sample project by using Nest CLI command              nest new your_project_name package.json: Now open the package.json file from the sample application created, you can observe few properties like "scripts", "dependencies", and "devDependencies". "dependencies" contains all plugins to be installed and used them to run the application. "devDependencies" contain all plugins to be installed and used them

Blazor WebAssembly Dynamic Form Validation

Introduction: In Blazor WebAssembly(client-side framework) form validation can be done with Data Annotations. Using Data Annotations we can validate form either by default validation attributes or by creating custom validation attributes. Using this Data Annotation attribute we can dynamically add or remove validation on a specific field in a form. Create Blazor WebAssembly Project: To create a Blazor WebAssembly template project need to install the latest version of VisualStudio 2019 for rich intelligence support or we can use VisualStudio code but less intelligence support from the editor.  Click here to know about Blazor WebAssembly template creation. Blazor WebAssembly is in preview mode, not yet ready for production. Create Razor Component: After creating a sample project using the Blazor WebAssembly template, in "Pages" folder add new Razor Component , name it as "UserForm.razor" Add Route: In Blazor routing can be configured using @