.net6接口多个实现类使用特性标记并解析

.NET 6 中接口多实现类的特性标记与解析技巧

在 .NET 6 的开发中，我们常常会遇到一个接口有多个实现类的情况。为了更好地管理和使用这些实现类，使用特性（Attribute）来标记它们并在运行时进行解析是一种非常有效的方法。今天，咱们就详细探讨一下如何在 .NET 6 里实现这一功能。

特性标记的实现思路

特性就像是给实现类贴上的“标签”，可以帮助我们在众多实现类中准确地识别和选择所需的类。首先，我们需要定义一个自定义特性。下面是定义特性的示例代码：

[AttributeUsage(AttributeTargets.Class, Inherited = false, AllowMultiple = false)]  
public class ServiceImplementationAttribute : Attribute  
{  
    public string Name { get; }  

    public ServiceImplementationAttribute(string name)  
    {  
        Name = name;  
    }  
}

在这段代码中，我们定义了一个名为 ServiceImplementationAttribute 的特性。AttributeUsage 特性指定了这个自定义特性只能应用于类，且不能被继承，每个类只能应用一次。Name 属性用于存储一个字符串，它可以作为实现类的唯一标识。

多实现类的创建与标记

有了特性之后，我们就可以创建多个实现类并给它们贴上特性“标签”。示例代码如下：

public interface IMyService { }  

[ServiceImplementation("A")]  
public class MyServiceA : IMyService { }  

[ServiceImplementation("B")]  
public class MyServiceB : IMyService { }

这里，我们定义了一个接口 IMyService，然后创建了两个实现类 MyServiceA 和 MyServiceB，并分别用 ServiceImplementation 特性标记，分别赋予名称 “A” 和 “B”。这样，每个实现类就有了一个独特的标识。

服务注册的实现

接下来，我们需要将这些标记好的实现类注册到依赖注入容器中。这就需要编写一个服务注册器来扫描程序集并完成注册工作。示例代码如下：

public static class ServiceRegistrar  
{  
    public static void RegisterServices(IServiceCollection services, Assembly assembly)  
    {  
        var types = assembly.GetTypes()  
            .Where(t => t.GetInterfaces().Contains(typeof(IMyService)) && t.GetCustomAttribute<ServiceImplementationAttribute>() != null)  
            .ToList();  

        foreach (var type in types)  
        {  
            var attribute = type.GetCustomAttribute<ServiceImplementationAttribute>();  
            services.AddScoped(typeof(IMyService), type).WithName(attribute.Name);  
        }  
    }  
}

在这个注册器中，我们首先通过 assembly.GetTypes() 获取程序集中的所有类型，然后筛选出实现了 IMyService 接口且带有 ServiceImplementationAttribute 特性的类型。接着，我们遍历这些类型，获取每个类型的特性名称，并将其注册到服务容器中。不过要注意，IServiceCollection 扩展方法 .WithName() 在标准的 .NET DI 容器中并不存在，你可以实现这个扩展方法，或者使用其他方式来存储服务的名称。

服务注册的调用

在 Startup.cs 或 Program.cs 中，我们需要调用这个注册器来完成服务的注册。示例代码如下：

var builder = WebApplication.CreateBuilder(args);  

var assembly = Assembly.GetExecutingAssembly(); // 或者其他包含服务的程序集  
builder.Services.AddControllers();  
ServiceRegistrar.RegisterServices(builder.Services, assembly);  

var app = builder.Build();  

app.Run();

在这段代码中，我们创建了一个 WebApplicationBuilder 实例，获取当前执行的程序集，将控制器服务添加到容器中，然后调用 ServiceRegistrar 的 RegisterServices 方法来注册我们标记好的服务实现类，最后构建并运行应用程序。

服务的解析与使用

服务注册完成后，我们就可以在需要的地方根据特性名称来解析服务了。示例代码如下：

public class SomeConsumer  
{  
    private readonly IServiceProvider _serviceProvider;  

    public SomeConsumer(IServiceProvider serviceProvider)  
    {  
        _serviceProvider = serviceProvider;  
    }  

    public void DoSomething()  
    {  
        var myServiceA = _serviceProvider.GetRequiredService<IMyService>("A"); // 根据特性名称"A"解析MyServiceA  
        var myServiceB = _serviceProvider.GetRequiredService<IMyService>("B"); // 根据特性名称"B"解析MyServiceB  

        // ... 使用服务 ...  
    }  
}

在这个 SomeConsumer 类中，我们通过构造函数注入了 IServiceProvider 实例。在 DoSomething 方法中，我们使用 GetRequiredService 方法根据特性名称来解析所需的服务实现类。需要注意的是，从 .NET 6 开始，DI 容器内置了对命名服务的支持，使用 GetRequiredService 方法在找不到服务时会抛出异常，而 GetService 方法在找不到服务时会返回 null。所以在使用 GetRequiredService 时，要确保服务已经被正确注册，并且传递的名称与注册时使用的名称完全匹配。

总结

通过特性标记和解析，我们可以更灵活地管理接口的多个实现类。不过，这种方式需要编写一些自定义逻辑，并且要确保这些逻辑与 DI 容器的行为相兼容。上面的示例只是一个基本的框架，在实际开发中，你可能需要根据具体需求进行调整和扩展。希望这篇文章能帮助你更好地掌握在 .NET 6 中使用特性标记和解析接口多实现类的技巧。 ======================================================================
前些天发现了一个比较好玩的人工智能学习网站，通俗易懂，风趣幽默，可以了解了解AI基础知识，人工智能教程，不是一堆数学公式和算法的那种，用各种举例子来学习，读起来比较轻松，有兴趣可以看一下。
人工智能教程