依赖注入
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的依赖注入系统中配置，自定义的类型也可以注入。
通过使用IdentityServerServiceFactory的Register()方法来实现，比如：如果需要把自定义的日志服务注入到自己的服务里面：
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>())
);
命名依赖
最后，当我们通过IdentityServerServiceFatory的Register()方法注册依赖时，我们可以给这个依赖名字。这个名字通过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构造函数一个单例对象的时候，这个模式会自动启用。
