Přístup HttpContext v ASP.NET Core

HttpContext Zapouzdřuje všechny informace o jednotlivých požadavcích a odpovědích HTTP. Instance HttpContext se inicializuje při přijetí požadavku HTTP. Instance HttpContext je přístupná prostřednictvím middlewaru a aplikačních architektur, jako jsou kontrolery webového rozhraní API, Razor Stránky, SignalR, gRPC a další.

Informace o použití HttpContext s požadavkem a odpovědí HTTP naleznete v tématu Použití HttpContext v ASP.NET Core.

Přístup HttpContext ze Razor stránek

PageModel Stránky Razor zpřístupňuje PageModel.HttpContext vlastnost:

public class IndexModel : PageModel
{
    public void OnGet()
    {
        var message = HttpContext.Request.PathBase;

        // ...
    }
}

Stejnou vlastnost lze použít v odpovídajícím Razor zobrazení stránky:

@page
@model IndexModel

@{
    var message = HttpContext.Request.PathBase;

    // ...
}

Přístup HttpContext ze Razor zobrazení v MVC

Razor zobrazení v vzoru MVC zpřístupňují HttpContext prostřednictvím RazorPage.Context vlastnosti v zobrazení. Následující příklad načte aktuální uživatelské jméno v intranetové aplikaci pomocí ověřování systému Windows:

@{
    var username = Context.User.Identity.Name;

    // ...
}

Přístup HttpContext z kontroleru

Kontrolery zpřístupňují ControllerBase.HttpContext vlastnost:

public class HomeController : Controller
{
    public IActionResult About()
    {
        var pathBase = HttpContext.Request.PathBase;

        // ...

        return View();
    }
}

Přístup HttpContext z minimálních rozhraní API

Pokud chcete použít HttpContext z minimálních rozhraní API, přidejte HttpContext parametr:

app.MapGet("/", (HttpContext context) => context.Response.WriteAsync("Hello World"));

Přístup HttpContext z middlewaru

Pokud chcete použít HttpContext z vlastních komponent middlewaru HttpContext Invoke , použijte parametr předaný do metody nebo InvokeAsync metody:

public class MyCustomMiddleware
{
    // ...

    public async Task InvokeAsync(HttpContext context)
    {
        // ...
    }
}

Přístup HttpContext z SignalR

Chcete-li použít HttpContext z SignalR, zavolejte metodu GetHttpContext :Hub.Context

public class MyHub : Hub
{
    public async Task SendMessage()
    {
        var httpContext = Context.GetHttpContext();

        // ...
    }
}

Přístup HttpContext z metod gRPC

Pokud chcete použít HttpContext metody gRPC, přečtěte si téma Řešení HttpContext v metodách gRPC.

Přístup HttpContext z vlastních komponent

U jiných architektur a vlastních komponent, které vyžadují přístupHttpContext, se doporučuje registrovat závislost pomocí integrovaného kontejneru injektáže závislostí (DI). Kontejner DI dodává IHttpContextAccessor všechny třídy, které ho deklarují jako závislost v jejich konstruktorech:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllersWithViews();
builder.Services.AddHttpContextAccessor();
builder.Services.AddTransient<IUserRepository, UserRepository>();

V následujícím příkladu:

• UserRepository deklaruje jeho závislost na IHttpContextAccessor.
• Závislost se zadává, když DI vyřeší řetěz závislostí a vytvoří instanci UserRepository.

public class UserRepository : IUserRepository
{
    private readonly IHttpContextAccessor _httpContextAccessor;

    public UserRepository(IHttpContextAccessor httpContextAccessor) =>
        _httpContextAccessor = httpContextAccessor;

    public void LogCurrentUser()
    {
        var username = _httpContextAccessor.HttpContext.User.Identity.Name;

        // ...
    }
}

HttpContext přístup z vlákna na pozadí

HttpContext není bezpečný pro přístup z více vláken. Čtení nebo zápis vlastností HttpContext mimo zpracování požadavku může mít za následek .NullReferenceException

Bezpečné práce na pozadí s daty HttpContext :

• Během zpracování požadavku zkopírujte požadovaná data.
• Předejte zkopírovaná data do úlohy na pozadí.
• Neodkazujte na HttpContext data v paralelních úlohách. Před spuštěním paralelních úloh extrahujte data potřebná z kontextu.

Abyste se vyhnuli nebezpečnému kódu, nikdy nepředávejte HttpContext metodu, která funguje na pozadí. Místo toho předejte požadovaná data. V následujícím příkladu SendEmail volání SendEmailCoreAsync , která začnou posílat e-maily. Hodnota hlavičky X-Correlation-Id se předá SendEmailCoreAsync místo HttpContext. Provádění kódu nečeká na SendEmailCoreAsync dokončení:

