ASP.NET Core控制器中WebApplication与IWebHostEnvironment属性为空问题

问题 #

我正在开发一个ASP.NET Core Web API（本人对此技术较为陌生）：

控制器代码：

[Route("/")]
[ApiController]
public class APICenter : ControllerBase
{
    private WebApplicationBuilder? _appBuilder { get; set; } = WebApplication.CreateBuilder();

    private WebApplication? _currentApp { get; set; } = null;

    private IWebHostEnvironment? _envHost { get; set; } = null;

    public void OpenApp(string[] startParams)
    {
        _appBuilder = WebApplication.CreateBuilder(startParams);
        _appBuilder.Services.AddControllers();
        _appBuilder.Services.AddEndpointsApiExplorer();

        _currentApp = _appBuilder.Build();

        _currentApp.UseHttpsRedirection();
        _currentApp.MapControllers();

        _envHost = _currentApp.Services.GetService(typeof(IWebHostEnvironment)) as IWebHostEnvironment;

        _currentApp.Run();
    }

    [HttpGet("getdoc/{documentName}")]
    public IActionResult ReadDocument(string documentName)
    {
        string docPath = Path.Combine(_envHost!.ContentRootPath, "DocumentsFolder", documentName);
        // ... 在DocumentsFolder中查找文档并返回
    }
}

Program.cs调用代码：

public static class Program
{
    public static void Main(string[] args)
    {
        new APICenter().OpenApp(args);
    }
}

遇到的问题：

• ReadDocument方法中，尽管_envHost在OpenApp方法中已正确赋值，但在ReadDocument中却为空；同时_currentApp也为空，唯独_appBuilder仍有值。
• 尝试将三个属性的赋值代码移到构造函数中，运行API时抛出异常：InvalidOperationException: Unable to resolve service for type 'System.String[]' while attempting to activate 'MyAPI.APICenter'

请问为何这两个属性为空而第三个属性有值？有没有办法让它们保持赋值状态？或者，有没有办法通过ControllerBase或WebApplicationBuilder成员获取ContentRootPath的值？

解答 #

一、属性为空的原因 #

你的写法完全违背了ASP.NET Core的控制器生命周期规则：

• 在Main方法中new APICenter()创建的实例，和后续处理HTTP请求时ASP.NET Core框架自动创建的APICenter控制器实例不是同一个对象。
• 你在OpenApp里赋值的是Main中那个实例的_envHost和_currentApp，但处理ReadDocument请求时，框架会新建一个APICenter实例，这个新实例的_envHost和_currentApp都是默认的null；而_appBuilder因为有初始赋值WebApplication.CreateBuilder()，所以新实例中它有值。

二、正确的解决方案（符合ASP.NET Core规范） #

放弃在控制器内部启动WebApplication的错误写法，回到框架的标准流程：

1. 重构Program.cs为标准写法

var builder = WebApplication.CreateBuilder(args);
// 注册控制器服务
builder.Services.AddControllers();
builder.Services.AddEndpointsApiExplorer();

var app = builder.Build();
// 配置中间件
app.UseHttpsRedirection();
app.MapControllers();

app.Run();

2. 重构控制器，通过依赖注入获取IWebHostEnvironment

控制器不需要自己管理WebApplication的生命周期，直接通过构造函数注入IWebHostEnvironment即可拿到ContentRootPath：

[Route("/")]
[ApiController]
public class APICenter : ControllerBase
{
    // 注入IWebHostEnvironment，框架会自动提供正确的实例
    private readonly IWebHostEnvironment _envHost;

    public APICenter(IWebHostEnvironment envHost)
    {
        _envHost = envHost;
    }

    [HttpGet("getdoc/{documentName}")]
    public IActionResult ReadDocument(string documentName)
    {
        string docPath = Path.Combine(_envHost.ContentRootPath, "DocumentsFolder", documentName);
        
        // 示例逻辑：检查文件是否存在，返回对应结果
        if (!System.IO.File.Exists(docPath))
        {
            return NotFound("文档不存在");
        }
        // 返回文件流
        return PhysicalFile(docPath, "application/octet-stream", Path.GetFileName(docPath));
    }
}

三、关于构造函数报错的说明 #

你把赋值逻辑移到构造函数后报错，是因为控制器的构造函数只能接受ASP.NET Core依赖注入容器中已注册的服务类型（比如IWebHostEnvironment、ILogger等），而string[]不属于容器管理的服务，框架无法自动提供这个参数，所以抛出无法解析服务的异常。

四、获取ContentRootPath的其他方式 #

如果不想用依赖注入，也可以通过AppContext.BaseDirectory获取应用程序的基础目录（和ContentRootPath在大多数场景下一致），但这种方式不如依赖注入规范，因为IWebHostEnvironment会根据当前运行环境（开发/生产）自动适配配置，可靠性更高。

内容的提问来源于stack exchange，提问作者Jean-David Lanz