ASP.NET MVC模塊化開發——動態掛載外部項目

時間  2019-12-27
標籤 asp.net asp mvc 模塊化 開發 動態 外部 項目 欄目 ASP 简体版
原文   原文鏈接

最近在開發一個MVC框架，開發過程當中考慮到之後開發依託於框架的項目，爲了框架的維護更新升級，代碼確定要和具體的業務工程分割開來，因此須要解決業務工程掛載在框架工程的問題，MVC與傳統的ASP.NET不一樣，WebForm項目只須要掛在虛擬目錄拷貝dll就能夠訪問，可是MVC不可能去引用工程項目的dll從新編譯，從而產生了開發一個動態掛在MVC項目功能的想法，MVC項目掛載主要有幾個問題，接下來進行詳細的分析與完成解決方案html

通常動態加載dll的方法是使用Assembly.LoadFIle的方法來調用，可是會存在以下問題：git

1.若是MVC項目中存在依賴注入，框架層面沒法將外部dll的類放入IOC容器

經過 BuildManager.AddReferencedAssembly方法在MVC項目啓動前，動態將外部代碼添加到項目的編譯體系中，須要配合PreApplicationStartMethod註解使用，示例：web

聲明一個類，而後進行註解標記，指定MVC啓動前方法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方法進行識別app

 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前綴的狀況ide

                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獨立加載，更新時進行卸載ui

1）建立一個RemoteLoader一個可穿越邊界的類，做爲加載dll的一個包裝spa

 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_files

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程