AppDomain實現【插件式】開發

2021 年 4 月 4 日
筆記
.NET, AppDomain, 隔離運行

前言：

　近期項目中需要實現「熱插拔」式的插件程式，例如：定義一個插件介面；由不同開發人員實現具體的插件功能類庫；並最終在應用中調用具體插件功能。

　此時需要考慮：插件執行的安全性（隔離運行）和插件可卸載升級。說到隔離運行和可卸載首先想到的是AppDomain。

　那麼AppDomain是什麼呢？

一、AppDomain介紹

　AppDomain是.Net平台里一個很重要的特性,在.Net以前,每個程式是”封裝”在不同的進程中的,這樣導致的結果就造就佔用資源大,可復用性低等缺點.而AppDomain在同一個進程內劃分出多個”域”,一個進程可以運行多個應用,提高了資源的復用性,數據通訊等. 詳見

　CLR在啟動的時候會創建系統域(System Domain),共享域(Shared Domain)和默認域(Default Domain),系統域與共享域對於用戶是不可見的,默認域也可以說是當前域,它承載了當前應用程式的各類資訊(堆棧),所以,我們的一切操作都是在這個默認域上進行.”插件式”開發很大程度上就是依靠AppDomain來進行.

　應用程式域具有以下特點：

必須先將程式集載入到應用程式域中，然後才能執行該程式集。
一個應用程式域中的錯誤不會影響在另一個應用程式域中運行的其他程式碼。
能夠在不停止整個進程的情況下停止單個應用程式並卸載程式碼。不能卸載單獨的程式集或類型，只能卸載整個應用程式域。

二、基於AppDomain實現「熱拔式插件」

　通過AppDomain來實現程式集的卸載，這個思路是非常清晰的。由於在程式設計中，非特殊的需要，我們都是運行在同一個應用程式域中。

　由於程式集的卸載存在上述的缺陷，我們必須要關閉應用程式域，方可卸載已經裝載的程式集。然而主程式域是不能關閉的，因此唯一的辦法就是在主程式域中建立一個子程式域，通過它來專門實現程式集的裝載。一旦要卸載這些程式集，就只需要卸載該子程式域就可以了，它並不影響主程式域的執行。　

　實現方式如下圖：

1、AssemblyDynamicLoader類提供創建子程式域和卸載程式域的方法；
2、RemoteLoader類提供裝載程式集、執行介面方法；
3、AssemblyDynamicLoader類獲得RemoteLoader類的代理對象，並調用RemoteLoader類的方法；
4、RemoteLoader類的方法在子程式域中完成；

　那麼AssemblyDynamicLoader 和 RemoteLoader 如何實現呢？

　1、首先定義RemoteLoader用於載入插件程式集，並提供插件介面執行方法　　

public class RemoteLoader : MarshalByRefObject
{
    private Assembly _assembly;

    public void LoadAssembly(string assemblyFile)
    {
        _assembly = Assembly.LoadFrom(assemblyFile);         
    }
    public T GetInstance<T>(string typeName) where T : class
    {
        if (_assembly == null) return null;
        var type = _assembly.GetType(typeName);
        if (type == null) return null;
        return Activator.CreateInstance(type) as T;
    }
    public object ExecuteMothod(string typeName, string args)
    {
        if (_assembly == null) return null;
        var type = _assembly.GetType(typeName);
        var obj = Activator.CreateInstance(type);
        if (obj is IPlugin)
        {
            return (obj as IPlugin).Exec(args);
        }
        return null;
    }
}

　由於每個AppDomain都有自己的堆棧,記憶體塊,也就是說它們之間的數據並非共享了.若想共享數據,則涉及到應用程式域之間的通訊.C#提供了MarshalByRefObject類進行跨域通訊,則必須提供自己的跨域訪問器.

　2、AssemblyDynamicLoader 主要用於管理應用程式域創建和卸載；並創建RemoteLoader對象

