依赖注入(Dependency Injection,简称DI)是为了实现各个类之间的依赖的控制反转(Inversion of Control,简称IoC )。
ASP.NET Core 中的Controller 和 Service 或者其他类都支持依赖注入。
依赖注入术语中,
Service 是一个为其他对象提供服务的类**。
Service 不是一个Web Service,与Web Service无关。
Service的使用方法一般是:
比如:
定义接口:
public interface IMyDependency
{
void WriteMessage(string message);
}
定义实现类:
public class MyDependency : IMyDependency
{
public void WriteMessage(string message)
{
Console.WriteLine($"MyDependency.WriteMessage Message: {message}");
}
}
在Services容器中注册类:
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddScoped<IMyDependency, MyDependency>();
builder.Services.AddScoped<PageModel, IndexModel>();
var app = builder.Build();
app.Run();
使用构造函数Resolve依赖对象:
public class IndexModel : PageModel
{
private readonly IMyDependency myDependency;
public IndexModel(IMyDependency myDependency)
{
myDependency = myDependency;
}
}
这样不用在IndexModel 内部再new一个IMyDependency 类的对象,而是使用构造函数传入的对象。
而由容器来维护创建Service的对象的生命周期,这个过程叫做Resolve,对象共有3种生命周期:
使用IServiceScopeFactory 实现Resolve依赖对象:
public class IndexModel : PageModel
{
private readonly IServiceScopeFactory serviceScopeFactory;
public IndexModel(IServiceScopeFactory serviceScopeFactory)
{
serviceScopeFactory = serviceScopeFactory;
}
public DoSomething()
{
using (var scope = serviceScopeFactory .CreateScope())
{
// resolve a database connection
var db = scope.ServiceProvider.GetService<IDatabaseConnection>();
// do something with it
}
}
}
注册一组Service,类似实现一个
builder.Host.UseSerilog();
需要写一个ServiceCollection的扩展类,然后在实现中注册相关的类:
namespace Microsoft.Extensions.DependencyInjection
{
public static class MyConfigServiceCollectionExtensions
{
public static IServiceCollection AddConfig(
this IServiceCollection services, IConfiguration config)
{
services.Configure<PositionOptions>(
config.GetSection(PositionOptions.Position));
services.Configure<ColorOptions>(
config.GetSection(ColorOptions.Color));
return services;
}
public static IServiceCollection AddMyDependencyGroup(
this IServiceCollection services)
{
services.AddScoped<IMyDependency, MyDependency>();
services.AddScoped<IMyDependency2, MyDependency2>();
return services;
}
}
}
然后就可以这样注册了
builder.Services
.AddConfig(builder.Configuration)
.AddMyDependencyGroup();
如何设计项目中的依赖Service:
Service的Dispose:
其余建议
static void TransientDisposablesWithoutDispose()
{
var services = new ServiceCollection();
services.AddTransient<ExampleDisposable>();
ServiceProvider serviceProvider = services.BuildServiceProvider();
for (int i = 0; i < 1000; ++ i)
{
_ = serviceProvider.GetRequiredService<ExampleDisposable>();
}
//1,000 个对象会被创建,serviceProvider 不dispose,这1000个对象就不dispose。
}