我参与过一个项目,该项目具有与您描述的类似的可插拔架构,并且使用了相同的技术 ASP.NET MVC 和 MEF。我们有一个主机 ASP.NET MVC 应用程序来处理身份验证、授权和所有请求。我们的插件(模块)被复制到它的子文件夹中。这些插件也是 ASP.NET MVC 应用程序,它们有自己的模型、控制器、视图、css 和 js 文件。以下是我们为其工作所遵循的步骤:
设置 MEF
我们创建了基于 MEF 的引擎,该引擎在应用程序启动时发现所有可组合部件并创建可组合部件的目录。这是仅在应用程序启动时执行一次的任务。引擎需要发现所有可插入部分,在我们的例子中,它们位于主机应用程序的 bin 文件夹或 Modules(Plugins) 文件夹中。
public class Bootstrapper
{
private static CompositionContainer CompositionContainer;
private static bool IsLoaded = false;
public static void Compose(List<string> pluginFolders)
{
if (IsLoaded) return;
var catalog = new AggregateCatalog();
catalog.Catalogs.Add(new DirectoryCatalog(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "bin")));
foreach (var plugin in pluginFolders)
{
var directoryCatalog = new DirectoryCatalog(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Modules", plugin));
catalog.Catalogs.Add(directoryCatalog);
}
CompositionContainer = new CompositionContainer(catalog);
CompositionContainer.ComposeParts();
IsLoaded = true;
}
public static T GetInstance<T>(string contractName = null)
{
var type = default(T);
if (CompositionContainer == null) return type;
if (!string.IsNullOrWhiteSpace(contractName))
type = CompositionContainer.GetExportedValue<T>(contractName);
else
type = CompositionContainer.GetExportedValue<T>();
return type;
}
}
这是执行所有 MEF 部件发现的类的示例代码。类的Compose 方法是从Global.asax.cs 文件中的Application_Start 方法调用的。为了简单起见,代码被减少了。
public class MvcApplication : System.Web.HttpApplication
{
protected void Application_Start()
{
var pluginFolders = new List<string>();
var plugins = Directory.GetDirectories(Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Modules")).ToList();
plugins.ForEach(s =>
{
var di = new DirectoryInfo(s);
pluginFolders.Add(di.Name);
});
AreaRegistration.RegisterAllAreas();
RouteConfig.RegisterRoutes(RouteTable.Routes);
Bootstrapper.Compose(pluginFolders);
ControllerBuilder.Current.SetControllerFactory(new CustomControllerFactory());
ViewEngines.Engines.Add(new CustomViewEngine(pluginFolders));
}
}
假定所有插件都复制到位于主机应用程序根目录的Modules 文件夹的单独子文件夹中。每个插件子文件夹包含Views 子文件夹和来自每个插件的 DLL。在上面的Application_Start 方法中还初始化了自定义控制器工厂和自定义视图引擎,我将在下面定义。
创建从 MEF 读取的控制器工厂
这是定义自定义控制器工厂的代码,它将发现需要处理请求的控制器:
public class CustomControllerFactory : IControllerFactory
{
private readonly DefaultControllerFactory _defaultControllerFactory;
public CustomControllerFactory()
{
_defaultControllerFactory = new DefaultControllerFactory();
}
public IController CreateController(RequestContext requestContext, string controllerName)
{
var controller = Bootstrapper.GetInstance<IController>(controllerName);
if (controller == null)
throw new Exception("Controller not found!");
return controller;
}
public SessionStateBehavior GetControllerSessionBehavior(RequestContext requestContext, string controllerName)
{
return SessionStateBehavior.Default;
}
public void ReleaseController(IController controller)
{
var disposableController = controller as IDisposable;
if (disposableController != null)
{
disposableController.Dispose();
}
}
}
此外,每个控制器必须标有Export 属性:
[Export("Plugin1", typeof(IController))]
[PartCreationPolicy(CreationPolicy.NonShared)]
public class Plugin1Controller : Controller
{
//
// GET: /Plugin1/
public ActionResult Index()
{
return View();
}
}
Export 属性构造函数的第一个参数必须是唯一的,因为它指定了合约名称并唯一标识每个控制器。 PartCreationPolicy 必须设置为 NonShared,因为控制器不能重复用于多个请求。
创建知道从插件中查找视图的视图引擎
需要创建自定义视图引擎,因为按照惯例,视图引擎仅在主机应用程序的Views 文件夹中查找视图。由于插件位于单独的Modules 文件夹中,我们需要告诉视图引擎也可以查看那里。
public class CustomViewEngine : RazorViewEngine
{
private List<string> _plugins = new List<string>();
public CustomViewEngine(List<string> pluginFolders)
{
_plugins = pluginFolders;
ViewLocationFormats = GetViewLocations();
MasterLocationFormats = GetMasterLocations();
PartialViewLocationFormats = GetViewLocations();
}
public string[] GetViewLocations()
{
var views = new List<string>();
views.Add("~/Views/{1}/{0}.cshtml");
_plugins.ForEach(plugin =>
views.Add("~/Modules/" + plugin + "/Views/{1}/{0}.cshtml")
);
return views.ToArray();
}
public string[] GetMasterLocations()
{
var masterPages = new List<string>();
masterPages.Add("~/Views/Shared/{0}.cshtml");
_plugins.ForEach(plugin =>
masterPages.Add("~/Modules/" + plugin + "/Views/Shared/{0}.cshtml")
);
return masterPages.ToArray();
}
}
解决插件中强类型视图的问题
仅使用上面的代码,我们不能在我们的插件(模块)中使用强类型视图,因为模型存在于bin 文件夹之外。要解决此问题,请关注以下link。