ASP.NET MVC模組化開發——動態掛載外部專案
最近在開發一個MVC框架，開發過程中考慮到以後開發依託於框架的專案，為了框架的維護更新升級，程式碼肯定要和具體的業務工程分割開來，所以需要解決業務工程掛載在框架工程的問題，MVC與傳統的ASP.NET不同，WebForm專案只需要掛在虛擬目錄拷貝dll就可以訪問，但是MVC不可能去引用工程專案的dll重新編譯，從而產生了開發一個動態掛在MVC專案功能的想法，MVC專案掛載主要有幾個問題，接下來進行詳細的分析與完成解決方案
一般動態載入dll的方法是使用Assembly.LoadFIle的方法來呼叫，但是會存在如下問題：
1.如果MVC專案中存在依賴注入，框架層面無法將外部dll的類放入IOC容器
通過 BuildManager.AddReferencedAssembly方法在MVC專案啟動前，動態將外部程式碼新增到專案的編譯體系中，需要配合PreApplicationStartMethod註解使用，示例：
宣告一個類，然後進行註解標記，指定MVC啟動前方法
//使用PreApplicationStartMethod註解的作用是在mvc應用啟動之前執行操作
[assembly: PreApplicationStartMethod(typeof(FastExecutor.Base.Util.PluginUtil), "PreInitialize")]
namespace FastExecutor.Base.Util
{
public class PluginUtil
{
public static void PreInitialize()
{
}
}
}2.外部載入的dll中的Controller無法被識別
通過自定義的ControllerFactory重寫GetControllerType方法進行識別
public class FastControllerFactory : DefaultControllerFactory
{
protected override Type GetControllerType(RequestContext requestContext, string controllerName)
{
Type ControllerType = PluginUtil.GetControllerType(controllerName + "Controller");
if (ControllerType == null)
{
ControllerType = base.GetControllerType(requestContext, controllerName);
}
return ControllerType;
}
}在Global.asax檔案中進行ControllerFactory的替換
ControllerBuilder.Current.SetControllerFactory(new FastControllerFactory());
ControllerTypeDic是遍歷外部dll獲取到的所有Controller，這裡需要考慮到Controller通過RoutePrefix註解自定義Controller字首的情況
IEnumerable<Assembly> assemblies = GetProjectAssemblies();
foreach (var assembly in assemblies)
{
foreach (var type in assembly.GetTypes())
{
if (type.GetInterface(typeof(IController).Name) != null && type.Name.Contains("Controller") && type.IsClass && !type.IsAbstract)
{
string Name = type.Name;
//如果有自定義的路由註解
if (type.IsDefined(typeof(System.Web.Mvc.RoutePrefixAttribute), false))
{
var rounteattribute = type.GetCustomAttributes(typeof(System.Web.Mvc.RoutePrefixAttribute), false).FirstOrDefault();
Name = ((System.Web.Mvc.RoutePrefixAttribute)rounteattribute).Prefix + "Controller";
}
if (!ControllerTypeDic.ContainsKey(Name))
{
ControllerTypeDic.Add(Name, type);
}
}
}
BuildManager.AddReferencedAssembly(assembly);
}
3.載入dll後如果要更新業務程式碼，dll會被鎖定，無法替換，需要重啟應用
解決辦法是通過AppDomain對業務專案dll獨立載入，更新時進行解除安裝
1）建立一個RemoteLoader一個可穿越邊界的類，作為載入dll的一個包裝
public class RemoteLoader : MarshalByRefObject
{
private Assembly assembly;
public Assembly LoadAssembly(string fullName)
{
assembly = Assembly.LoadFile(fullName);
return assembly;
}
public string FullName
{
get { return assembly.FullName; }
}
}
2）建立LocalLoader作為AppDomian建立與解除安裝的載體
public class LocalLoader
{
private AppDomain appDomain;
private RemoteLoader remoteLoader;
private DirectoryInfo MainFolder;
public LocalLoader()
{
AppDomainSetup setup = AppDomain.CurrentDomain.SetupInformation;
setup.ShadowCopyDirectories = setup.ApplicationBase;
appDomain = AppDomain.CreateDomain("PluginDomain", null, setup);
string name = Assembly.GetExecutingAssembly().GetName().FullName;
remoteLoader = (RemoteLoader)appDomain.CreateInstanceAndUnwrap(
name,
typeof(RemoteLoader).FullName);
}
public Assembly LoadAssembly(string fullName)
{
return remoteLoader.LoadAssembly(fullName);
}
public void Unload()
{
AppDomain.Unload(appDomain);
appDomain = null;
}
public string FullName
{
get
{
return remoteLoader.FullName;
}
}
}
這裡需要說明的，AppDomainSetup配置檔案請使用AppDomain.CurrentDomain.SetupInformation也就是使用框架的作用於配置資訊，因為業務程式碼會引用到很多框架的dll，如果獨立建立配置資訊，會有找不到相關dll的錯誤，同時這裡也需要配置web.confg檔案指定額外的dll搜尋目錄，因為業務工程程式碼也會有很多層多個dll相互引用，不指定目錄也會存在找不到依賴dll的錯誤
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<!--外掛載入目錄-->
<probing privatePath="PluginTemp" />
</assemblyBinding>
</runtime>
3）建立業務程式碼資料夾Plugin與臨時dll資料夾PluginTemp
為什麼要建立臨時資料夾呢，因為我們需要在PluginTemp真正的載入dll，然後監聽Plugin資料夾的檔案變化，有變化時進行AppDomain解除安裝這個操作，將Plugin中的dll拷貝到PluginTemp資料夾中，再重新載入dll
監聽Plugin資料夾：
private static readonly FileSystemWatcher _FileSystemWatcher = new FileSystemWatcher();
public static void StartWatch()
{
_FileSystemWatcher.Path = HostingEnvironment.MapPath("~/Plugin");
_FileSystemWatcher.Filter = "*.dll";
_FileSystemWatcher.Changed += _fileSystemWatcher_Changed;
_FileSystemWatcher.IncludeSubdirectories = true;
_FileSystemWatcher.NotifyFilter =
NotifyFilters.Attributes | NotifyFilters.CreationTime | NotifyFilters.DirectoryName | NotifyFilters.FileName | NotifyFilters.LastAccess | NotifyFilters.LastWrite | NotifyFilters.Security | NotifyFilters.Size;
_FileSystemWatcher.EnableRaisingEvents = true;
}
private static void _fileSystemWatcher_Changed(object sender, FileSystemEventArgs e)
{
DllList.Clear();
Initialize(false);
InjectUtil.InjectProject();
}
拷貝dll：
if (PluginLoader == null)
{
PluginLoader = new LocalLoader();
}
else
{
PluginLoader.Unload();
PluginLoader = new LocalLoader();
}
TempPluginFolder.Attributes = FileAttributes.Normal & FileAttributes.Directory;
PluginFolder.Attributes = FileAttributes.Normal & FileAttributes.Directory;
//清理臨時檔案。
foreach (var file in TempPluginFolder.GetFiles("*.dll", SearchOption.AllDirectories))
{
try
{
File.SetAttributes(file.FullName, FileAttributes.Normal);
file.Delete();
}
catch (Exception)
{
//這裡雖然能成功刪除，但是會報沒有許可權的異常，就不catch了
}
}
//複製外掛進臨時資料夾。
foreach (var plugin in PluginFolder.GetFiles("*.dll", SearchOption.AllDirectories))
{
try
{
string CopyFilePath = Path.Combine(TempPluginFolder.FullName, plugin.Name);
File.Copy(plugin.FullName, CopyFilePath, true);
File.SetAttributes(CopyFilePath, FileAttributes.Normal);
}
catch (Exception)
{
//這裡雖然能成功刪除，但是會報沒有許可權的異常，就不catch了
}
}
注：這裡有個問題一直沒解決，就是刪除檔案拷貝檔案的時候，AppDomain已經解除安裝，但是始終提示無許可權錯誤，但是操作又是成功的，暫時還未解決，如果大家有解決方法可以一起交流下
載入dll：
public static IEnumerable<Assembly> GetProjectAssemblies()
{
if (DllList.Count==0)
{
IEnumerable<Assembly> assemblies = TempPluginFolder.GetFiles("*.dll", SearchOption.AllDirectories).Select(x => PluginLoader.LoadAssembly(x.FullName));
foreach (Assembly item in assemblies)
{
DllList.Add(item);
}
}
return DllList;
}
4.業務程式碼的cshtml頁面如何加入到框架中被訪問
在MVC工程中，cshtml也是需要被編譯的，我們可以通過RazorBuildProvider將外部編譯的頁面動態載入進去
public static void InitializeView()
{
IEnumerable<Assembly> assemblies = GetProjectAssemblies();
foreach (var assembly in assemblies)
{
RazorBuildProvider.CodeGenerationStarted += (object sender, EventArgs e) =>
{
RazorBuildProvider provider = (RazorBuildProvider)sender;
provider.AssemblyBuilder.AddAssemblyReference(assembly);
};
}
}
RazorBuildProvider方法啊只是在路由層面將cshtml加入到框架中，我們還需要將業務工程View中模組的頁面掛載虛擬目錄到框架中，如圖所示
5.框架啟動後，更新業務dll帶來的相關問題
在啟動的專案中我們更新dll，我們希望達到的效果是和更新框架bin目錄檔案的dll一樣，程式會重啟，這樣就會再次呼叫被PreApplicationStartMethod註解標註的方法，不需要在程式碼中做額外處理判斷是首次載入還是更新載入，同時也做不到動態的將外部dll加入到MVC編譯dll體系中，也只能啟動前載入，查了很多資料，重新載入專案可以通過程式碼控制IIS回收程式池達到效果，但是因為各種繁瑣的許可權配置問題而放棄，我最後的解決方法是比較歪門邪道的方法，更新web.config檔案的修改日期，因為iis會監控配置檔案，更新了會重啟引用，大家如果有更好的簡單的方法，可以評論回覆我呦
//這裡通過修改webconfig檔案的時間達到重啟應用，載入專案dll的目的！File.SetLastWriteTime(HostingEnvironment.MapPath("~/Web.config"), System.DateTime.Now);
部落格園沒找到資源上傳地址，傳到碼雲上了，放個地址：https://gitee.com/grassprogramming/FastExecutor/attach_f