如何实现与每个实现的附加参数/信息的接口

时间:2018-03-06 15:24:15

标签: c# dependency-injection interface

我的MVC webapp允许用户添加和删除图像。 UI在我的业务层中调用ImageService.SaveImage(...),该内部使用一个标志告诉方法保存到Azure或文件系统。我最终可能会添加S3,我认为这里的界面效果很好。

这就是我在ImageService类中对代码进行成像的样子。它不关心文件的保存方式或位置。

// Service the UI uses
public static class ImageService
{
    public static void SaveImage(byte[] data, IImageProvider imageProvider)
    {
        string fileName = "some_generated_name.jpg"
        imageProvider.Save(fileName, data);
    }
}

所以我创建了这些实现

public interface IImageProvider
{
    void Save(string filename, byte[] imageData);
    byte[] Get(string filename);
    void Delete(string filename);
}

// File system implementation
public class FSImageProvider : IImageProvider
{
    public void Delete(string filename)
    {
        File.Delete(filename);
    }

    public byte[] Get( filename)
    {
        return File.ReadAllBytes(filename);
    }

    public void Save(string filename, byte[] imageData)
    {
        File.WriteAllBytes(filename, imageData);
    }
}

// Azure implementation
public class AzureBlobImageProvider : IImageProvider
{
    private string _azureKey = "";
    private string _storageAccountName = "";

    public AzureBlobImageProvider(string azureKey, string storageAccount)
    {
        _azureKey = azureKey;
        _storageAccountName = storageAccount;
    }

    public void Delete(string filename)
    {
        throw new NotImplementedException();
    }

    public byte[] Get(string filename)
    {
        throw new NotImplementedException();
    }

    public void Save(string filename, byte[] imageData)
    {
        throw new NotImplementedException();
    }
}

问题1)传递每个提供商可能需要的其他信息的最佳方式是什么?即Azure需要知道容器名称,blob名称(文件名)和storageAccount名称。 S3可能还需要更多。一个很好的例子是文件路径。对于每个提供商而言可能不同,或者根本不存在。 Azure需要容器名称,文件系统需要目录名称。如果每个提供商的不同之处,我将如何将其添加到界面?

问题2)我应该使用依赖注入来解析业务层中ImageService类中的接口,还是应该在UI中解析它并将其传递给类?

7 个答案:

答案 0 :(得分:4)

首先,将 IImageProvider 传递给 SaveImage 方法有一个主要的架构缺点。在需要跨方法控制 IImageProvider 的生命周期的情况下,您需要这种函数签名。在你的情况下,你只是保存图像,几乎不关心任何类的任何生命周期,但仍然使用这种方法,它最终会混乱你的代码,呃 - 你甚至不关心这个提供者(这就是为什么你把它包装到接口我假设的原因)

问问自己:

  

“我的IImageProvider实际上是否在ImageService之外的任何地方使用过?   如果没有,为什么每个人(方法,类)都需要知道它   实存?“

其次,而不是创建提供程序 - 使您的 ImageService 简单类(删除静态),为它定义接口,并为Azure / FS /等实现。对于混凝土施工使用工厂:

public interface IImageService
{
    void SaveImage(byte[] bytes);
}

public interface IImageServiceFactory
{
    IImageService Create(/*here goes enum, string, connections strings, etc*/);
}


internal sealed class AzureImageService : IImageService {/*implmentation*/}
internal sealed class FileSystemImageService : IImageService {/*implmentation*/}

<强>总体

不要在方法中传递依赖项。您的方法应该看起来很简单,没有像 ILogger IImageProvider 等任何混乱,您认为这些内容很好。如果你在某些实现中需要它们 - 只需创建类,通过构造函数获取所需的所有依赖项(因此 static 修饰符几乎总是被禁止并仅用于语言的扩展)。您可以更轻松地管理您的相关性并重构您的代码,而不会在不需要的地方不断重复使用相同的界面。

答案 1 :(得分:4)

通常这种类型的实现特定数据将在具体类构造函数中提供,就像您在示例中所做的那样。

我不会在UI中创建具体实例。您可以使用依赖项注入,也可以使用一组工厂类来创建具有正确配置的实例。关键是您希望将这些服务的配置集中到一个位置,而不是在整个应用程序中散布特定于实现的代码。