public class EmailController : Controller
{
    public IActionResult SendEmail(string email)
    {
        var correlationId = HttpContext.Request.Headers["X-Correlation-Id"].ToString();

        _ = SendEmailCoreAsync(correlationId);

        return View();
    }

    private async Task SendEmailCoreAsync(string correlationId)
    {
        // ...
    }
}

IHttpContextAccessor/HttpContext v Razor součástech (Blazor)

[CascadingParameter]
public HttpContext? HttpContext { get; set; }

HttpContext Zapouzdřuje všechny informace o jednotlivých požadavcích a odpovědích HTTP. Instance HttpContext se inicializuje při přijetí požadavku HTTP. Instance HttpContext je přístupná prostřednictvím middlewaru a aplikačních architektur, jako jsou kontrolery webového rozhraní API, Razor Stránky, SignalR, gRPC a další.

Informace o použití HttpContext s požadavkem a odpovědí HTTP naleznete v tématu Použití HttpContext v ASP.NET Core.

Přístup HttpContext ze Razor stránek

PageModel Stránky Razor zpřístupňuje PageModel.HttpContext vlastnost:

public class IndexModel : PageModel
{
    public void OnGet()
    {
        var message = HttpContext.Request.PathBase;

        // ...
    }
}

Stejnou vlastnost lze použít v odpovídajícím Razor zobrazení stránky:

@page
@model IndexModel

@{
    var message = HttpContext.Request.PathBase;

    // ...
}

Přístup HttpContext ze Razor zobrazení v MVC

Razor zobrazení v vzoru MVC zpřístupňují HttpContext prostřednictvím RazorPage.Context vlastnosti v zobrazení. Následující příklad načte aktuální uživatelské jméno v intranetové aplikaci pomocí ověřování systému Windows:

@{
    var username = Context.User.Identity.Name;

    // ...
}

Přístup HttpContext z kontroleru

Kontrolery zpřístupňují ControllerBase.HttpContext vlastnost:

public class HomeController : Controller
{
    public IActionResult About()
    {
        var pathBase = HttpContext.Request.PathBase;

        // ...

        return View();
    }
}

Přístup HttpContext z middlewaru

Při práci s vlastními komponentami HttpContext middlewaru se předá do Invoke metody nebo InvokeAsync metody:

public class MyCustomMiddleware
{
    public Task InvokeAsync(HttpContext context)
    {
        // ...
    }
}

Přístup HttpContext z vlastních komponent

U jiných architektur a vlastních komponent, které vyžadují přístupHttpContext, se doporučuje registrovat závislost pomocí integrovaného kontejneru injektáže závislostí (DI). Kontejner DI dodává IHttpContextAccessor všechny třídy, které ho deklarují jako závislost v jejich konstruktorech:

public void ConfigureServices(IServiceCollection services)
{
     services.AddControllersWithViews();
     services.AddHttpContextAccessor();
     services.AddTransient<IUserRepository, UserRepository>();
}

V následujícím příkladu:

• UserRepository deklaruje jeho závislost na IHttpContextAccessor.
• Závislost se zadává, když DI vyřeší řetěz závislostí a vytvoří instanci UserRepository.

public class UserRepository : IUserRepository
{
    private readonly IHttpContextAccessor _httpContextAccessor;

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

    public void LogCurrentUser()
    {
        var username = _httpContextAccessor.HttpContext.User.Identity.Name;
        service.LogAccessRequest(username);
    }
}

HttpContext přístup z vlákna na pozadí

HttpContext není bezpečný pro přístup z více vláken. Čtení nebo zápis vlastností HttpContext mimo zpracování požadavku může mít za následek .NullReferenceException

Bezpečné práce na pozadí s daty HttpContext :

• Během zpracování požadavku zkopírujte požadovaná data.
• Předejte zkopírovaná data do úlohy na pozadí.
• Neodkazujte na HttpContext data v paralelních úlohách. Před spuštěním paralelních úloh extrahujte data potřebná z kontextu.

Abyste se vyhnuli nebezpečnému kódu, nikdy nepředávejte HttpContext metodu, která funguje na pozadí. Místo toho předejte požadovaná data. V následujícím příkladu je volána k SendEmailCore zahájení odesílání e-mailu. Je correlationId předán SendEmailCore, ne HttpContext. Provádění kódu nečeká na SendEmailCore dokončení:

public class EmailController : Controller
{
    public IActionResult SendEmail(string email)
    {
        var correlationId = HttpContext.Request.Headers["x-correlation-id"].ToString();

        _ = SendEmailCore(correlationId);

        return View();
    }

    private async Task SendEmailCore(string correlationId)
    {
        // ...
    }
}

IHttpContextAccessor/HttpContext v Razor součástech (Blazor)

[CascadingParameter]
public HttpContext? HttpContext { get; set; }