MVC5 WebAPI和依赖注入

时间:2019-04-04 08:46:43

标签: c# asp.net-web-api dependency-injection asp.net-mvc-5 asp.net-web-api2

尝试在不使用第三方工具的情况下在WebAPI2上执行一些DI。
因此,从一些示例中,我有了自定义的依赖关系解析器(为什么没有集成的依赖关系解析器?奇怪,甚至 Microsoft.Extensions.DependencyInjection 什么也没提供):

public class DependencyResolver : IDependencyResolver
    {
        protected IServiceProvider _serviceProvider;

        public DependencyResolver(IServiceProvider serviceProvider)
        {
            this._serviceProvider = serviceProvider;
        }

        public IDependencyScope BeginScope()
        {
            return this;
        }

        public void Dispose()
        {

        }

        public object GetService(Type serviceType)
        {
            return this._serviceProvider.GetService(serviceType);
        }

        public IEnumerable<object> GetServices(Type serviceType)
        {
            return this._serviceProvider.GetServices(serviceType);
        }

        public void AddService()
        {

        }
    }

然后创建了此类:

public class ServiceConfig
    {
        public static void Register(HttpConfiguration config)
        {
            var services = new ServiceCollection();
            services.AddScoped<IMyService, MyServiceClient>();

            var resolver = new DependencyResolver(services.BuildServiceProvider());
            config.DependencyResolver = resolver;
        }

    }

并注册:

protected void Application_Start()
        {
            GlobalConfiguration.Configure(WebApiConfig.Register);
            GlobalConfiguration.Configure(ServiceConfig.Register);
        }

但是当我尝试使用它时:

public class TestController : ApiController
    {
        private IMyService _myService = null;

        public TestController(IMyService myService)
        {
            _myService = myService;
        }

        public void Get()
        {
            _myService.DoWork();
        }
}

我收到错误消息“ 尝试创建类型为'TestController'的控制器时发生错误。请确保该控制器具有无参数的公共构造函数。”。
如何用正确的方法烹饪这个?

1 个答案:

答案 0 :(得分:3)

您看到的情况与this problem有关。简而言之,Web API将调用其默认的IHttpControllerActivator实现来请求新的控制器实例。该实例将调用您的DependencyResolver.GetService方法。该方法会将调用转发给MS.DI的GetService方法。但是,由于您没有将控制器注册到MS.DI容器中,它将返回null。这将导致默认的IHttpControllerActivator尝试使用反射创建控制器,但这需要默认的构造函数。由于控制器没有控制器,因此会产生相当神秘的异常消息。

因此,快速的解决方案是注册您的控制器,例如:

services.AddTransient<TestController>();

但是,这只能部分解决您的问题,因为您的IDependencyResolver实现已被破坏。它以一种丑陋的方式被破坏,因为它乍看起来似乎可以工作,但是会导致内存泄漏,因为您总是从根容器中进行解析,而不是从范围中进行解析。这将导致您解析的控制器实例(和其他一次性瞬态组件)在应用程序的生命周期内始终保持引用状态。

要解决此问题,您应该将IDependencyResolver的实现更改为以下内容:

public class DependencyResolver : IDependencyResolver
{
    private readonly IServiceProvider provider;
    private readonly IServiceScope scope;

    public DependencyResolver(ServiceProvider provider) => this.provider = provider;

    internal DependencyResolver(IServiceScope scope)
    {
        this.provider = scope.ServiceProvider;
        this.scope = scope;
    }

    public IDependencyScope BeginScope() =>
        new DependencyResolver(provider.CreateScope());

    public object GetService(Type serviceType) => provider.GetService(serviceType);
    public IEnumerable<object> GetServices(Type type) => provider.GetServices(type);
    public void Dispose() => scope?.Dispose();
}

此实现将确保在每个Web请求上创建一个新的IServiceScope,并且始终根据请求解析服务;不是来自根IServiceProvider

尽管这可以解决您的问题,但另一个实现可能还是有益的。

IDependencyResolver合同是有问题的,因为在对null的调用未导致正确的注册解决方式时,它被迫返回GetService。这意味着当您忘记注册控制器时,您将得到这些烦人的“确保控制器具有无参数的公共构造函数”错误。

因此,创建自定义IHttpControllerActivator更加容易。在这种情况下,您可以呼叫GetRequiredService,这将永远不会返回null

public class MsDiHttpControllerActivator : IHttpControllerActivator
{
    private readonly ServiceProvider provider;

    public MsDiHttpControllerActivator(ServiceProvider provider) =>
        this.provider = provider;

    public IHttpController Create(
        HttpRequestMessage request, HttpControllerDescriptor d, Type controllerType)
    {
        IServiceScope scope = this.provider.CreateScope();
        request.RegisterForDispose(scope); // disposes scope when request ends
        return (IHttpController)scope.ServiceProvider.GetRequiredService(controllerType);
    }
}

可以将此MsDiHttpControllerActivator实现添加到Web API管道中,如下所示:

GlobalConfiguration.Configuration.Services
  .Replace(typeof(IHttpControllerActivator),
    new MsDiHttpControllerActivator(services.BuildServiceProvider(true)));

这消除了使用IDependencyResolver实现的需要。不过,您仍然需要注册您的控制器:

services.AddTransient<TestController>();

还请注意,我对此进行了更改:

services.BuildServiceProvider()

对此:

services.BuildServiceProvider(true)

这是一个非常重要的更改;它可以保护您(在某种程度上)免受Captive Dependencies的侵害,Error-Description是使用DI容器时的主要问题之一。由于某些模糊的原因,BuildServiceProvider()重载默认为false,这意味着它不会验证您的范围。