using System;
using System.IO;
using System.Reflection;
namespace PluginRunner
{
    public class AssemblyDynamicLoader
    {
        private AppDomain appDomain;
        private RemoteLoader remoteLoader;
        public AssemblyDynamicLoader(string pluginName)
        {
            AppDomainSetup setup = new AppDomainSetup();
            setup.ApplicationName = "app_" + pluginName;
            setup.ApplicationBase = AppDomain.CurrentDomain.BaseDirectory;
            setup.PrivateBinPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Plugins");
            setup.CachePath = setup.ApplicationBase;
            setup.ShadowCopyFiles = "true";
            setup.ShadowCopyDirectories = setup.ApplicationBase;
            AppDomain.CurrentDomain.SetShadowCopyFiles();
            this.appDomain = AppDomain.CreateDomain("app_" + pluginName, null, setup);

            String name = Assembly.GetExecutingAssembly().GetName().FullName;
            this.remoteLoader = (RemoteLoader)this.appDomain.CreateInstanceAndUnwrap(name, typeof(RemoteLoader).FullName);
        }
        /// <summary>
        /// 載入程式集
        /// </summary>
        /// <param name="assemblyFile"></param>
        public void LoadAssembly(string assemblyFile)
        {
            remoteLoader.LoadAssembly(assemblyFile);
        }
        /// <summary>
        /// 創建對象實例
        /// </summary>
        /// <typeparam name="T"></typeparam>
        /// <param name="typeName"></param>
        /// <returns></returns>
        public T GetInstance<T>(string typeName) where T : class
        {
            if (remoteLoader == null) return null;
            return remoteLoader.GetInstance<T>(typeName);
        }
        /// <summary>
        /// 執行類型方法
        /// </summary>
        /// <param name="typeName"></param>
        /// <param name="methodName"></param>
        /// <returns></returns>
        public object ExecuteMothod(string typeName, string methodName)
        {
            return remoteLoader.ExecuteMothod(typeName, methodName);
        }
        /// <summary>
        /// 卸載應用程式域
        /// </summary>
        public void Unload()
        {
            try
            {
                if (appDomain == null) return;
                AppDomain.Unload(this.appDomain);
                this.appDomain = null;
                this.remoteLoader = null;
            }
            catch (CannotUnloadAppDomainException ex)
            {
                throw ex;
            }
        }
        public Assembly[] GetAssemblies()
        {
            return this.appDomain.GetAssemblies();
        }
    }
}

　3、插件介面和實現：

　　插件介面：

public interface IPlugin
{

    /// <summary>
    /// 執行插件方法
    /// </summary>
    /// <param name="pars">參數json</param>
    /// <returns>執行結果json串</returns>
    object Exec(string pars);

    /// <summary>
    /// 插件初始化
    /// </summary>
    /// <returns></returns>
    bool Init();

}

　　測試插件實現：

public class PrintPlugin : IPlugin
{
    public object Exec(string pars)
    {
        //v1.0
        //return $"列印插件執行-{pars} 完成";
        //v1.1
        return $"列印插件執行-{pars} 完成-更新版本v1.1";
    }

    public bool Init()
    {
        return true;
    }
}

　4、插件執行：

string pluginName = txtPluginName.Text;
if (!string.IsNullOrEmpty(pluginName) && PluginsList.ContainsKey(pluginName))
{
    var loader = PluginsList[pluginName];
    var strResult = loader.ExecuteMothod("PrintPlugin.PrintPlugin", "Exec")?.ToString();
    MessageBox.Show(strResult);
}
else
{
    MessageBox.Show("插件未指定或未載入");
}

　5、測試介面實現：

　　創建個測試窗體如下：

三、運行效果

　插件測試基本完成：那麼看下運行效果：可以看出當前主程式域中未載入PrintPlugin.dll，而是在子程式集中載入

　當我們更新PrintPlugin.dll邏輯，並更新測試程式載入位置中dll，不會出現不允許覆蓋提示；然後先卸載dll在再次載入剛剛dll（模擬插件升級）

　到此已實現插件化的基本實現

四、其他

　當然隔離運行和「插件化」都還有其他實現方式,等著解鎖。但是只要搞清楚本質、實現原理、底層邏輯這些都相對簡單。所以對越基礎的內容越要理解清楚。

參考：

　官網介紹：//docs.microsoft.com/zh-cn/dotnet/framework/app-domains/application-domains

　示例源碼：//github.com/cwsheng/PluginAppDemo

Tags: .NET AppDomain 隔離運行