Search code examples
c#wpfmvvmmefcaliburn.micro

How Caliburn.micro uses MEF to import custom plugins


I have some extension plugins in the plugins directory. I am going to import plugins in ViewModel and use it, but I can not import it successfully. I think I have no way to successfully configure the Configure, seek advice。

BootStrapper:

public class AppBootstrapper : BootstrapperBase
{
    private CompositionContainer container;

    public AppBootstrapper()
    {
        Initialize();
    }

    protected override void Configure()
    {
        string pluginPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "plugins");
        if (!Directory.Exists(pluginPath))
            Directory.CreateDirectory(pluginPath);

        var fi            = new DirectoryInfo(pluginPath).GetFiles("*.dll");
        AssemblySource.Instance.AddRange(fi.Select(fileInfo => Assembly.LoadFrom(fileInfo.FullName)));

        var catalog       = new AggregateCatalog(AssemblySource.Instance.Select(x => new AssemblyCatalog(x)).OfType<ComposablePartCatalog>());
        var batch         = new CompositionBatch();
        container         = new CompositionContainer(catalog);

        batch.AddExportedValue(container);
        batch.AddExportedValue<IWindowManager>(new WindowManager());

        batch.AddExportedValue<IEventAggregator>(new EventAggregator());
        batch.AddExportedValue(catalog);

        container.Compose(batch);
    }

    protected override void BuildUp(object instance)
    {
        base.BuildUp(instance);
    }

    protected override object GetInstance(Type service, string key)
    {
        var contract = string.IsNullOrEmpty(key) ? AttributedModelServices.GetContractName(service) : key;
        var exports = this.container.GetExportedValues<object>(contract);

        if (exports.Any())
        {
            return exports.First();
        }

        throw new Exception(string.Format("Could not locate any instances of contract {0}.", contract));
    }

    protected override IEnumerable<object> GetAllInstances(Type service)
    {
        return this.container.GetExportedValues<object>(AttributedModelServices.GetContractName(service));
    }

    protected override void OnStartup(object sender, StartupEventArgs e)
    {
        DisplayRootViewFor<IShell>();
    }
}

ViewModel

 [ImportMany]
 IEnumerable<Lazy<IPlugin, IPluginsMetaData>> plugins;

Solution

  • In fact, my Bootstrapper and no problem, the problem appears in my IPlugin class. In the process of finding the problem, I also found Bootstrapper Configure method in another way to write. I will put the entire plug-in code are posted for everyone to refer to the next ~

    BootStrapper Configure

    protected override void Configure()
    {
        var catalog = new AggregateCatalog(AssemblySource.Instance.Select(x => new AssemblyCatalog(x)).OfType<ComposablePartCatalog>());
        var batch   = new CompositionBatch();
        var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "plugins");
    
        if (!Directory.Exists(path))
            Directory.CreateDirectory(path);
    
        catalog.Catalogs.Add(new DirectoryCatalog(path));
        container = new CompositionContainer(catalog);
    
        batch.AddExportedValue(container);
        batch.AddExportedValue<IWindowManager>(new WindowManager());
    
        batch.AddExportedValue<IEventAggregator>(new EventAggregator());
        batch.AddExportedValue(catalog);
    
        container.Compose(batch);
    }
    

    ShellViewModel

    [Export(typeof(IShell))] 
    public class ShellViewModel : Conductor<object>, IShell
    {
        [ImportMany]
        IEnumerable<Lazy<IPlugin, IPluginMetaData>> plugins;
    }
    

    IPlugin

    public interface IPlugin
    {
         void Do();
    }
    
    public interface IPluginMetaData 
    {
         string Name { get; }
    
         string Code { get; }
    
         //[... more attribute ...]
    }
    
    [MetadataAttribute]
    [AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
    public class PluginExportAttribute : ExportAttribute, IPluginMetaData
    {
        public string Name { get; set; }
    
        public string Code { get; set; }   
    
        //[... more attribute ...]
    
        public PluginExportAttribute() : base(typeof(IPlugin)) { }
    }
    

    PluginOne

    [PluginExport(Name = "PluginOne", Code = "Key")]
    public class PluginOne : IPlugin
    {
         public void Do()
         {
           Console.WriteLine("I'm PluginOne");
         } 
    }