.NET 實現啟動時重定向程式運行路徑及 Windows 服務運行模式部署

日常工作中有時候會遇到需要將程式直接在伺服器上運行，而不依賴於 IIS 托管的情況，直接運行有兩種方式，一種是部署為 服務模式，另一種則是 直接啟動 .NET 發佈之後的 exe 文件以 控制台模式運行，控制台模式運行主要問題是伺服器在重新啟動之後不會自動啟動，當然也可以選擇配置 Windows 計劃任務的形式讓 控制台在伺服器開機時自動啟動， 今天給大家分享 .NET 控制台程式和 .NET 開發的 WebAPI 及 Web 項目在以 Windows 服務模式部署時的一些註意事項。

.NET 項目想要部署為 Windows 服務，首先需要通過 NuGet 安裝 Microsoft.Extensions.Hosting.WindowsServices ，然後在程式啟動時做如下配置：

控制台程式：

using Common;

namespace TaskService
{
    class Program
    {
        static void Main(string[] args)
        {
            EnvironmentHelper.ChangeDirectory(args);

            IHost host = Host.CreateDefaultBuilder(args).UseWindowsService()
                .ConfigureServices((hostContext, services) =>
                {
                    ///各種服務註入
                })
                .Build();

            host.Run();
        }
    }
}

Web 及 WebAPI 程式：

using Common;

namespace WebAPI
{
    public class Program
    {
        public static void Main(string[] args)
        {

            EnvironmentHelper.ChangeDirectory(args);

            var builder = WebApplication.CreateBuilder(args);

            builder.Host.UseWindowsService();

            //各種服務註入

            var app = builder.Build();

            app.Run();
        }
    }
}

以上是兩種常見程式的啟動 Main 函數的配置 Windows 托管模式的演示，其中一個關鍵點在於 EnvironmentHelper.ChangeDirectory(args); 

該方法用於在服務啟動時將運行路徑重新指向為程式所在目錄，預設情況下 .NET 程式在命令啟動時，運行路徑為執行命令的路徑比如在 cmd 中執行如下命令：

雖然程式是放在 d:\Publish\ 文件夾中，但是因為我們執行啟動程式命令時的路徑是在 c:\User\ZhangXiaoDong 所以程式啟動之後的運行環境路徑就是 命令執行當前目錄，c:\User\ZhangXiaoDong 這時候如果我們的代碼中有包含一些涉及到操作 程式所在目錄的 IO 操作時就會產生異常，比如 載入 web 項目下的 wwwroot 文件夾中的靜態資源，這些都會異常，所以我們需要在程式啟動時將 運行目錄重定向到 我們的程式所在目錄，就用到了 EnvironmentHelper.ChangeDirectory(args);  這個方法。

EnvironmentHelper.ChangeDirectory(args);  實現如下：

using Microsoft.Extensions.Configuration.CommandLine;

namespace Common
{

    /// <summary>
    /// 環境操作Helper方法
    /// </summary>
    public class EnvironmentHelper
    {

        /// <summary>
        /// 改變工作目錄
        /// </summary>
        /// <param name="args"></param>
        public static void ChangeDirectory(string[] args)
        {
            var cmdConf = new CommandLineConfigurationProvider(args);
            cmdConf.Load();

            if (cmdConf.TryGet("cd", out string cdStr) && bool.TryParse(cdStr, out bool cd) && cd)
            {
                Directory.SetCurrentDirectory(AppContext.BaseDirectory);
            }
        }
    }
}

主要邏輯是判斷啟動命令中 cd 參數的值是否為 true ，如果 cd=true 則重新配置程式的 CurrentDirectory 為程式文件所在目錄。

調整之後我們在啟動程式時只要多添加一個參數即可，如下：

只要在原本的啟動命令 dotnet d:\Publish\WebAPI.dll 優化為 dotnet d:\Publish\WebAPI.dll --cd='true' 即可，從上圖可以看出雖然我們的啟動命令還是在 c:\User\ZhangXiaoDong 目錄執行的，但是程式的運行目錄已經被重定向到了 dotnet d:\Publish\ 這個路徑也正是我們的程式所在路徑。

有了上面的基礎，我們就可以利用 Windows伺服器的 SC 指令來配置服務部署了，具體命令如下： 

安裝成功之後控制台會輸出  [SC] CreateService 成功 ，其中 MyAPI 時我們創建服務時指定的服務名稱，binpath 即是我們的程式路徑，註意 true 是 用英文狀態的雙引號包裹，然後整個 binpath 採用因為狀態的 單引號包裹，start= auto 則表示將我們的 MyAPI 服務設置為自動啟動。

在 Windows 服務管理中也可以看到我們的服務