How to Create a Custom Middleware Component in ASP.NET Core?

With the help of the robust ASP.NET Core middleware, developers may implement unique logic to handle incoming requests and outgoing responses, allowing them to personalize the request pipeline. Each middleware component has the option to handle the request or forward it to the following component in the pipeline. These components are run in a particular order.

An example of a custom middleware component in ASP.NET Core is shown.

public class LoggingMiddleware
{
    private readonly RequestDelegate _next;
    private readonly ILogger<LoggingMiddleware> _logger;

    public LoggingMiddleware(RequestDelegate next, ILogger<LoggingMiddleware> logger)
    {
        _next = next;
        _logger = logger;
    }

    public async Task InvokeAsync(HttpContext context)
    {
        try
        {
            // Log the request details
            _logger.LogInformation($"Request: {context.Request.Method} {context.Request.Path}");

            // Call the next middleware in the pipeline
            await _next(context);
        }
        catch (Exception ex)
        {
            // Log the exception
            _logger.LogError(ex, "An error occurred while processing the request.");
            throw;
        }
        finally
        {
            // Log the response details
            _logger.LogInformation($"Response: {context.Response.StatusCode}");
        }
    }
}

In this example, we create a LoggingMiddleware class that logs the request and response details to the console. The InvokeAsync method is the entry point for the middleware component. It receives an HttpContext object, which represents the current HTTP request and response.

Inside the InvokeAsync method, we first log the request details using the ILogger instance. Then, we call the _next delegate, which invokes the next middleware component in the pipeline. After the next middleware component has been completed, we log the response details.

To register the custom middleware component in the application's request pipeline, you can use the UseMiddleware extension method in the Startup.Configure method.

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Other middleware components...

    app.UseMiddleware<LoggingMiddleware>();

    // Other middleware components...
}

This will add the LoggingMiddleware component to the request pipeline, and it will be executed for every incoming request.

Middleware components can be used for various purposes, such as logging, authentication, caching, compression, and more. ASP.NET Core also provides several built-in middleware components that you can use out of the box, such as UseStaticFiles, UseRouting, UseEndpoints, and UseAuthentication.

Windows Hosting Recommendation

HostForLIFEASP.NET receives Spotlight standing advantage award for providing recommended, cheap and fast ecommerce Hosting including the latest Magento. From the leading technology company, Microsoft. All the servers are equipped with the newest Windows Server 2012 R2, SQL Server 2014, ASP.NET 7.0.4, ASP.NET MVC 6.0, Silverlight 5, WebMatrix and Visual Studio Lightswitch. Security and performance are at the core of their Magento hosting operations to confirm every website and/or application hosted on their servers is highly secured and performs at optimum level. mutually of the European ASP.NET hosting suppliers, HostForLIFE guarantees 99.9% uptime and fast loading speed. From €3.49/month , HostForLIFE provides you with unlimited disk space, unlimited domains, unlimited bandwidth,etc, for your website hosting needs.