.NET 6 Web API中Coverity检测Request空对象调用错误的解决方法咨询

问题场景 #

Coverity静态代码分析工具对以下.NET 6 Web API控制器代码：

public class WeatherForecastController : ControllerBase
{
    [HttpGet]
    public string Get()
    {
        var cid = Request.Headers["CId"];
        return cid.ToString();
    }
}

抛出Calling a method on null object base.Request错误，指向var cid = Request.Headers["CId"];这行代码。已知当前业务场景下Request绝不会为空，但尝试以下两种方案均无法消除告警：

• 使用空原谅运算符!改写为var cid = Request!.Headers["CId"];，告警依旧；
• 给Request加非空判断（if (Request != null) { var cid = Request.Headers["CId"]; }），工具提示该判断恒为真，但错误提示未消失。

可行解决办法 #

1. 改用HttpContext.Request访问请求对象 #

在.NET 6 Web API的控制器中，HttpContext属于请求上下文的核心对象，必然存在。通过HttpContext.Request访问请求头，Coverity的静态分析规则会认可这个路径的非空性，从而消除告警：

public class WeatherForecastController : ControllerBase
{
    [HttpGet]
    public string Get()
    {
        var cid = HttpContext.Request.Headers["CId"];
        return cid.ToString();
    }
}

2. 添加Coverity专属注释抑制告警 #

如果不想调整代码结构，可以直接在出错代码上方添加Coverity支持的注释，明确告知工具忽略该空引用告警：

public class WeatherForecastController : ControllerBase
{
    [HttpGet]
    public string Get()
    {
        // coverity[null_dereference]
        var cid = Request.Headers["CId"];
        return cid.ToString();
    }
}

3. 通过IHttpContextAccessor注入获取请求对象 #

依赖注入IHttpContextAccessor来获取HttpContext，进而访问Request，这种方式的非空性也能被静态分析工具识别：

public class WeatherForecastController : ControllerBase
{
    private readonly IHttpContextAccessor _httpContextAccessor;

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

    [HttpGet]
    public string Get()
    {
        var cid = _httpContextAccessor.HttpContext!.Request.Headers["CId"];
        return cid.ToString();
    }
}

需要注意，要在项目的Program.cs中注册该服务：

builder.Services.AddHttpContextAccessor();

内容的提问来源于stack exchange，提问作者user584018