WPF 透過多處理程序實現例外隔離的用戶端

當 WPF 用戶端需要實作外掛系統的時候，一般可以基於容器或程序來實現。如果需要對外部外掛實現異常隔離，那麼只能使用子程序來載入外掛，這樣外掛如果擲出例外，也不會影響到主程序。WPF 元素無法跨程序傳輸，但是視窗控制代碼（HWND）可以，所以可以將 WPF 元素包裝成 HWND，然後透過程序間通訊將外掛傳輸到用戶端中，從而實現外掛載入。

1. 使用 HwndSource 將 WPF 嵌入到 Win32 視窗

HwndSource 會產生一個可以嵌入 WPF 的 Win32 視窗，使用 HwndSource.RootVisual 加入一個 WPF 元素。

private static IntPtr ViewToHwnd(FrameworkElement element)
{
    var p = new HwndSourceParameters()
    {
        ParentWindow = new IntPtr(-3), // message only
        WindowStyle = 1073741824
    };
    var hwndSource= new HwndSource(p)
    {
        RootVisual = element,
        SizeToContent = SizeToContent.Manual,
    };
    hwndSource.CompositionTarget.BackgroundColor = Colors.White;
    return hwndSource.Handle;
}

2. 使用 HwndHost 將 Win32 視窗轉換成 WPF 元素

Win32 視窗是無法直接嵌入到 WPF 頁面中的，所以 .Net 提供了一個 HwndHost 類別來轉換。 HwndHost 是一個抽象類別，透過實作 BuildWindowCore 方法，可以將一個 Win32 視窗轉換成 WPF 元素。

class ViewHost : HwndHost
{
    private readonly IntPtr _handle;

    [DllImport("user32.dll", CharSet = CharSet.Auto)]
    public static extern IntPtr SetParent(HandleRef hWnd, HandleRef hWndParent);

    public ViewHost(IntPtr handle) => _handle = handle;

    protected override HandleRef BuildWindowCore(HandleRef hwndParent)
    {
        SetParent(new HandleRef(null, _handle), hwndParent);
        return new HandleRef(this, _handle);
    }

    protected override void DestroyWindowCore(HandleRef hwnd)
    {
    }
}

3. 約定外掛的進入點方法

可以透過多種方式回傳外掛的介面。我這裡約定每個外掛的 dll 都有一個 PluginStartup 類別，PluginStartup.CreateView() 可以回傳外掛的介面。

namespace Plugin1
{
    public class PluginStartup
    {
        public FrameworkElement CreateView() => new UserControl1();
    }
}

4. 啟動外掛程序，使用匿名管道實現程序間通訊

程序間通訊有多種方式，需要功能齊全可以使用 grpc，簡單的使用管道就好了。

• 用戶端透過指定外掛 dll 位址來載入外掛。載入外掛的時候，啟動一個子程序，並且透過管道通訊，傳輸包裝外掛的 Win32 視窗控制代碼。

private FrameworkElement LoadPlugin(string pluginDll)
{
    using (var pipeServer = new AnonymousPipeServerStream(PipeDirection.In, HandleInheritability.Inheritable))
    {
        var startInfo = new ProcessStartInfo()
        {
            FileName = "PluginProcess.exe",
            UseShellExecute = false,
            CreateNoWindow = true,
            Arguments = $"{pluginDll} {pipeServer.GetClientHandleAsString()}"
        };

        var process = new Process { StartInfo = startInfo };
        process.Start();
        _pluginProcessList.Add(process);
        pipeServer.DisposeLocalCopyOfClientHandle();
        using (var reader = new StreamReader(pipeServer))
        {
            var handle = new IntPtr(int.Parse(reader.ReadLine()));
            return new ViewHost(handle);
        }
    }
}

• 透過主控台程式裝載外掛 dll 並將外掛介面轉換成 Win32 視窗，然後透過管道傳輸控制代碼。

[STAThread]
[LoaderOptimization(LoaderOptimization.MultiDomain)]
static void Main(string[] args)
{
    if (args.Length != 2) return
    var dllPath = args[0];
    var serverHandle = args[1];
    var dll = Assembly.LoadFile(dllPath);
    var startupType = dll.GetType($"{dll.GetName().Name}.PluginStartup");
    var startup = Activator.CreateInstance(startupType);
    var view =(FrameworkElement)  startupType.GetMethod("CreateView").Invoke(startup, null);

    using (var pipeCline = new AnonymousPipeClientStream(PipeDirection.Out, serverHandle))
    {
        using (var writer = new StreamWriter(pipeCline))
        {
            writer.AutoFlush = true;
            var handle = ViewToHwnd(view);
            writer.WriteLine(handle.ToInt32());
        }
    }
    Dispatcher.Run();
}

5 效果

參考資料和備註

• 範例原始碼
• win32 和 WPF 混合開發，無可避免會涉及空域問題。
• 如果不需要異常隔離，使用 mef 或者 prism 已經可以實現良好的外掛功能。
• System.AddIn 也可以提供類似功能，但是只支援到 .net framework 4.8。
• 這裡有一個基於 System.AddIn 實現的多程序外掛架構
• wpf 跟 win32 的文件
• 如果不具備視窗的知識，這裡有篇部落格文講得很好