【译】如何在 ASP.NET Core DI 中注册具有多个接口的服务

在本文中,我将介绍如何在 ASP.NET Core 中,将一个包含多个公共接口的具体类注册到 Microsoft.Extensions.DependencyInjection 容器中。使用这种方法,你将能够使用它实现的任何接口检索具体的类。例如,如果你有下面的类:

public class MyTestClass: ISomeInterface, ISomethingElse { }

接下来,你将会去注入 ISomeInterfaceISomethingElse 二者的其中之一,接下来,你会获取到相同的MyTestClass 实例。

有一点是很重要的,注册 MyTestClass 时须以特定的方式以避免生存周期问题。比如一个单例中有两个实例!

在本文中,我简要概述了 ASP.NET Core 中的 DI 容器和一些第三方容器相比的局限性。然后,我将介绍对一个具体类型的多接口请求“转发”的概念,以及如何在 ASP.NET Core 中的 DI 容器实现它。

TL;DR ASP.NET Core DI 容器原生并不支持多个服务实现的注册(有时被称为"转发"). 相应的,你必须手动将服务的解析委托给工厂函数,例如: services.AddSingleton<IFoo>(x=> x.GetRequiredService<Foo>())

ASP.NET Core 中的依赖注入

ASP.NET Core 的关键特性之一就是其使用了依赖注入(DI)。ASP.NET Core 框架本身是围绕 “标准容器” 这一个抽象概念设计的,它允许自身使用一些简单的容器,同时还允许你插入功能更丰富的第三方容器。

“标准容器”的想法并不是没有争议的 - 我建议你去阅读 Mark Seemann 这篇关于标准容器作为反模式的文章,或者这篇来自 SimpleInjector 团队关于 ASP.NET Core DI 容器的特殊性。

为了使第三方容器实现起来更简单,“标准容器”被设计得更简单,它公开的 API 数量非常有限。对于给定的服务(例如: IFOO ),你可以定义一个具体的类去实现它(例如: Foo),以及它的生命周期 (例如: 单例)。在这个基础上,可以直接提供服务实例,也可以提供工厂方法,但是这种方法会更复杂。

相比之下,.NET 的第三方 DI 容器通常提供更高级的注册 API. 例如, 多数 DI 容器为配置公开一个 "scan" API , 你可以通过它搜索程序集中的所有类型。然后,把它们添加到你的 DI 容器中。下面是一个 Autofac 框架的例子:

var dataAccess = Assembly.GetExecutingAssembly();

builder.RegisterAssemblyTypes(dataAccess) // 查找程序集中的所有类型
       .Where(t => t.Name.EndsWith("Repository")) // 过滤类型
       .AsImplementedInterfaces()  // 注册服务及其所有公共接口
       .SingleInstance(); // 将服务注册为单例

在这个例子中, Autofac 会找到程序集中那些所有名字以 "Repository" 结尾的具体类,并且根据他们实现的所有公共接口在容器中注册。例如,给定的下列类和接口:

public interface IStubRepository {}
public interface ICachingRepository {}

public class StubRepository : IStubRepository {}
public class MyRepository : ICachingRepository {}

前面的 Autofac 代码相当于在 ASP.NET Core 容器的 Startup.ConfigureServices 中手动注册这两个类及其各自的接口:

services.AddSingleton<IStubRepository, StubRepository>();
services.AddSingleton<ICachingRepository, MyRepository>();

不过,如果一个类实现了多个接口,会发生什么呢?

将单个实现注册为多个服务

实现多个接口的类很常见,例如:

public interface IBar {}
public interface IFoo {}

public class Foo : IFoo, IBar {}

让我们编写一个快速测试,看看如果我们使用 ASP.NET Core DI 容器对这两个接口注册该类会发生什么:

[Fact]
public void WhenRegisteredAsSeparateSingleton_InstancesAreNotTheSame()
{
    var services = new ServiceCollection();

    services.AddSingleton<IFoo, Foo>();
    services.AddSingleton<IBar, Foo>();

    var provider = services.BuildServiceProvider();

    var foo1 = provider.GetService<IFoo>(); // An instance of Foo
    var foo2 = provider.GetService<IBar>(); // An instance of Foo

    Assert.Same(foo1, foo2); // FAILS
}

我们将 Foo 注册为 IFooIBar 二者的单例,但是结果可能并不是你预计的。我们实际上有两个 Foo “单例”实例,每个都是以服务的方式被注册。

转发服务请求

