.Net WebApi中实现自动依赖注入的三种方法(最新推荐)

前言

该文仅供学习参考,如有问题请指正。

依赖关系注入 (DI) ,是一种软件设计模式,这是一种在类及其依赖项之间实现控制反转 (IoC) 的技术。 .NET 中的依赖关系注入是框架的内置部分,与配置、日志记录和选项模式一样。

生命周期

依赖注入有以下三种生命周期

瞬时 (Transient): 每次从服务容器进行请求时创建的,请求结束后销毁, 这种生存期适合轻量级、无状态的服务。
作用域(Scoped):在指定的范围内,第一次请求时会创建一个实例,重复请求时,会返回同一个实例,在处理请求的应用中,请求结束时会释放有作用域的服务。使用 Entity Framework Core 时,默认情况下 AddDbContext 扩展方法使用范围内生存期来注册 DbContext 类型。
单例(Singleton):单例生命周期是最长的生命周期,整个应用程序只会创建一个服务实例。这种生命周期适用于那些需要在整个应用程序中共享状态的服务,例如配置(Configuration)类、缓存(Cache)类等。

用反射实现自动依赖注入

定义三种生命周期的接口类

    /// <summary>
    /// 注入标记,Scoped作用域,每次请求时创建一次
    /// </summary>
    public interface IScopedDependency
    {
    }
    /// <summary>
    /// 注入标记,生命周期Singleton,服务第一次请求时创建,后续请求都使用相同的实例
    /// </summary>
    public interface ISingletonDependency
    {
    }
    /// <summary>
    /// 注入标记,生命周期Transient,每次请求时被创建,适合轻量级服务
    /// </summary>
    public interface ITransientDependency
    {
    }
}

通过GetReferencedAssemblies实现

GetReferencedAssemblies该方法只能获取当前程序集所引用的外部程序集,不能获取模式分离/间接引用的程序集
https://www.jb51.net/program/317858ubf.htm参考地址

/// <summary>
/// 动态注册所有服务
/// 约定:Interfaces(注入接口), IScopedDependency(生命周期),可以有泛型接口,其它不能再继承。
/// 注意只能注入直接引用的,间接引用的不行
/// </summary>
/// <param name="services"></param>
/// <returns></returns>
public static IServiceCollection AddDynamicinjectionService(this IServiceCollection services)
{
	//当前程序集
	var entryAssembly = Assembly.GetEntryAssembly();
	//获取当前程序集所引用的外部程序集,不能获取模式分离/间接引用的程序集
	var types = entryAssembly!.GetReferencedAssemblies()
		.select(Assembly.Load)//装载
		.concat(new List<Assembly>() { entryAssembly })//与本程序集合并
		.SelectMany(x => x.GetTypes())//获取所有类
		.Where(x => !x.IsAbstract && x.IsClass)//排除抽象类
		.Distinct();
	//获取所有继承服务标记的生命周期实现类
	var busTypes = types.Where(x => x.GetInterfaces().Any(t =>
					   t == typeof(ITransientDependency)
					|| t == typeof(IScopedDependency)
					|| t == typeof(ISingletonDependency));
	foreach (var busType in busTypes)
	{
		//过滤泛型接口
		var busInterface = busType.GetInterfaces()
			.Where(t => t != typeof(ITransientDependency)
						   && t != typeof(IScopedDependency)
						   && t != typeof(ISingletonDependency)
						   && !t.IsGenericType)
			.FirstOrDefault();
		if (busInterface == null) continue;
		if (typeof(ITransientDependency).IsAssignableFrom(busType))
			services.AddTransient(busInterface, busType);
		if (typeof(IScopedDependency).IsAssignableFrom(busType))
			services.AddScoped(busInterface, busType);
		if (typeof(ISingletonDependency).IsAssignableFrom(busType))
			services.AddSingleton(busInterface, busType);
	}
	return services;
}

在Program.cs 中添加该服务
builder.Services.AddDynamicinjectionService();

加载程序集路径实现

只自动注入该程序集路径下的服务,并且需要约定文件名称

/// <summary>
/// 把系统所有Business添加到ServiceCollection
/// 加载程序集路径动态注入
/// </summary>
/// <param name="services"></param>
/// <returns></returns>
public static IServiceCollection AddBusService(this IServiceCollection services)
{
	string rootPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
	var busAssembly = Assembly.LoadFrom(Path.Combine(rootPath, "WenYan.Service.Business.dll"));
	var busTypes = busAssembly.GetTypes().Where(w => w.Name.EndsWith("Business")).ToList();
	foreach (var busType in busTypes)
	{
		var busInterface = busType.GetInterfaces().Where(w => w.Name.EndsWith("Business")).FirstOrDefault();
		if (busInterface == null) continue;
		if (typeof(ITransientDependency).IsAssignableFrom(busType))
			services.AddTransient(busInterface, busType);
		if (typeof(IScopedDependency).IsAssignableFrom(busType))
			services.AddScoped(busInterface, busType);
		if (typeof(ISingletonDependency).IsAssignableFrom(busType))
			services.AddSingleton(busInterface, busType);
	}
	return services;
}

通过依赖注入拓展库:Scrutor,使用非常简单,主要通过 FromAssemblyOf<> 扫描程序集和 AddClasses(o) 进行筛选注册

https://github.com/khellang/Scrutor 相关详细文档

services.Scan(scan => scan
    // 扫描特定类型所在的程序集,这里是 ITransientService 所在的程序集
    .FromAssemblyOf<ITransientService>()
        // .AddClasses 在上面获取到的程序集中扫描所有公开、非抽象类型
        // 之后可以通过委托进行类型筛选,例如下面只扫描实现 ITransientService 的类型
        .AddClasses(classes => classes.AssignableTo<ITransientService>())
            // 将上面的类型作为它实现的所有接口进行注册
            // 如果类型实现了 N 个接口,那么就会有三个独立的注册
            .AsImplementedInterfaces()
            // 最后指定注册的生存期,如瞬时,作用域,还是单例
            .WithTransientLifetime()
        // 重复上面操作,比如这里扫描 IScopedService 所在的程序集
        .AddClasses(classes => classes.AssignableTo<IScopedService>())
            // 这里和上面不一样的是,这里指定只实现特定的几口,也就是只注册一次
            .As<IScopedService>()
            // 指定注册的生存期
            .WithScopedLifetime()
        // 也支持泛型注册,单个泛型参数
        .AddClasses(classes => classes.AssignableTo(typeof(IOpenGeneric<>)))
            .AsImplementedInterfaces()
        // 多个泛型参数
        .AddClasses(classes => classes.AssignableTo(typeof(IQueryHandler<,>)))