9

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

这里有什么更好的选择？

4

3 回答 3

13

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

您不能将值本身注入 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;
    }
}
于 2016-09-12T23:18:11.537 回答
5

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

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;
    }
}
于 2016-09-12T23:28:20.790 回答
2

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

  • 如果您需要操作级别的标题值，那么使用 FromHeaderAttribute 听起来更好（更轻更容易）。
  • 如果您需要在 Repository 或 DAL 等较低层中使用此标头值，它将在 Controller 初始化之前实例化，那么请考虑使用中间件来获取已初始化的标头值并可用于其他组件。
于 2018-07-31T09:39:49.540 回答