依赖注入


layout: docs-default

依赖注入

这一节的例子可以看 here

IdentityServer3 有很多扩展点支持不同的服务。默认的服务实现设计成相互解耦,可以独立替换。为了实现这个目标,我们使用依赖注入来把所有的服务组装起来。

注入 IdentityServer 服务

如果需要,IdentityServer托管程序可以替换默认服务。自定义的服务实现也可以使用依赖注入,IdentityServer的类型和用户自定义的类型都可以注入。注意,注入只支持通过Registration注册的服务和存储。
对于使用IdentityServer类型的自定义服务,可以在构造函数里指定依赖关系。
当IdentityServer实例化注册的类型时,构造函数里的参数会被自动构建。比如:

public class MyCustomTokenSigningService: ITokenSigningService
{
    private readonly IdentityServerOptions _options;

    public MyCustomTokenSigningService(IdentityServerOptions options)
    {
        _options = options;
    }

    public Task<string> SignTokenAsync(Token token)
    {
        // ...
    }
}

用如下方法注册:

var factory = new IdentityServerServiceFactory();
factory.TokenSigningService = new Registration<ITokenSigningService>(typeof(MyCustomTokenSigningService));

或者使用简化语法:

var factory = new IdentityServerServiceFactory();
factory.TokenSigningService = new Registration<ITokenSigningService, MyCustomTokenSigningService>();

注入自定义服务

你的自定义服务可能依赖于你自己的类型。
通过在IdentityServer的依赖注入系统中配置,自定义的类型也可以注入。
通过使用IdentityServerServiceFactoryRegister()方法来实现,比如:如果需要把自定义的日志服务注入到自己的服务里面:

public interface ICustomLogger
{
    void Log(string message);
}

public class DebugLogger : ICustomLogger
{
    public void Log(string message)
    {
        Debug.WriteLine(message);
    }
}

public class MyCustomTokenSigningService: ITokenSigningService
{
    private readonly IdentityServerOptions _options;
    private readonly ICustomLogger _logger;

    public MyCustomTokenSigningService(IdentityServerOptions options, ICustomLogger logger)
    {
        _options = options;
        _logger = logger;
    }

    public Task<string> SignTokenAsync(Token token)
    {
        // ...
    }
}

为了注入ICustomLogger,我们需要等级ICustomLogger和MyCustomDebugLogger的关系:

var factory = new IdentityServerServiceFactory();
factory.TokenSigningService = new Registration<ITokenSigningService, MyCustomTokenSigningService>();
factory.Register(new Registration<ICustomLogger, MyCustomDebugLogger>());

没有接口的服务

上面的例子我们注入了 ICustomLogger ,它的实现是 MyCustomDebugLogger.如果自定义服务没有设计成接口实现分离的方式,我们可以直接注册实体类型来注入。

例如: MyCustomTokenSigningService的构造函数不接受日志接口类型,而是接受日志实体类型。

public class MyCustomTokenSigningService: ITokenSigningService
{
    public MyCustomTokenSigningService(IdentityServerOptions options, MyCustomDebugLogger logger)
    {
        _options = options;
        _logger = logger;
    }

    // ...
}

我们需要把实体类型注入配置成下面的样子:

var factory = new IdentityServerServiceFactory();
factory.TokenSigningService = new Registration<ITokenSigningService, MyCustomTokenSigningService>();
factory.Register(new Registration<MyCustomDebugLogger>());

简单说,上面的注册方式意味着MyCustomDebugLogger实体类会被注入到依赖的服务中。

自定义类型创建

如果自定义服务需要手动构建(比如有些特殊的参数必须自己配置,不能依赖于注入),这时候,我们可以用Registration类,传入一个工厂回调函数,这个Registration构造方法前面如下:

new Registration<T>(Func<IDependencyResolver, T> factory) 

这个回调函数必须返回一个实现T接口的对象,如下代码:

var factory = new IdentityServerServiceFactory();
factory.TokenSigningService = new Registration<ITokenSigningService>(resolver =>
    new MyCustomTokenSigningService("SomeSigningKeyValue")
);

获取其它依赖

上面的方法已经很灵活啦,但是你可能需要更精巧的依赖注入。比如你可能依赖于其它服务。这时候IDependencyResolver开始展现威力啦。它允许你从回调函数中取到服务。比如,你自定义的客户端存储依赖于来自IdentityServer的另一个服务,他可以用下面的方式来得到:

var factory = new IdentityServerServiceFactory();
factory.TokenSigningService = new Registration<ITokenSigningService>(resolver =>
    new MyCustomTokenSigningService("SomeSigningKeyValue", resolver.Resolve<ICustomLogger>())
);

命名依赖

最后,当我们通过IdentityServerServiceFatoryRegister()方法注册依赖时,我们可以给这个依赖名字。这个名字通过Registeration构造函数的name参数来指定。这个只用于自定义注册的以来,这个名字也只能在自定义服务里面,使用IDependencyResolver方法解决依赖时使用。
命名依赖在一个T接口有多个实现时特别有用,比如:

string mode = "debug"; // or "release", for example

var factory = new IdentityServerServiceFactory();

factory.Register(new Registration<ICustomLogger, MyFileSystemLogger>("debug"));
factory.Register(new Registration<ICustomLogger, MyDatabaseLogger>("release"));

factory.TokenSigningService = new Registration<ITokenSigningService>(resolver =>
    new MyCustomTokenSigningService(resolver.Resolve<ICustomLogger>(mode))
);

这个例子中mode做为配置项,决定了运行的时候到底使用哪一个ICustomLogger具体实现。

注册模式的实例化

Registration 类允许服务指定一个服务有多少个实例可以创建,Mode属性是一个枚举,可选值如下:

  • InstancePerHttpRequest
    每次请求创建一个实例。这意味着如果服务在一次请求中,申请了两次某个依赖,会得到同样的实例。
  • InstancePerUse
    为服务里每次独立的请求创建一个实例。也就是说如果自定义服务在不同的代码段请求了某个依赖,那么会得到不同的实例。
  • Singleton
    只有一个实例会被创建。当传给Registration构造函数一个单例对象的时候,这个模式会自动启用。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 161,780评论 4 369
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,424评论 1 305
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 111,397评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,576评论 0 218
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,997评论 3 295
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,945评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,107评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,850评论 0 208
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,625评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,804评论 2 253
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,285评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,613评论 3 261
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,291评论 3 242
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,164评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,963评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,096评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,886评论 2 278

推荐阅读更多精彩内容