如何在 ASP.NET Core 中验证 DI 容器？

Question

在我的Startup 类中，我使用ConfigureServices(IServiceCollection services) 方法设置我的服务容器，使用来自Microsoft.Extensions.DependencyInjection 的内置DI 容器。

我想在单元测试中验证依赖关系图，以检查是否可以构建所有服务，这样我就可以修复单元测试期间丢失的任何服务，而不是让应用程序在运行时崩溃。在之前的项目中，我使用了 Simple Injector，它有一个用于容器的 .Verify() 方法。但是我找不到任何与 ASP.NET Core 类似的东西。

是否有任何内置的（或至少推荐的）方法来验证整个依赖图是否可以构建？

（我能想到的最愚蠢的方法是这样的，但由于框架本身注入的开放泛型，它仍然会失败）：

startup.ConfigureServices(serviceCollection);
var provider = serviceCollection.BuildServiceProvider();
foreach (var serviceDescriptor in serviceCollection)
{
    provider.GetService(serviceDescriptor.ServiceType);
}

Answer 1

在 ASP.NET Core 3 中添加了内置 DI 容器验证，默认情况下仅在 Development 环境中启用。如果缺少某些内容，容器会在启动时引发致命异常。

请记住，默认情况下，控制器不会在 DI 容器中创建，因此在控制器被注册到 DI 之前，典型的 Web 应用不会从该检查中获得太多信息：

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()
        .AddControllersAsServices();
}

要禁用/自定义验证，请添加 IHostBuilder.UseDefaultServiceProvider 调用：

public class Program
{
    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            //...
            .UseDefaultServiceProvider((context, options) =>
            {
                options.ValidateOnBuild = false;
            });

此验证功能有几个限制，请在此处阅读更多信息：https://andrewlock.net/new-in-asp-net-core-3-service-provider-validation/

Answer 2

实际上，我只是使用了您问题中的示例并进行了一些修改，它对我来说效果很好。在我的命名空间中按类过滤背后的理论是，这些最终会询问我关心的所有其他内容。

我的测试看起来很像这样：

[Test or Fact or Whatever]
public void AllDependenciesPresentAndAccountedFor()
{
    // Arrange
    var startup = new Startup();

    // Act
    startup.ConfigureServices(serviceCollection);

    // Assert
    var exceptions = new List<InvalidOperationException>();
    var provider = serviceCollection.BuildServiceProvider();
    foreach (var serviceDescriptor in services)
    {
        var serviceType = serviceDescriptor.ServiceType;
        if (serviceType.Namespace.StartsWith("my.namespace.here"))
        {
            try
            {
                provider.GetService(serviceType);
            }
            catch (InvalidOperationException e)
            {
                exceptions.Add(e);
            }
        }
    }

    if (exceptions.Any())
    {
        throw new AggregateException("Some services are missing", exceptions);
    }
}

Answer 3

我在我的一个项目中遇到了同样的问题。我的决心：

1. 添加 AddScopedService、AddTransientService 和 AddSingletonService 等方法，将服务添加到 DI，然后将其添加到某个列表。使用此方法代替 AddScoped、AddSingleton 和 AddTransient

2. 在启动应用程序第一次时，我遍历此列表并调用 GetRequiredService。如果任何服务无法解析，应用程序将无法启动

3. 我有 CI：在提交时自动构建和部署以开发分支。因此，如果有人合并了破坏 DI 的更改，应用程序就会失败，我们都知道这一点。

4. 如果您想更快地做到这一点，您可以将 Dmitry Pavlov 的答案中的 TestServer 与我的解决方案一起使用

Answer 4

这是一个可以添加到项目中的单元测试：

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;
using [X/N]Unit;

namespace MyProject.UnitTests
{
    public class DITests
    {
        [Fact or Test]
        public void AllServicesShouldConstructSuccessfully()
        {
            Host.CreateDefaultBuilder()
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder
                        .UseDefaultServiceProvider((context, options) =>
                        {
                            options.VailidateOnBuild = true;
                        })
                        .UseStartup<Startup>();
                }).Build();
        })
    }
}