Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles
(untagged)

ASP.NET Core 2.0 Response Compression

0.00/5 (No votes)
5 Sep 2017 1  
How to compress responses in ASP.NET Core. Continue reading...

Problem

How to compress responses in ASP.NET Core.

Solution

To an empty project, configure services and middleware for compression in Startup:

public void ConfigureServices(
            IServiceCollection services)
        {
            services.AddResponseCompression();

            services.AddMvc();
        }

        public void Configure(
            IApplicationBuilder app,
            IHostingEnvironment env)
        {
            app.UseResponseCompression();

            app.UseMvcWithDefaultRoute();
        }

Add a Home controller with Index action and write some data to the view:

<h2>ASP.NET Core Response Compression</h2>
@for (int i = 0; i < 10000; i++)

{

    <strong>Testing Response Compression: @i</strong>
}

Notice the size and time of response, before and after compression:

Response Compression - before-after

Discussion

When you’re unable to use the compression features of web servers (IIS, Apache, Nginx), ASP.NET Core provides an alternate option, Response Compression middleware. It’s performance won’t match server based compression features though.

Client will send Accept-Encoding header in its request to indicate compression capabilities. The server will response with Content-Encoding indicating the compression used. Response Compression middleware supports gzip compression by default.

Compression Level

The default level of compression is Fastest, i.e., to compress as quickly as possible. You could change to Optimal for maximum compression:

services.Configure<GzipCompressionProviderOptions>(options =>
            {
                options.Level = CompressionLevel.Optimal;
            });

            services.AddResponseCompression(options =>
            {
                options.Providers.Add<GzipCompressionProvider>();
            });

However, notice the size and time! It took more than 1 second (compared to Fastest level) but we didn’t gain a lot in terms of size (0.4kb). You’ll need to test on actual websites to decide the appropriate level.

Response Compression - level

HTTPS Compression

Compression can be enabled for HTTPS by using EnableForHttps however, this could lead to security issues:

services.AddResponseCompression(options =>
            {
                options.EnableForHttps = true;
            });

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here