如何在 C# 中为插件创建 Icon 属性？

Question

我已经根据常见做法创建了自己的插件架构，但我仍坚持使用图标。

首先，我的插件定义了主机使用的客户端，每个客户端都定义了如下属性：

[Client("Heroes of Newerth", "Heroes of Newerth Chat Client", "hon_16.png")]

有了这个，我的主机应用程序可以读取插件/客户端的元信息，而无需实际创建它的实例，但我坚持使用图标部分。

如上面的示例所示，客户端可以传递位图文件名，在我的属性实现中，我可以这样处理它：

[AttributeUsage(AttributeTargets.Class)]
public class ClientAttribute : Attribute
{
    private string _name;
    private string _description;
    private Bitmap _icon;

    public string Name { get { return this._name; } }
    public string Description { get { return this._description; } }
    public Bitmap Icon { get { return this._icon; } }

    public ClientAttribute(string Name, string Description, string IconFile = null)
    {            
        this._name = Name;
        this._description = Description;
        this._icon = new Bitmap(IconFile);
    }
}

问题是，在这个方法中，我需要按原样发布我的版本的图标文件，并且无法添加它们到资源。我很高兴听到一种仍然可以将图标嵌入到资源中的方法。

Answer 1

您可以将它们添加到资源中，然后从自定义属性访问资源。但是，您需要对插件程序集的引用，因此无法在构造函数中执行此操作。我会这样做：

[AttributeUsage(AttributeTargets.Class)]
public class ClientAttribute : Attribute
{
    private string _name;
    private string _description;
    private string _resourceName;
    private Bitmap _icon;

    public string Name { get { return this._name; } }
    public string Description { get { return this._description; } }
    public Bitmap Icon { get { return this._icon; } }

    public ClientAttribute(string name, string description, string resourceName = null)
    {
        _name = name;
        _description = description;
        _resourceName = resourceName;
    }

    public void ResolveResource(Assembly assembly)
    {
        if (assembly != null && _resourceName != null)
        {
            var stream = assembly.GetManifestResourceStream(_resourceName);
            if (stream != null)
                _icon = new Bitmap(stream);
        }
    }
}

当然，这意味着当您第一次检索自定义属性时，Icon 属性将返回 null，直到您使用正确的程序集调用 Resolve 为止。我已经编写了它，以便在出现问题时它保持为空；您需要决定是否要抛出异常。特别是，当 _icon 为 null 但 _resourceName 不是 null 时，Icon 属性 getter 可能应该抛出异常，因为这意味着 >Resolve 未调用，或者存在问题。 （您仍然应该注意，即使 Resolve 也可能会抛出异常，因为 GetManifestResourceStream 或 Bitmap 构造函数可能会抛出异常。）

Answer 2

无法将它们添加到资源

为什么不呢？您可以将 IconFile 定义为与插件位于同一程序集中的资源名称。然后，给定包含插件的 Assembly，调用 assembly.GetManifestResourceStream 并将该流传递给 Bitmap 构造函数。

Answer 3

感谢 timwi 这是我的最终实现；

    internal void ResolveResources(Assembly _assembly)
    {
        if (_assembly != null && this._icon_name != null)
        {                   
            var stream = _assembly.GetManifestResourceStream(string.Format("{0}.Resources.{1}",_assembly.GetName().Name,this._icon_name));
            if (stream != null) this._icon = new Bitmap(stream);
        }
    }

在我的 PluginInfo 类中，我调用解析器；

            else if(t.IsSubclassOf(typeof(Client)))
            {
                object[] _attr = t.GetCustomAttributes(typeof(ClientAttribute), true);
                (_attr[0] as ClientAttribute).ResolveResources(this._assembly);
            }