针对多个服务注册实现的一般模式是常见的。大多数第三方 DI 容器框架都实现了这种概念。例如:

  • Autofac 将该种模式当作默认的模式 - 上面的测试代码已经证明了这点
  • Windsor 中有一个“转发类型”的概念,它允许你“转发”多个服务到一个单例实现中
  • StructureMap (now sunsetted) 也同样有“转发”类型的类似概念。据我所知,它的继承者 Lamar 并没有提供类似的概念,不过,我可能是错的。

鉴于这个需求非常普遍,而 ASP.NET Core DI 容器中没有,这看起来很奇怪。这个问题2年前被提出来(David Fowler) ,不过已经被关闭了。幸运的是,有一个概念上简单,但不是很优雅的解决方案。

  1. 提供一个服务实例(仅限单例)

    最简单的方法就是在注册你的服务时提供一个 Foo 实例。每个已注册的服务会在请求时返回你提供的确切实例,确保只有一个单例实例。

    [Fact]
    public void WhenRegisteredAsInstance_InstancesAreTheSame()
    {
        var foo = new Foo(); // The singleton instance
        var services = new ServiceCollection();
    
        services.AddSingleton<IFoo>(foo);
        services.AddSingleton<IBar>(foo);
    
        var provider = services.BuildServiceProvider();
    
        var foo1 = provider.GetService<IFoo>();
        var foo2 = provider.GetService<IBar>();
    
        Assert.Same(foo1, foo); // PASSES;
        Assert.Same(foo2, foo); // PASSES;
    }
    

    这里有一个非常不好的地方(警告)- 你必须在配置的时候能够实例化 Foo 对象,并且你必须知道并且提供所有关于它的依赖。在某些情况下它是有用的,但这种方式不是很灵活。

    另外,你只能用这种方法来注册单例类。如果你希望 Foo 是各自请求范围内的单例实例(Scoped模式),你很不走运,你可能须要下面的技术。

  2. 使用工厂方法实现转发

    如果我们分解我们的需求,那么替代的解决方案可能是:

    • 我们希望已注册的服务(Foo)有特殊的生命周期(例如:Singleton or Scoped)
    • IFoo 被请求,返回一个 Foo 实例
    • IBar 被请求,也返回一个 Foo 实例

    根据这三条规则,我们可以再写一个测试:

    [Fact]
    public void WhenRegisteredAsForwardedSingleton_InstancesAreTheSame()
    {
        var services = new ServiceCollection();
    
        services.AddSingleton<Foo>(); // We must explicitly register Foo
        services.AddSingleton<IFoo>(x => x.GetRequiredService<Foo>()); // Forward requests to Foo
        services.AddSingleton<IBar>(x => x.GetRequiredService<Foo>()); // Forward requests to Foo
    
        var provider = services.BuildServiceProvider();
    
        var foo1 = provider.GetService<Foo>(); // An instance of Foo
        var foo2 = provider.GetService<IFoo>(); // An instance of Foo
        var foo3 = provider.GetService<IBar>(); // An instance of Foo
    
        Assert.Same(foo1, foo2); // PASSES
        Assert.Same(foo1, foo3); // PASSES
    }
    

    为了“转发”对具体类型接口的请求,你必须做两件事:

    • 使用 services.AddSingleton<Foo>() 显示的注册具体类型
    • 通过提供工厂函数,将接口请求委托给具体的类型:services.AddSingleton<IFoo>(x => x.GetRequiredService<Foo>())

    通过这种方法,你会得到一个真正的 Foo 单例实例,无论你请求的是哪种实现的服务。

    这种提供“转发”类型的方式被记录在原始的 issue 中,顺带了一个警告 - 它不是很有效。通常最好尽可能避免“服务定位器样式” GetService() 调用。不过,我觉得在这种情况下,这绝对是更好的做法。

总结

在这篇文章中,我总结了如果你使用 ASP.NET Core DI 服务去注册一个以多服务模式的具体类型会发生什么。特别的,我展示了如何使用单例对象的多个副本,这可能会导致一些小bug。为了解决这个问题,你可以在注册的时候提供一个实例,或者使用工厂方法代理服务的解析。尽管使用工厂方法不是非常高效的,但是却是通常情况下的最好方法。

【原文】How to register a service with multiple interfaces in ASP.NET Core DI

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,589评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,615评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,933评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,976评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,999评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,775评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,474评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,359评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,854评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,007评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,146评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,826评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,484评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,029评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,153评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,420评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,107评论 2 356

推荐阅读更多精彩内容