如何在控制器中注入 HttpHeader 值？答案

【问题标题】：How to inject HttpHeader value in controller?如何在控制器中注入 HttpHeader 值？
【发布时间】：2017-01-20 10:41:43
【问题描述】：

我有使用 ASP.NET Core API 开发的 Web API。每个传入的请求都插入了一个自定义标头值。例如x-correlationid。控制器使用此值记录和跟踪请求。目前我正在读取每个控制器中的值，如下所示

[Route("api/[controller]")]
public class DocumentController : Controller
{
    private ILogger<TransformController> _logger;
    private string _correlationid = null;

    public DocumentController(ILogger<DocumentController > logger)
    {
        _logger = logger;
        _correlationid = HttpContext.Request.Headers["x-correlationid"];
    }

    [HttpPost]
    public async Task<intTransform([FromBody]RequestWrapper request)
    {
        _logger.LogInformation("Start task. CorrelationId:{0}", _correlationid);

         // do something here

        _logger.LogInformation("End task. CorrelationId:{0}", _correlationid);

        return result;
    }
}

我认为这违反了 DI 规则。

我想将值注入控制器的构造函数中，而不是读取控制器构造函数中的值。
或者
中间件能否读取x-correlationid 和*somehow* 使其可供所有控制器使用，这样我们就不必将其注入任何控制器？

这里有什么更好的选择？

【问题讨论】：

stackoverflow.com/help/tagging 请不要在问题标题中强行添加标签

标签： asp.net-core asp.net-core-webapi

【解决方案1】：

我想在控制器的构造函数中注入值，而不是读取控制器构造函数中的值。

您不能将值本身注入 api 控制器的构造函数，因为在构造时 HttpContext 将是 null。

一个“注入式”选项是在您的操作中使用FromHeaderAttribute：

[HttpPost]
public async Task<int> Transform(
    [FromBody]RequestWrapper request,
    [FromHeader(Name="x-correlationid")] string correlationId)
{
    return result;
}

中间件能否读取 x-correlationid 并以某种方式使其可供所有控制器使用，这样我们就不必将其注入任何控制器？

我认为中间件解决方案可能会超出您的需求。相反，您可以创建一个派生自 Controller 的自定义基类，并让您的所有 Api 控制器都派生自该基类。

public class MyControllerBase : Controller
{
    protected string CorrelationId =>
        HttpContext?.Request.Headers["x-correlationid"] ?? string.Empty;
}

[Route("api/[controller]")]
public class DocumentController : MyControllerBase 
{
    private ILogger<TransformController> _logger;

    public DocumentController(ILogger<DocumentController> logger)
    {
        _logger = logger;
    }

    [HttpPost]
    public async Task<intTransform([FromBody]RequestWrapper request)
    {
        _logger.LogInformation($"Start task. CorrelationId:{CorrelationId}");

        // do something here

        _logger.LogInformation($"End task. CorrelationId:{CorrelationId}");
        return result;
    }
}

【讨论】：

感谢FromHeaderAttribute提供的信息。

【解决方案2】：

这就是我想出的。我想我也可以对其进行单元测试。

public interface IRequestContext
{
    string CorrelationId { get; }
}

public sealed class RequestContextAdapter : IRequestContext
{
    private readonly IHttpContextAccessor _accessor;
    public RequestContextAdapter(IHttpContextAccessor accessor)
    {
        this._accessor = accessor;
    }

    public string CorrelationId
    {
        get
        {
            return this._accessor.HttpContext.Request.Headers[Constants.CORRELATIONID_KEY];
        }
    }
}

然后在启动的configureservice方法中注册适配器

 services.AddSingleton<IRequestContext, RequestContextAdapter>();

并将其注入控制器

[Route("api/[controller]")]
public class DocumentController : Controller
{
    private ILogger<TransformController> _logger;
    private IRequestContext _requestContext = null;

    public DocumentController(ILogger<DocumentController > logger,IRequestContext requestContext)
    {
        _logger = logger;
        _requestContext = requestContext;
    }

    [HttpPost]
    public async Task<intTransform([FromBody]RequestWrapper request)
    {
        _logger.LogInformation("Start task. CorrelationId:{0}", _requestContext.CorrelationId);

         // do something here

        _logger.LogInformation("End task. CorrelationId:{0}", _requestContext.CorrelationId);

        return result;
    }
}

【讨论】：

【解决方案3】：

根据您的需要，以下之一是合适的：

如果您需要操作级别的标头值，那么使用 FromHeaderAttribute 听起来更好（更轻松、更容易）。
如果您需要在 Repository 或 DAL 等较低层中使用此标头值，它将在 Controller 初始化之前实例化，然后考虑使用中间件来获取已初始化的标头值并可供其他组件使用。

【讨论】：