Accessing httpcontext in class library with ASP.NET Core 1.1 (MVC)

mackhax0r picture mackhax0r · Apr 20, 2017 · Viewed 12.3k times · Source

I am working on migrating my ASP.NET 4.6 framework code over to .NET Core. I'm only in the learning phase at this point. I'm new to MVC as I've always used WebForms, but I want to move away from WebForms. I'm also new to ASP.NET Core.

Basically, I have a class library that does the bulk of my work - saving me from repeating code (database, session, custom identity management) across multiple pages or even websites. I add the DLL to a project, and it's ready to go.

I'm finding that ASPNET Core doesn't quite allow this. Perhaps I'm not understanding it, or perhaps it's too early to start porting over to it.

I need to be able to access HttpContext inside my class library to manipulate things like sessions, cookies, etc. What is the easiest way to approach this? I think once I can do that, I can start making better progress.

Or, do I need to reconsider writing a class library? From my understanding, I need to write Middleware to accomplish this. But every example I could find is either incomplete or outdated already.

Any suggestions are welcome.

Answer

mwilczynski picture mwilczynski · Apr 20, 2017

Using HttpContext for all-around logic is not a great idea but if you really intend to do so, just stick to one of SOLID principles, ie. Dependency inversion principle.

ASP.NET MVC and it successor, ASP.NET Core have their foundations laid on this very principle. Inject IHttpContextAccessor in constructor of any class from your class library that needs it.


Example:

public class ContextHelper
{
    private IHttpContextAccessor _httpContextAccessor;

    public ContextHelper(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public void DoStuff()
    {
        DoOtherStuffWith(_httpContextAccessor.HttpContext);
    }
}

Remember to register it in Startup in default IoC container like this:

public class Startup
{
    // Rest of the class here...

    public void ConfigureServices(IServiceCollection services)
    {
        // Other registrations here...

        services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
    }
}