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

2022-09-16 06:01:29

日常工作中有時候會遇到需要將程式直接在伺服器上執行,而不依賴於 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.exe create MyAPI binpath= 'd:\Publish\WebAPI.exe --cd="true"' start= auto

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

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

 

啟動命令和停止命令,和我們日常操作普通服務的命令一樣都是 net start 服務名 和 net stop 服務名,如下:
啟動:
net start MyAPI

停止
net stop MyAPI

 

解除安裝命令:
sc.exe delete 服務名稱
如:sc.exe delete MyAPI

至此 .NET 實現啟動時重定向程式執行路徑及 Windows 服務執行模式部署 就講解完了,有任何不明白的,可以在文章下面評論或者私信我,歡迎大家積極的討論交流,有興趣的朋友可以關注我目前在維護的一個 .NET 基礎框架專案,專案地址如下