BLun.ETagMiddleware
1.2.2
dotnet add package BLun.ETagMiddleware --version 1.2.2
NuGet\Install-Package BLun.ETagMiddleware -Version 1.2.2
<PackageReference Include="BLun.ETagMiddleware" Version="1.2.2" />
paket add BLun.ETagMiddleware --version 1.2.2
#r "nuget: BLun.ETagMiddleware, 1.2.2"
// Install BLun.ETagMiddleware as a Cake Addin
#addin nuget:?package=BLun.ETagMiddleware&version=1.2.2
// Install BLun.ETagMiddleware as a Cake Tool
#tool nuget:?package=BLun.ETagMiddleware&version=1.2.2
ETagMiddleware
ETag Middleware for Asp.Net Core -.NetStandard 2.0 Is supports Caching with Http Request Header 'If-None-Match' with Http Respons Header 'ETag' and set the HttpStatus tu 304. Http Request Header 'Cache-Controle' with 'no-cache' is integrated and would set the HttpStatus to 200.
Inspiration
I was inspired by Mads Kristensen Blog. The Example from him, can you find here as code. Thanks for your artikle!
Requirements
.NETStandard2.0
Install
Download from Nuget.org
"dependencies": {
"BLun.ETagMiddleware": "<version>"
}
Featurs
- BLun.ETagMiddleware for Asp.Net Core Http
- Microsoft.AspNetCore.Http.IMiddleware
- BLun.ETagAttribute for Asp.Net Core Mvc
- Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter
- Supports
- Microsoft.Extensions.Logging
- Microsoft.Extensions.DependencyInjection
- Microsoft.Extensions.Options (Configuration)
Usage as Middleware (Microsoft.AspNetCore.Http.IMiddleware)
The default usage are:
using BLun.ETagMiddleware;
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
// Required
// Add a Middleware for each Controller Request with
// algorithmus = SHA1 = default
// etag validator = Strong = default
// body content length = 40 * 1024 = default
services.AddETag();
}
// Add "app.UseETag();" to "Configure" method in Startup.cs
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseStaticFiles();
// Add a Middleware for each Controller Request
// Atention: add app.UseETag after app.UseStaticFiles, the order is important for performance
app.UseETag();
app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}");
});
}
You can configuratione your own option prameters:
using BLun.ETagMiddleware;
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
// Required
// Add ETagOption with own global configurations
services.AddETag(new ETagOption()
{
// algorithmus
// SHA1 = default
// SHA265
// SHA384
// SHA512
// MD5
ETagAlgorithm = ETagAlgorithm.SHA265,
// etag validator
// Strong = default
// Weak
ETagValidator = ETagValidator.Weak,
// body content length
// 40 * 1024 = default
BodyMaxLength = 20 * 1024
});
}
// Add "app.UseETag();" to "Configure" method in Startup.cs
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseStaticFiles();
// Add a Middleware for each Controller Request
// Atention: add app.UseETag after app.UseStaticFiles, the order is important
app.UseETag();
app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}");
});
}
Usage as ETagAttribute (Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter)
using BLun.ETagMiddleware;
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
// Add ETagOption with own global configurations
services.AddETag(new ETagOption()
{
// algorithmus
// SHA1 = default
// SHA265
// SHA384
// SHA512
// MD5
ETagAlgorithm = ETagAlgorithm.SHA265,
// etag validator
// Strong = default
// Weak
ETagValidator = ETagValidator.Weak,
// body content length
// 40 * 1024 = default
BodyMaxLength = 20 * 1024
});
}
// Add "app.UseETag();" to "Configure" method in Startup.cs
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseStaticFiles();
// Add a Middleware for each Controller Request
// Atention: add app.UseETag after app.UseStaticFiles, the order is important
// deactivate or combine with Middlewar
// the EtagAttributes didn't need the Middleware
// app.UseETag();
app.UseMvc(routes =>
{
routes.MapRoute(
name: "default",
template: "{controller=Home}/{action=Index}/{id?}");
});
}
// Can add on controller
[ETag()]
public class HomeController : Controller
{
public IActionResult Index()
{
return View();
}
// Can add on methods
[ETag(ETagValidator = ETagValidator.Weak)]
public IActionResult About()
{
ViewData["Message"] = "Your application description page.";
return View();
}
[ETag(ETagValidator = ETagValidator.Strong, BodyMaxLength = 30 * 1024, ETagAlgorithm = ETagAlgorithm.SHA384)]
public IActionResult Contact()
{
ViewData["Message"] = "Your contact page.";
return View();
}
public IActionResult Error()
{
return View(new ErrorViewModel { RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier });
}
}
Unittested
The Code is unittestet.
Vision
I would develope muche more test for it.
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 net481 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 2.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.0.1)
- Microsoft.AspNetCore.Mvc.Abstractions (>= 2.0.0)
- Microsoft.AspNetCore.WebUtilities (>= 2.0.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 2.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 2.0.0)
- Microsoft.Extensions.Options (>= 2.0.0)
- Microsoft.Net.Http.Headers (>= 2.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Is supports Caching with Http Request Header 'If-None-Match' with Http Respons Header 'ETag' and set the HttpStatus tu 304. Http Request Header 'Cache-Controle' with 'no-cache' is integrated and would set the HttpStatus to 200.