Middleware in .Net Core

I have read number of articles on middleware and watched some videos and now it’s time to explore it myself.
Here, you will learn how to create and add your own custom middleware into the request pipeline of ASP.NET Core application.

What Is Middleware?

Middleware are small C# components that are assembled into an application pipeline to handle requests and responses. It defines steps that can progress through and each step leading into the next.
It can be used for a wide variety of reasons from Authentication to Logging to Exception Handling etc


Basic Custom middleware

The custom middleware component is like any other .NET class with Invoke() method. However, in order to execute next middleware in a sequence, it should have RequestDelegate type parameter in the constructor.
Visual studio includes template for adding middleware in our application.
Let’s get started by adding one.
For this right click on the project or folder wherever you want to add a middleware and add new Item. Under Web-> ASP.NET you will find middleware template or you search for it.



And it will add a default custom middleware class for you.


Actually there will be two classes one for our custom middleware and another one is extension class which will add the middleware to request pipeline.
The class has RequestDelegate as part of the constructor through DI, the HttpContext gets passed into the executing method and by convention in the Middlware pipeline this is called Invoke.
Notice we have to pass the HttpContext through to the _next delegate call.

Things to consider

The middleware class must include:
  • A public constructor with a parameter of type RequestDelegate.
  • A public method named Invoke or InvokeAsync. This method must:
    • Return a Task.
    • Accept a first parameter of type HttpContext.
    • Can accept additional parameters that are populated by DI

Middleware dependencies
Middleware should follow the Explicit Dependencies Principle by exposing its dependencies in its constructor. Middleware is constructed once per application lifetime.
Middleware components can resolve their dependencies from dependency injection (DI) through constructor parameters. UseMiddleware<T> can also accept additional parameters directly.

Configuration setup


We can use this directly in the Configure method in Startup however it can be cleaner. We can achieve this through defining an extension method which acts on IApplicationBuilder
The recommended way to expose the middleware through IApplicationBuilder and then call them in Startup.Configure.

We can make our startup file more cleaner this way.

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

Reference

Comments

Post a Comment

Popular Posts

How to position controls using Canvas control in WPF using MVVM

Image
The best way to position different controls using Canvas in MVVM is using ItemsControl.We need to bind ItemsControl with the list of controls and using Canvas control as the ItemsTemplate.Lets understand it in more details using an example. Step 1: Add an ItemsControl in MainWindow. Step 2: Lets create a list containing the different heights, width,top and left poistions for the controls and this list we will be using as the ItemsSource to bind the ItemsControl. Step 3: Lets Create a class under ViewModel folder only named as “ControlDetails”, Class should look like: namespace WpfApplication1.ViewModel {   public class ControlDetails     {         public double Height         {             get;             set;         }         public double Width         {           ...
Read more

Change font and size in visual studio

Image
Visual studio comes with feature to customize font and size. Let us see how we can change the font and size in visual studio. We can do that by going to        tools -->  options                                                                                                                                 Below is the screenshot for reference: Under environment tab select Font and color section.         environment --> font and color                                                   ...
Read more

JWTs in ASP.NET Core 2.0

Image
A Quick Introduction to JWTs JSON Web Tokens, often shortened with JWTs, are gathering more and more popularity in the Web environment. It is an open standard that allows transmitting data in JSON object, in a compact and secure way. They are usually used in authentication and information exchange scenarios since the data transmitted between a source and a target are digitally signed so that they can be easily verified and trusted. For more, you can visit my previous blog here   Securing your web API There are many reasons you might choose to expose an API from your ASP.NET Core 2.0 app: supporting windows-based software, another web application, or maybe you’re building a SAAS product and want to give advanced users some mechanism to integrate with your platform. But clearly, the most common (and likely) scenario is that you want to build all, or some, of your application, using front-end Single Page Application frameworks such as ReactJS, Angular, or Aurelia. There ar...
Read more