用 C# 來守護 Python 行程-有解無憂

背景

目前我主要負責的一個專案是一個 C/S 架構的客戶端開發，前端主要是通過 WPF 相關技術來實作，后端是通過 Python 來實作，前后端的資料通信則是通過 MQ 的方式來進行處理，由于 Python 行程是需要依賴客戶端行程來運行，為了保證后端業務行程的穩定性，就需要通過一個 守護行程 來守護 Python 行程，防止其由于未知原因而出現行程退出的情況，這里簡單記錄一下我的一種實作方式，

實作

對于我們的系統而言，我們的 Python 行程只允許存在一個，因此，對應的服務型別要采用單例模式，這一部分代碼相對簡單，就直接貼出來了，示例代碼如下所示：

public partial class PythonService
{
    private static readonly object _locker = new object();

    private static PythonService _instance;
    public static PythonService Current
    {
        get
        {
            if (_instance == null)
            {
                lock (_locker)
                {
                    if (_instance == null)
                    {
                        _instance = new PythonService();
                    }
                }
            }
            return _instance;
        }
    }

    private PythonService()
    {

    }
}

創建獨立行程

由于后端的 Python 代碼運行需要安裝一些第三方的擴展庫，所以為了方便，我們采用的方式是總結將 python 安裝檔案及擴展包和他們的代碼一并打包到我們的專案目錄中，然后創建一個 Python 行程，在該行程中通過設定環境變數的方式來為 Python 行程進行一些環境配置，示例代碼如下所示：

public partial class PythonService
{
    private string _workPath => Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "scripts");
    private string _pythonPath => Path.Combine(_workPath, "python27");

    private bool isRunning = false;
    private int taskPID = -1;

    public void Start()
    {
        taskPID = CreateProcess();
        isRunning = taskPID != -1;

        var msg = isRunning ? "服務啟動成功..." : "服務啟動失敗...";
        Trace.WriteLine(msg);
    }

    public void Stop()
    {
        KillProcessAndChildren(taskPID);

        isRunning = false;
        taskPID = -1;
    }

    private int CreateProcess()
    {
        KillProcessAndChildren(taskPID);

        int pid = -1;
        var psi = new ProcessStartInfo(Path.Combine(_pythonPath, "python.exe"))
        {
            UseShellExecute = false,
            WorkingDirectory = _workPath,
            ErrorDialog = false
        };

        psi.CreateNoWindow = true;

        var path = psi.EnvironmentVariables["PATH"];
        if (path != null)
        {
            var array = path.Split(new[] { ';' }).Where(p => !p.ToLower().Contains("python")).ToList();
            array.AddRange(new[] { _pythonPath, Path.Combine(_pythonPath, "Scripts"), _workPath });
            psi.EnvironmentVariables["PATH"] = string.Join(";", array);
        }
        var ps = new Process { StartInfo = psi };
        if (ps.Start())
        {
            pid = ps.Id;
        }
        return pid;
    }

    private static void KillProcessAndChildren(int pid)
    {
        // Cannot close 'system idle process'.
        if (pid <= 0)
        {
            return;
        }

        ManagementObjectSearcher searcher = new ManagementObjectSearcher("Select * From Win32_Process Where ParentProcessID=" + pid);
        ManagementObjectCollection moc = searcher.Get();
        foreach (ManagementObject mo in moc)
        {
            KillProcessAndChildren(Convert.ToInt32(mo["ProcessID"]));
        }
        try
        {
            Process proc = Process.GetProcessById(pid);
            proc.Kill();
        }
        catch (ArgumentException)
        {
            // Process already exited.
        }
        catch (Win32Exception)
        {
            // Access denied
        }
    }
}

這里有一點需要注意一下，建議使用 PID 來標識我們的 Python 行程，因為如果你使用行程實體或其它方式來對當前運行的行程設定一個參考，當該行程出現一些未知退出，這個時候你通過哪個參考來進行相關操作是會出問題的，

創建守護行程

上面我們的通過記錄當前正在運行的行程的 PID 來標識我們的行程，那對應守護行程，我們就可以通過行程串列查詢的方式來進行創建，在輪詢的程序中，如果未找到對應 PID 的行程則表明該行程已經退出，需要重新創建該行程，否則就不執行任何操作，示例代碼如下所示：

