StructureMap通过注入解决依赖而不是服务定位

Question

在我的项目中，我使用程序集扫描器注册了许多 ISerializers 实现。 FWIW 这是注册我的 ISerializers 的代码，

Scan(scanner =>
{
    scanner.AssemblyContainingType<ISerializer>();
    scanner.AddAllTypesOf<ISerializer>().NameBy(type => type.Name);
    scanner.WithDefaultConventions();
});

然后它会正确注册

ISerializer (...ISerializer)
Scoped as:  Transient

JsonSerializer    Configured Instance of ...JsonSerializer
BsonSerializer    Configured Instance of ...BsonSerializer

等等。

目前，我能够弄清楚如何解析我想要的序列化器的唯一方法是使用

jsonSerializer = ObjectFactory.GetNamedInstance<ISerializer>("JsonSerializer");

现在我知道在我的类中我特别想要 jsonSerializer 来硬编码服务位置调用，所以有没有办法配置规则或类似的方法这表示 ISerializer 根据属性名称连接命名实例？这样我就可以

MySomeClass(ISerializer jsonSerializer, ....)

And StructureMap 正确解决这种情况？或者我是否采取了错误的做法，也许我应该注册实现 ISerializer 的具体类型，然后专门用于

MySomeClass(JsonSerializer jsonSerializer, ....)

具体类中的某些内容？

Answer 1

当您进行依赖注入并需要能够创建给定接口的特殊类型实例时，建议的解决方案是创建专用工厂类。这允许您使用命名参数而无需实际注入容器。

示例

这是您将注入的抽象类型：

public interface ISerializerFactory
{
    ISerializer GetSerializer(string name);
}

这是具体类型，它使用您的容器（StructureMap）：

public class StructureMapSerializerFactory : ISerializerFactory
{
    public ISerializer GetSerializer(string name)
    {
        return ObjectFactory.GetNamedInstance<ISerializer>(name);
    }
}

然后您的类将如下所示：

public class MyClass
{
    private readonly ISerializerFactory serializerFactory;

    public MyClass(ISerializerFactory serializerFactory)
    {
        if (serializerFactory == null)
            throw new ArgumentNullException("serializerFactory");
        this.serializerFactory = serializerFactory;
    }

    public string SerializeSomeData(MyData data)
    {
        ISerializer serializer = serializerFactory.GetSerializer("Json");
        return serializer.Serialize(data);
    }
}

我编写了传递“Json”而不是“ JsonSerializer”，它不会自动工作。但我认为您应该更改您的注册名称以消除多余的“Serializer”后缀（我们已经知道它是一个序列化器，因为我们需要一个 ISerializer）。换句话说，创建一个像这样的方法：

private static string ExtractSerializerName(Type serializerType)
{
    string typeName = serializerType.Name;
    int suffixIndex = typeName.IndexOf("Serializer");
    return (suffixIndex >= 0) ?
        typeName.Substring(0, suffixIndex - 1) : typeName;
}

并像这样注册它：

scanner.AddAllTypesOf<ISerializer>().NameBy(type => ExtractSerializerName(type));

然后你可以使用字符串“Json”来创建它，而不是“JsonSerializer”，这会看起来不那么难看，感觉也不那么耦合。

如果你不喜欢硬编码的字符串，那么你可以做的另一件事是为你的工厂创建一个枚举：

public enum SerializationFormat { Json, Bson, Xml };

public interface ISerializerFactory
{
    ISerializer GetSerializer(SerializationFormat format);
}

public class StructureMapSerializerFactory : ISerializerFactory
{
    public ISerializer GetSerializer(SerializationFormat format)
    {
        return ObjectFactory.GetNamedInstance<ISerializer>(format.ToString());
    }
}

因此，不要写这个：

ISerializer serializer = serializerFactory.GetSerializer("Json");

你可以写这个：

ISerializer serializer =
    serializerFactory.GetSerializer(SerializationFormat.Json);

这 将在从长远来看。

从长远来看，这可能更易于维护，因为如果您开始更改序列化器的类名和/或名称不一致，那么您可以将简单的 ToString() 替换为 switch 语句并将枚举值实际映射到您正在注册的类名。

我可能会将所有这些代码（包括问题中的自动注册代码）放在同一个命名空间中，甚至同一个代码文件中，以清楚地表明这些部分都是相互依赖的。

Answer 2

据我所知，这并不是程序集扫描功能的真正用途。当单个程序集具有多种不同接口的实现（例如IRepository、IRepository等）时，它会更有用。 。因此，例如，当您引用测试程序集时，您将注入测试存储库，而当您在生产中时，您将注入实体框架存储库。

就您而言，您的任何示例似乎都没有完全注入依赖项。换句话说，当您编写时，

ObjectFactory.GetNamedInstance<ISerializer>("JsonSerializer");

您仍然通过对字符串进行硬编码来依赖于 Json 序列化器，并且 StructureMap 从该调用中返回某种其他类型的序列化器是没有意义的。

我无法确切地告诉您要使用 StructureMap 完成什么，但是如果您需要根据一组特定的运行时条件返回特定的序列化器，您可以查看 条件构造。

另一方面，这听起来并不像您想要的那样，所以您绝对应该考虑摆脱它。毕竟，上面的代码确实与

new JsonSerializer();

StructureMap 没有什么不同，它是一个很棒的工具，但并不是每个项目都需要它。

祝你好运！

Answer 3

由于您的代码假设它正在获取 JsonSerializer，因此创建一个仅由 JsonSerializer 实现的新 IJsonSerializer 接口。任何需要 JsonSerializer 的类都应该接受 IJsonSerializer。如果您仍然需要 ISerializer 接口在所有序列化器中通用，则可以将 IJsonSerializer 用作标记接口。

或者，当您在 StructureMap 中注册您的类时，您可以将特定的 ISerializer 实现绑定到您的类。

x.For<MySomeClass>().Use(c => new MySomeClass(c.GetInstance<JsonSerializer>()));

Answer 4

我很好奇。 ISerializer 本身增加了什么价值？让我们从具体的实现转向运行时选择的一个或多个。

如果您的类型依赖于特定类型的序列化器，请对其进行依赖（IJsonSerializer）。这要求向容器注册该类型的默认实例。

但是，如果您更多地考虑将 ISerializers 作为 策略，您将注册所有 ISerializers，然后依赖于它们的数组，StructureMap 将推入所有已注册 ISerializer 的数组。然后，使用这些序列化器的类负责选择要使用的序列化器。

在策略场景中，您可能需要序列化器上的一些元数据，供您的协调类使用来区分它们。恕我直言，这实际上不应该是容器配置，例如注册类型的名称，而是实现本身的元数据。