日常工作中有時(shí)候會(huì)遇到需要將程序直接在服務(wù)器上運(yùn)行，而不依賴于 IIS 托管的情況，直接運(yùn)行有兩種方式，一種是部署為 服務(wù)模式，另一種則是 直接啟動(dòng) .NET 發(fā)布之后的 exe 文件以 控制臺(tái)模式運(yùn)行，控制臺(tái)模式運(yùn)行主要問題是服務(wù)器在重新啟動(dòng)之后不會(huì)自動(dòng)啟動(dòng)，當(dāng)然也可以選擇配置 Windows 計(jì)劃任務(wù)的形式讓 控制臺(tái)在服務(wù)器開機(jī)時(shí)自動(dòng)啟動(dòng)， 今天給大家分享 .NET 控制臺(tái)程序和 .NET 開發(fā)的 WebAPI 及 Web 項(xiàng)目在以 Windows 服務(wù)模式部署時(shí)的一些注意事項(xiàng)。

.NET 項(xiàng)目想要部署為 Windows 服務(wù)，首先需要通過 NuGet 安裝Microsoft.Extensions.Hosting.WindowsServices ，然后在程序啟動(dòng)時(shí)做如下配置：

控制臺(tái)程序：

using Common;

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

            IHost host = Host.CreateDefaultBuilder(args).UseWindowsService()
                .ConfigureServices((hostContext, services) =>
                {
                    ///各種服務(wù)注入
                })
                .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();

            //各種服務(wù)注入

            var app = builder.Build();

            app.Run();
        }
    }
}

以上是兩種常見程序的啟動(dòng) Main 函數(shù)的配置 Windows 托管模式的演示，其中一個(gè)關(guān)鍵點(diǎn)在于EnvironmentHelper.ChangeDirectory(args);

該方法用于在服務(wù)啟動(dòng)時(shí)將運(yùn)行路徑重新指向?yàn)槌绦蛩谀夸洠J(rèn)情況下 .NET 程序在命令啟動(dòng)時(shí)，運(yùn)行路徑為執(zhí)行命令的路徑比如在 cmd 中執(zhí)行如下命令：

?

雖然程序是放在 d:\Publish\ 文件夾中，但是因?yàn)槲覀儓?zhí)行啟動(dòng)程序命令時(shí)的路徑是在 c:\User\ZhangXiaoDong 所以程序啟動(dòng)之后的運(yùn)行環(huán)境路徑就是 命令執(zhí)行當(dāng)前目錄，c:\User\ZhangXiaoDong 這時(shí)候如果我們的代碼中有包含一些涉及到操作 程序所在目錄的 IO 操作時(shí)就會(huì)產(chǎn)生異常，比如 加載 web 項(xiàng)目下的 wwwroot 文件夾中的靜態(tài)資源，這些都會(huì)異常，所以我們需要在程序啟動(dòng)時(shí)將 運(yùn)行目錄重定向到 我們的程序所在目錄，就用到了EnvironmentHelper.ChangeDirectory(args); 這個(gè)方法。

EnvironmentHelper.ChangeDirectory(args); 實(shí)現(xiàn)如下：

using Microsoft.Extensions.Configuration.CommandLine;
namespace Common
{
    /// <summary>
    /// 環(huán)境操作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);
            }
        }
    }
}

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

調(diào)整之后我們?cè)趩?dòng)程序時(shí)只要多添加一個(gè)參數(shù)即可，如下：

只要在原本的啟動(dòng)命令dotnet d:\Publish\WebAPI.dll 優(yōu)化為dotnet d:\Publish\WebAPI.dll --cd='true' 即可，從上圖可以看出雖然我們的啟動(dòng)命令還是在c:\User\ZhangXiaoDong 目錄執(zhí)行的，但是程序的運(yùn)行目錄已經(jīng)被重定向到了dotnet d:\Publish\ 這個(gè)路徑也正是我們的程序所在路徑。

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

安裝
sc.exe create MyAPI binpath= 'd:\Publish\WebAPI.exe --cd="true"' start= auto

安裝成功之后控制臺(tái)會(huì)輸出[SC] CreateService 成功 ，其中MyAPI 時(shí)我們創(chuàng)建服務(wù)時(shí)指定的服務(wù)名稱，binpath 即是我們的程序路徑，注意 true 是 用英文狀態(tài)的雙引號(hào)包裹，然后整個(gè) binpath 采用因?yàn)闋顟B(tài)的 單引號(hào)包裹，start= auto 則表示將我們的 MyAPI 服務(wù)設(shè)置為自動(dòng)啟動(dòng)。

在 Windows 服務(wù)管理中也可以看到我們的服務(wù)

?

啟動(dòng)命令和停止命令，和我們?nèi)粘２僮髌胀ǚ?wù)的命令一樣都是 net start 服務(wù)名 和 net stop 服務(wù)名，如下：
啟動(dòng)：
net start MyAPI

停止
net stop MyAPI

?

卸載命令：
sc.exe delete 服務(wù)名稱
如：sc.exe delete MyAPI

至此 .NET 實(shí)現(xiàn)啟動(dòng)時(shí)重定向程序運(yùn)行路徑及 Windows 服務(wù)運(yùn)行模式部署 就講解完了，有任何不明白的，可以在文章下面評(píng)論或者私信我，歡迎大家積極的討論交流，有興趣的朋友可以關(guān)注我目前在維護(hù)的一個(gè) .NET 基礎(chǔ)框架項(xiàng)目，項(xiàng)目地址如下

https://github.com/berkerdong/NetEngine.git

https://gitee.com/berkerdong/NetEngine.git