Как контролировать порядок инициализации модуля в Prism
Я использую Prism V2 с DirectoryModuleCatalog, и мне нужно, чтобы модули были инициализированы в определенном порядке. Желаемый порядок указывается с атрибутом в каждой реализации IModule.
Это делается для того, чтобы при инициализации каждого модуля они добавляли свое представление в область TabControl, а порядок вкладок должен определяться и контролироваться автором модуля.
Порядок подразумевает не зависимость, а скорее порядок, в котором они должны быть инициализированы. Другими словами: модули A, B и C могут иметь приоритеты 1, 2 и 3 соответственно. B не имеет зависимости от A - его просто нужно загрузить в область TabControl после A. Так что у нас есть детерминированный и контролируемый порядок вкладок. Кроме того, B может не существовать во время выполнения; поэтому они будут загружаться как A, C, потому что приоритет должен определять порядок (1, 3). Если бы я использовал ModuleDependency, то модуль "C" не сможет загрузить без всех своих зависимостей.
Я могу управлять логикой того, как сортировать модули, но я не могу понять, куда поместить указанную логику.
6 ответов
Мне не понравилась идея использования ModuleDependency, потому что это означало бы, что модуль a не будет загружаться, когда модуль b отсутствует, а на самом деле нет никакой зависимости. Вместо этого я создал атрибут приоритета для украшения модуля:
/// <summary>
/// Allows the order of module loading to be controlled. Where dependencies
/// allow, module loading order will be controlled by relative values of priority
/// </summary>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public sealed class PriorityAttribute : Attribute
{
/// <summary>
/// Constructor
/// </summary>
/// <param name="priority">the priority to assign</param>
public PriorityAttribute(int priority)
{
this.Priority = priority;
}
/// <summary>
/// Gets or sets the priority of the module.
/// </summary>
/// <value>The priority of the module.</value>
public int Priority { get; private set; }
}
Затем я украсил модули так:
[Priority(200)]
[Module(ModuleName = "MyModule")]
public class MyModule : IModule
Я создал новый потомок DirectoryModuleCatalog:
/// <summary>
/// ModuleCatalog that respects PriorityAttribute for sorting modules
/// </summary>
[SecurityPermission(SecurityAction.InheritanceDemand), SecurityPermission(SecurityAction.LinkDemand)]
public class PrioritizedDirectoryModuleCatalog : DirectoryModuleCatalog
{
/// <summary>
/// local class to load assemblies into different appdomain which is then discarded
/// </summary>
private class ModulePriorityLoader : MarshalByRefObject
{
/// <summary>
/// Get the priorities
/// </summary>
/// <param name="modules"></param>
/// <returns></returns>
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1822:MarkMembersAsStatic"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2001:AvoidCallingProblematicMethods", MessageId = "System.Reflection.Assembly.LoadFrom")]
public Dictionary<string, int> GetPriorities(IEnumerable<ModuleInfo> modules)
{
//retrieve the priorities of each module, so that we can use them to override the
//sorting - but only so far as we don't mess up the dependencies
var priorities = new Dictionary<string, int>();
var assemblies = new Dictionary<string, Assembly>();
foreach (ModuleInfo module in modules)
{
if (!assemblies.ContainsKey(module.Ref))
{
//LoadFrom should generally be avoided appently due to unexpected side effects,
//but since we are doing all this in a separate AppDomain which is discarded
//this needn't worry us
assemblies.Add(module.Ref, Assembly.LoadFrom(module.Ref));
}
Type type = assemblies[module.Ref].GetExportedTypes()
.Where(t => t.AssemblyQualifiedName.Equals(module.ModuleType, StringComparison.Ordinal))
.First();
var priorityAttribute =
CustomAttributeData.GetCustomAttributes(type).FirstOrDefault(
cad => cad.Constructor.DeclaringType.FullName == typeof(PriorityAttribute).FullName);
int priority;
if (priorityAttribute != null)
{
priority = (int)priorityAttribute.ConstructorArguments[0].Value;
}
else
{
priority = 0;
}
priorities.Add(module.ModuleName, priority);
}
return priorities;
}
}
/// <summary>
/// Get the priorities that have been assigned to each module. If a module does not have a priority
/// assigned (via the Priority attribute) then it is assigned a priority of 0
/// </summary>
/// <param name="modules">modules to retrieve priorities for</param>
/// <returns></returns>
private Dictionary<string, int> GetModulePriorities(IEnumerable<ModuleInfo> modules)
{
AppDomain childDomain = BuildChildDomain(AppDomain.CurrentDomain);
try
{
Type loaderType = typeof(ModulePriorityLoader);
var loader =
(ModulePriorityLoader)
childDomain.CreateInstanceFrom(loaderType.Assembly.Location, loaderType.FullName).Unwrap();
return loader.GetPriorities(modules);
}
finally
{
AppDomain.Unload(childDomain);
}
}
/// <summary>
/// Sort modules according to dependencies and Priority
/// </summary>
/// <param name="modules">modules to sort</param>
/// <returns>sorted modules</returns>
protected override IEnumerable<ModuleInfo> Sort(IEnumerable<ModuleInfo> modules)
{
Dictionary<string, int> priorities = GetModulePriorities(modules);
//call the base sort since it resolves dependencies, then re-sort
var result = new List<ModuleInfo>(base.Sort(modules));
result.Sort((x, y) =>
{
string xModuleName = x.ModuleName;
string yModuleName = y.ModuleName;
//if one depends on other then non-dependent must come first
//otherwise base on priority
if (x.DependsOn.Contains(yModuleName))
return 1; //x after y
else if (y.DependsOn.Contains(xModuleName))
return -1; //y after x
else
return priorities[xModuleName].CompareTo(priorities[yModuleName]);
});
return result;
}
}
Наконец, я изменил загрузчик, чтобы использовать этот новый каталог:
/// <summary>Where are the modules located</summary>
/// <returns></returns>
protected override IModuleCatalog GetModuleCatalog()
{
return new PrioritizedDirectoryModuleCatalog() { ModulePath = @".\Modules" };
}
Я не уверен, что вещи с загрузкой сборки - лучший способ сделать что-то, но, похоже, это работает...
Вы можете использовать ModuleDependency Атрибут класса вашего модуля, чтобы сообщить загрузчику, что ваш модуль зависит от других модулей:
[ModuleDependency("SomeModule")]
[ModuleDependency("SomeOtherModule")]
public class MyModule : IModule
{
}
Вы можете заменить IModuleInitializer по умолчанию для экземпляра пользовательского класса, который вместо инициализации модулей сразу после их загрузки сохраняет их в списке модулей. Когда все модули загружены, вы инициализируете их в любом порядке.
Как этого добиться:
1) В загрузчике переопределите метод ConfigureContainer для замены IModuleInitializer по умолчанию для экземпляра класса MyModuleInitializer, сохраняя при этом инициализатор по умолчанию с именем (например, defaultModuleInitializer):
protected override void ConfigureContainer()
{
base.ConfigureContainer();
var defaultContainer = Container.Resolve<IModuleInitializer>();
Container.RegisterInstance<IModuleInitializer>("defaultModuleInitializer", defaultContainer);
Container.RegisterType<IModuleInitializer, MyModuleInitializer>(new ContainerControlledLifetimeManager());
}
2) Создайте класс MyModuleInitializer, который выполняет требуемую процедуру storea-all-then-sort-and-initialize:
public class MyModuleInitializer : IModuleInitializer
{
bool initialModuleLoadCompleted = false;
IModuleInitializer defaultInitializer = null;
List<ModuleInfo> modules = new List<ModuleInfo>();
public MyModuleInitializer(IUnityContainer container)
{
defaultInitializer = container.Resolve<IModuleInitializer>("defaultModuleInitializer");
}
public void Initialize(ModuleInfo moduleInfo)
{
if(initialModuleLoadCompleted) {
//Module loaded on demand after application startup - use the default initializer
defaultInitializer.Initialize(moduleInfo);
return;
}
modules.Add(moduleInfo);
if(AllModulesLoaded()) {
SortModules();
foreach(var module in modules) {
defaultInitializer.Initialize(module);
}
modules = null;
initialModuleLoadCompleted = true;
}
}
private bool AllModulesLoaded()
{
//Here you check whether all the startup modules have been loaded
//(perhaps by looking at the module catalog) and return true if so
}
private void SortModules()
{
//Here you sort the "modules" list however you want
}
}
Обратите внимание, что после загрузки всех модулей запуска этот класс возвращается к простому вызову инициализатора по умолчанию. Адаптируйте класс соответствующим образом, если это не то, что вам нужно.
Я решил это с помощью атрибута ModuleDependency, и он работал как шарм
Вернув это из мертвых, я, кажется, нашел другое решение, которое некоторые могут найти полезным. Я попробовал это, и это работает, но я еще не разобрался во всех плюсах и минусах.
Я использовал DirectoryModuleCatalog, чтобы получить список всех моих модулей, которые все были помещены в одну папку. Но я заметил, что по большей части все мои модули "View" зависели от моих "Service" модулей, и это было довольно распространенным паттерном. Ни один сервис не должен зависеть от вида. Это заставило меня задуматься, что если мы просто поместим все сервисные модули в одну папку, а все модули представления в другую и создадим два разных каталога в правильном порядке. Некоторые копались, и я нашел эту статью, в которой упоминается нечто, называемое AggregateModuleCatalog, и он используется для объединения нескольких каталогов. Я нашел исходный код для этого класса здесь. И вот как я это использовал:
class Bootstrapper : UnityBootstrapper
{
protected override System.Windows.DependencyObject CreateShell() {...}
protected override void InitializeShell() {...}
protected override IModuleCatalog CreateModuleCatalog()
{
return new AggregateModuleCatalog();
}
protected override void ConfigureModuleCatalog()
{
((AggregateModuleCatalog)ModuleCatalog).AddCatalog(new DirectoryModuleCatalog { ModulePath = "Modules.Services" });
((AggregateModuleCatalog)ModuleCatalog).AddCatalog(new DirectoryModuleCatalog { ModulePath = "Modules.Views" });
}
}
И AggregateModuleCatalog:
public class AggregateModuleCatalog : IModuleCatalog
{
private List<IModuleCatalog> catalogs = new List<IModuleCatalog>();
/// <summary>
/// Initializes a new instance of the <see cref="AggregateModuleCatalog"/> class.
/// </summary>
public AggregateModuleCatalog()
{
this.catalogs.Add(new ModuleCatalog());
}
/// <summary>
/// Gets the collection of catalogs.
/// </summary>
/// <value>A read-only collection of catalogs.</value>
public ReadOnlyCollection<IModuleCatalog> Catalogs
{
get
{
return this.catalogs.AsReadOnly();
}
}
/// <summary>
/// Adds the catalog to the list of catalogs
/// </summary>
/// <param name="catalog">The catalog to add.</param>
public void AddCatalog(IModuleCatalog catalog)
{
if (catalog == null)
{
throw new ArgumentNullException("catalog");
}
this.catalogs.Add(catalog);
}
/// <summary>
/// Gets all the <see cref="ModuleInfo"/> classes that are in the <see cref="ModuleCatalog"/>.
/// </summary>
/// <value></value>
public IEnumerable<ModuleInfo> Modules
{
get
{
return this.Catalogs.SelectMany(x => x.Modules);
}
}
/// <summary>
/// Return the list of <see cref="ModuleInfo"/>s that <paramref name="moduleInfo"/> depends on.
/// </summary>
/// <param name="moduleInfo">The <see cref="ModuleInfo"/> to get the</param>
/// <returns>
/// An enumeration of <see cref="ModuleInfo"/> that <paramref name="moduleInfo"/> depends on.
/// </returns>
public IEnumerable<ModuleInfo> GetDependentModules(ModuleInfo moduleInfo)
{
var catalog = this.catalogs.Single(x => x.Modules.Contains(moduleInfo));
return catalog.GetDependentModules(moduleInfo);
}
/// <summary>
/// Returns the collection of <see cref="ModuleInfo"/>s that contain both the <see cref="ModuleInfo"/>s in
/// <paramref name="modules"/>, but also all the modules they depend on.
/// </summary>
/// <param name="modules">The modules to get the dependencies for.</param>
/// <returns>
/// A collection of <see cref="ModuleInfo"/> that contains both all <see cref="ModuleInfo"/>s in <paramref name="modules"/>
/// and also all the <see cref="ModuleInfo"/> they depend on.
/// </returns>
public IEnumerable<ModuleInfo> CompleteListWithDependencies(IEnumerable<ModuleInfo> modules)
{
var modulesGroupedByCatalog = modules.GroupBy<ModuleInfo, IModuleCatalog>(module => this.catalogs.Single(catalog => catalog.Modules.Contains(module)));
return modulesGroupedByCatalog.SelectMany(x => x.Key.CompleteListWithDependencies(x));
}
/// <summary>
/// Initializes the catalog, which may load and validate the modules.
/// </summary>
public void Initialize()
{
foreach (var catalog in this.Catalogs)
{
catalog.Initialize();
}
}
/// <summary>
/// Adds a <see cref="ModuleInfo"/> to the <see cref="ModuleCatalog"/>.
/// </summary>
/// <param name="moduleInfo">The <see cref="ModuleInfo"/> to add.</param>
public void AddModule(ModuleInfo moduleInfo)
{
this.catalogs[0].AddModule(moduleInfo);
}
}
Следует также отметить, что в статье говорится следующее:
Чтобы продемонстрировать несколько способов использования ModuleCatalog, в QuickStart с использованием Unity реализован AggregateModuleCatalog, производный от IModuleCatalog. Этот класс не предназначен для использования в приложении доставки.
Почему это я не уверен. Хотелось бы услышать любые объяснения, почему это может быть.
Если бы аналогичная проблема была объединена с ответом Фергуса Боунса с SmartDirectoryCatalog, предложенным Haukinger: Multiple DirectoryModuleCatalog в приложении Prism. Я использую это для "необязательных зависимостей". Надеюсь, это кому-то поможет.
PS: с актуальной Prism Unity 7.2 вам необходимо заменить ModuleInfo на IModuleInfo
В вызове AddModule() в Bootstrapper вы можете указать зависимость. Таким образом, вы можете сказать, что A зависит от B, зависит от C, и это будет определять порядок загрузки.