public partial class PythonService
{
    private CancellationTokenSource cts;

    private void StartWatch(CancellationToken token)
    {
        Task.Factory.StartNew(() =>
        {
            while (!token.IsCancellationRequested)
            {
                var has = Process.GetProcesses().Any(p => p.Id == taskPID);
                Trace.WriteLine($"MQ狀態：{DateTime.Now}-{has}");
                if (!has)
                {
                    taskPID = CreateProcess(_reqhost, _subhost, _debug);
                    isRunning = taskPID > 0;

                    var msg = isRunning ? "MQ重啟成功" : "MQ重啟失敗，等待下次重啟";
                    Trace.WriteLine($"MQ狀態：{DateTime.Now}-{msg}");
                }

                Thread.Sleep(2000);
            }
        }, token);
    }
}

這里我使用的是 Thread.Sleep(2000) 方式來繼續執行緒等待，你也可以使用 await Task.Delay(2000,token)，但是使用這種方式在發送取消請求時會產生一個 TaskCanceledException 的例外，所以為了不產生不必要的例外資訊，我采用第一種解決方案，

接著，完善我們的 Start 和 Stop 方法，示例代碼如下所示：

public void Start()
{
    taskPID = CreateProcess();
    isRunning = taskPID != -1;

    if (isRunning)
    {
        cts = new CancellationTokenSource();
        StartWatch(cts.Token);
    }

    var msg = isRunning ? "服務啟動成功..." : "服務啟動失敗...";
    Trace.WriteLine(msg);
}

public void Stop()
{
    cts?.Cancel(false);
    cts?.Dispose();

    KillProcessAndChildren(taskPID);
    taskPID = -1;

    isRunning = false;
}

最后，上層呼叫就相對簡單一下，直接呼叫 Start 方法和 Stop 方法即可，

總結

在我們的實際專案代碼中，PythonService 的代碼要比上面的代碼稍微復雜一些，我們內部還添加了一個 MQ 的訊息佇列，所以為了演示方便，我這里只列出了和本文相關的核心代碼，在具體的使用程序中，可以依據本文提供的一種實作方法來進行加工處理，

補充

這篇文章很榮幸能被張隊轉載到他的公眾號上面讓更多的技術愛好者看到了，我看到文章的評論區里有朋友說了為什么不用 pythonnet 這種第三方集成框架以及為什么需要守護行程，這里我對這兩個問題解答一下

為什么不使用 pythonnet 這種第三方的成熟框架？

這里我需要說明一下，我們的客戶端對應的后端服務是 python 寫的，并且腳本數量巨多無比，每個腳本之間又是相互獨立的模塊，相關的依賴庫都不一樣，所以這就導致一個問題，如果使 pythonnet 或 ironpython 這種集成框架，那么每個模塊需要使用到的依賴包就需要放到我們客戶端來維護管理安裝，從工程設計的角度來講，這個作業由我們客戶端組來做是不太合適的，雖然技術上是可行的，但是這無疑是一個坑，

為什么需要一個守護行程？

因為我們的 python 后端服務呼叫的很多第三方組件（部分是非自研）是多種型別的，后端服務無法保證能穩定呼叫每一個第三方組件不崩潰，這就要求我們客戶端必須要做一個守護行程來監測后端服務行程的狀態，當其崩潰后要能重新啟動，

我很能理解為什么有很多朋友會有上面兩個疑惑，其實做技術的很多都會陷入一個誤區：單純的考慮技術實作，而不關注業務解耦，這個怎么說呢，有好處也有不好的地方，但是我個人覺得，如果只是關注技術，而不切入業務，最后即使每個技術細節實作的很完美，但是業務緊耦合，這個專案依舊難以 可持續發展，

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/123956.html

標籤：C#

上一篇：C# 多執行緒與高并發處理并且具備暫停、繼續、停止功能

下一篇：c#通過Redis實作輕量級訊息組件

用 C# 來守護 Python 行程

背景

實作

創建獨立行程

創建守護行程

總結

相關參考

補充