答案 2 :(得分:1)

  1. 您可以考虑在配置文件中为每个实施提供额外信息,例如在您的网络应用中{1 web.config。您可以在任何实施中访问其中任何一个。

  2. 我建议使用依赖注入,而不是将IImageProvider作为参数传递。如果解决实现的逻辑足够复杂,您甚至可以使用ImageProviderResolver并使用逻辑来解析封装在那里的FileImageProviderAzureImageProvider等,并且只需调用解析器来解析ImageService

  3. 中的ImageProvider实例

答案 3 :(得分:1)

最好的方法是使Image服务类具有通用性。

     Delete A 
       From A 
 Inner Join B 
         On A.id   = B.Id 
        And A.name = B.name 
        And A.Data = b.data;

答案 4 :(得分:1)

1)这里的问题是如何为同一个界面创建不同的子类型。 您可以使用像Abstract Factory of Builder这样的创建模式来解决此问题。这两种模式都允许您封装区分签名的每个对象的构造逻辑。 将每个ImageProvider的创建封装到一个工厂中,该工厂根据需要接受不同的参数。

2)这里的问题有点宽泛。 您错过了ImageService和ImageProvider之间的类。 ImageService只需要从UI接收输入并将它们路由到实现整个​​保存逻辑的类(包括保存位置)。 如果用户需要决定保存的位置,那么您只需将参数(枚举,字符串)传递给SaveImange方法以指示目标。

你错过的类(让我们称之为SaveImageCommandHandler)负责1)根据参数创建正确的ImageProvider,2)在该类上调用Save。

要在ImageService上获取此类的实例,您可以1)使用new创建它,或者更好2)在ImageService构造函数中注入它或3)更好地使用可以即时解析依赖项的CommandDispatcher。

您的commandhandler将注入所有需要的工厂/构建器,以创建您需要的所有ImageProvider,并根据参数或内部逻辑决定调用它。

答案 5 :(得分:1)

您可以从web.config / app.config中选择要使用的图像提供程序。首先添加一些适当的配置条目:

<configuration>
  <imageProviderConfiguration>
    <imageProvider name="fsImageProvider" />
    <fsImageProvider directory="C:\Images" />
    <azureImageProvider azureKey="foo" storageAccountName="bar" />
  </imageProviderConfiguration>
</configuration>

您需要包含类才能从配置文件中访问此信息:

public class ImageProviderSection : ConfigurationSection
{
    public const string ImageProviderConfigurationSection = "imageProviderConfiguration";
    public const string ImageProviderProperty = "imageProvider";
    public const string FSImageProviderProperty = "fsImageProvider";
    public const string AzureImageProviderProperty = "azureImageProvider";

    [ConfigurationProperty(ImageProviderProperty)]
    public ImageProviderElement ImageProvider
    {
        get { return (ImageProviderElement)this[ImageProviderProperty]; }
        set { this[ImageProviderProperty] = value; }
    }

    [ConfigurationProperty(FSImageProviderProperty)]
    public FSImageProviderElement FSImageProvider
    {
        get { return (FSImageProviderElement)this[FSImageProviderProperty]; }
        set { this[FSImageProviderProperty] = value; }
    }

    [ConfigurationProperty(AzureImageProviderProperty)]
    public AzureImageProviderElement AzureImageProvider
    {
        get { return (AzureImageProviderElement)this[AzureImageProviderProperty]; }
        set { this[AzureImageProviderProperty] = value; }
    }
}
public class ImageProviderElement : ConfigurationElement
{
    private const string nameProperty = "name";
    [ConfigurationProperty(nameProperty, IsRequired = true)]
    public string Name
    {
        get { return (string)this[nameProperty]; }
        set { this[nameProperty] = value; }
    }
}
public class FSImageProviderElement : ConfigurationElement
{
    private const string directoryProperty = "directory";
    [ConfigurationProperty(directoryProperty, IsRequired = true)]
    public string Directory
    {
        get { return (string)this[directoryProperty]; }
        set { this[directoryProperty] = value; }
    }
}
public class AzureImageProviderElement : ConfigurationElement
{
    private const string azureKeyProperty = "azureKey";
    private const string storageAccountNameProperty = "storageAccountName";
    [ConfigurationProperty(azureKeyProperty, IsRequired = true)]
    public string AzureKey
    {
        get { return (string)this[azureKeyProperty]; }
        set { this[azureKeyProperty] = value; }
    }
    [ConfigurationProperty(storageAccountNameProperty, IsRequired = true)]
    public string StorageAccountName
    {
        get { return (string)this[storageAccountNameProperty]; }
        set { this[storageAccountNameProperty] = value; }
    }
}

