Response Compression Middleware In ASP.NET Core

Nishan Aryal
7y
11.8k
0
5

Article

ASP.NET Core 1.1 has an inbuilt Response Compression Middleware for compression, which by default uses GZIP compression. In simple words, GZIP is a technique, which is used for the file compression and decompression for faster network transfer.

All the modern Browsers support response compression. Using GZIP Compression is the best approach to reduce the response size and provide better speed for transferring the files over the network.

Enable GZIP compression in ASP.NET Core

Let's first install GZIP in our ASP.NET MVC Project, using NUGET Package Manager.

Step 1

Right click on ASP.NET Core and select Manage Nuget Package.

Response Compression Middleware in ASP.NET Core by Nishan Aryal

Step 2

Browse Microsoft.AspNetCore.ResponseCompression.

Response Compression Middleware in ASP.NET Core by Nishan Aryal

Once ResponseCompression is installed, we need to configure it.

Let's open Startup.cs file and add the code given below in ConfigurationService method.

Response Compression Middleware in ASP.NET Core by Nishan Aryal

Code snippet

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
// Add framework services.
services.AddDbContext<ApplicationDbContext>(options =>
options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
services.AddIdentity<ApplicationUser, IdentityRole>()
.AddEntityFrameworkStores<ApplicationDbContext>()
.AddDefaultTokenProviders();
//Add ResponseCompression as Service
services.AddResponseCompression();
services.AddMvc();
// Add application services.
services.AddTransient<IEmailSender, AuthMessageSender>();
services.AddTransient<ISmsSender, AuthMessageSender>();
}

By default, ASP.NET Core uses GZIP compression. Now, let’s add this middleware to HTTP pipeline, so add the line of code given below in Configure method of Startup.cs.

Remember to add Compression middleware before other middlewares, which serves the files.

Response Compression Middleware in ASP.NET Core by Nishan Aryal

Code snippet

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory loggerFactory)
{
loggerFactory.AddConsole(Configuration.GetSection("Logging"));
loggerFactory.AddDebug();
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
app.UseDatabaseErrorPage();
app.UseBrowserLink();
}
else
{
app.UseExceptionHandler("/Home/Error");
}
app.UseStaticFiles();
app.UseIdentity();
// Add external authentication middleware below.
//Compression middleware before other middlewares which serves the files.
app.UseResponseCompression();
app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}");
});
}