如何在控制器中注入HttpHeader值

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

[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*，使其对所有控制器都可用，这样我们就不必将其注入任何控制器中？

这里有什么更好的选择？

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

不能将值本身注入到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;
    }
}

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

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];
        }
    }
}

然后在启动的配置服务方法中注册适配器

 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;
    }
}

根据您的需要，以下其中一个是合适的：

如果您需要操作级别的标头值，那么使用FromHeaderAttribute听起来更好(更轻、更容易(
如果您需要在较低的层(如Repository或DAL(中使用此标头值，这些层将在初始化Controller之前进行实例化，那么请考虑使用中间件来初始化标头值并可用于其他组件

相关内容

最新更新

热门标签：