现在,您可以确定在读取配置文件的简单工厂类中使用哪个提供程序:

public static class ImageProviderFactory
{
    public static IImageProvider GetImageProvider()
    {
        ImageProviderSection imageProviderSection = ConfigurationManager.GetSection(ImageProviderSection.ImageProviderConfigurationSection) as ImageProviderSection;
        switch (imageProviderSection.ImageProvider.Name)
        {
            case ImageProviderSection.FSImageProviderProperty:
                return new FSImageProvider();
            case ImageProviderSection.AzureImageProviderProperty:
                return new AzureImageProvider;
            default:
                throw new Exception("Invalid image provider in configuration");
        }
    }
}

将实例保存在静态类中(或者您可以使用类似的逻辑设置依赖注入):

public static class Providers
{
    public static IImageProvider ImageProvider { get; } = ImageProviderFactory.GetImageProvider();
}

每个图像提供程序类都可以从配置文件中访问它的相关配置信息:

public interface IImageProvider
{
    void Save(string filename, byte[] imageData);
    byte[] Get(string filename);
    void Delete(string filename);
}

public class FSImageProvider : IImageProvider
{
    private string _directory = string.Empty;
    public FSImageProvider()
    {
        ImageProviderSection imageProviderSection = ConfigurationManager.GetSection(ImageProviderSection.ImageProviderConfigurationSection) as ImageProviderSection;
        _directory = imageProviderSection.FSImageProvider.Directory.Trim();
        if (!_directory.EndsWith("\\"))
            _directory += "\\";
    }

    public void Delete(string filename)
    {
        File.Delete(_directory + filename);
    }

    public byte[] Get(string filename)
    {
        return File.ReadAllBytes(_directory + filename);
    }

    public void Save(string filename, byte[] imageData)
    {
        File.WriteAllBytes(_directory + filename, imageData);
    }
}

public class AzureImageProvider : IImageProvider
{
    private string _azureKey = string.Empty;
    private string _storageAccountName = string.Empty;
    public AzureImageProvider()
    {
        ImageProviderSection imageProviderSection = ConfigurationManager.GetSection(ImageProviderSection.ImageProviderConfigurationSection) as ImageProviderSection;
        _azureKey = imageProviderSection.AzureImageProvider.AzureKey;
        _storageAccountName = imageProviderSection.AzureImageProvider.StorageAccountName;
    }

    public void Delete(string filename)
    {
        throw new NotImplementedException();
    }

    public byte[] Get(string filename)
    {
        throw new NotImplementedException();
    }

    public void Save(string filename, byte[] imageData)
    {
        throw new NotImplementedException();
    }
}

但是,如果要根据图像服务中的某些参数使用不同的图像提供程序,只需从配置中删除imageProvider元素并更改工厂以在枚举上提供基于IImageProvider的(例如):

public enum ImageProviders
{
    FileSystem,
    Azure
}
public static class ImageProviderFactory
{
    public static IImageProvider GetImageProvider(ImageProviders provider)
    {
        switch (provider)
        {
            case ImageProviders.FileSystem:
                return new FSImageProvider();
            case ImageProviders.Azure:
                return new AzureImageProvider;
            default:
                throw new Exception("Invalid image provider");
        }
    }
}

答案 6 :(得分:-2)

在Net.Core中

构造函数中的其他信息:

services.AddSingleton<FSImageProvider>();

services.AddSingleton<AzureBlobImageProvider>(serviceProvider=>
    {
         return new AzureBlobImageProvider(azureKey,storageAccount);
    }
);

按键值依赖注入:

services.AddByName<IImageProvider>()
                .Add<FSImageProvider>("FSImageProvider")
                .Add<AzureBlobImageProvider>("AzureBlobImageProvider")
                .Build();

在构造函数注入中:

public constructorxxxx(IServiceByNameFactory<IImageProvider> imageProvider)
{
     IImageProvider fsImageProvider = imageProvider.GetByName("FSImageProvider");
     IImageProvider azureBlobImageProvider =  imageProvider.GetByName("AzureBlobImageProvider");
}

最好使用Enum生成每个实现的关键值(“FSImageProvider”和“AzureBlobImageProvider”),不要直接使用字符串。

获取实施代码:https://github.com/yuriy-nelipovich/DependencyInjection.Extensions