使用C#調試Windows服務模板項目

来源:https://www.cnblogs.com/langda/archive/2019/07/20/11218016.html
-Advertisement-
Play Games

Windows服務是非常強大的應用程式,可用於在backgorund中執行許多不同類型的任務。他們可以在不需要任何用戶登錄的情況下啟動,並且可以使用除登錄用戶之外的其他用戶帳戶運行。但是,如果通過遵循常規服務開發步驟開發Windows服務應用程式,即使在開發環境中也難以調試。 本文提出了一種不使用任 ...


Windows服務是非常強大的應用程式,可用於在backgorund中執行許多不同類型的任務。他們可以在不需要任何用戶登錄的情況下啟動,並且可以使用除登錄用戶之外的其他用戶帳戶運行。但是,如果通過遵循常規服務開發步驟開發Windows服務應用程式,即使在開發環境中也難以調試。

本文提出了一種不使用任何服務開發庫(如Topshelf)開發Windows服務的不同方法,以便在開發階段輕鬆監視和調試。

特征

示例項目具有以下功能;

  • 它在調試模式下作為控制台應用程式運行,在發佈模式下作為常規Windows服務運行。
  • 根據日誌類型在控制臺上顯示具有不同文本顏色的日誌消息。
  • Windows服務相關操作和實際後臺任務處理操作是分開的,因此可以輕鬆地對實際服務操作進行單元測試。
  • 可以使用InstallUtil.exe安裝和卸載服務。但是您不需要安裝它來進行測試和調試。

準備此應用程式的步驟

示例項目網站源碼是使用Visual Studio 2017準備的。

1-創建Windows服務項目

在Visual Studio中,單擊“文件”\“新建”\“項目”。選擇“Visual C#\ Windows桌面\ Windows服務”項目類型。

使用C#調試Windows服務模板項目

2-將項目輸出類型從Windows應用程式更改為控制台應用程式

右鍵單擊項目名稱並選擇“屬性”,打開項目屬性。

從“輸出類型”選擇列表中選擇控制台應用程式。

使用C#調試Windows服務模板項目

3-安裝log4net軟體包

從Package Manager控制台或Manage Nuget Packages菜單選項安裝log4net nuget軟體包。

4-配置log4net

log4net是一個非常強大的日誌庫,可以將日誌寫入許多目標,如文本文件,控制台,資料庫,Windows事件日誌,甚至可以將它們作為電子郵件發送。這些日誌編寫器(或目標)稱為“appender”。log4net配置必須至少有一個appender,但它可能有很多。每個appender都有自己的設置。

log4net配置可以添加到app.config文件中,也可以是單獨的文件。我更喜歡單獨的文件方法,因此為log4net添加兩個配置文件,用於調試和發佈模式。名稱無關緊要,您可以將它們命名為“ log4net.debug.config ”和“ log4net.prod.config ”。Debug配置文件有兩個appender; RollingFileAppender和  ColoredConsoleAppender生產配置文件還有兩個appender; RollingFileAppender和  EventLog但  EventLogappender已註釋掉,如果要編寫Windows事件日誌,可以取消註釋。

最小日誌級別在<root>元素下定義<level>配置元素。對於調試配置級別是DEBUG,對於生產它是INFO有效等級是; DEBUGINFOWARNERROR有關詳細信息,請參閱log4net文檔

下一步配置步驟是告訴log4net庫在調試和釋放模式下使用哪個文件。為此,請打開AssemblyInfo.cs文件併為log4net添加程式集級別屬性。添加這些行以在調試和釋放模式下在兩個文件之間切換。

#if DEBUG
 [ assembly:log4net.Config.XmlConfigurator(ConfigFile = log4net.debug.config”,Watch = true)]
 #else
 [ assembly:log4net.Config.XmlConfigurator(ConfigFile = log4net.prod.config”,Watch = 真的)]
 #endif

5-添加SampleBackgroundService類,其中包含我們的Windows服務將執行的實際後臺操作。

它是一個非常簡單的類  StartStop用於啟動和停止後臺任務處理線程的方法以及連續寫入日誌的線程方法。

class SampleBackgroundService
{
    // 從log4net獲取此類的記錄器LogManager 
    private  static ILog logger = LogManager.GetLogger(typeof(SampleBackgroundService));

    // 啟動線程
    public  void Start(){...}

    // 停止線程
    public  void Stop(){...}

    // 執行後臺任務並寫入日誌的服務線程
    private  void serviceThread()
    {
       while(!stopRequested)
       {
         // 寫出不同類型的日誌......
       }
    }
}

6-更新自動生成的Windows Service類中的代碼

我已將自動添加的Windows Services類重命名為  SampleWindowsService此類繼承自ServiceBase,並且是在啟動或停止Windows服務時調用方法OnStart類的類OnStop該類僅創建類的實例  SampleBackgroundService並調用其StartStop方法。

7-更新Program.cs文件中的Main mathod,使其在Debug和Release模式下表現不同

創建新的Windows服務項目時,自動生成的Main方法包含用於創建和啟動自動生成的Windows服務的代碼。但是,Windows服務無法作為常規應用程式啟動和托管。因此,當您嘗試運行該應用程式時會出現一條錯誤消息。

要運行和測試我們的應用程式,我們不需要創建真正的Windows服務實例,因為除了創建和啟動SampleBackgroundService類的實例之外,它不包含任何代碼  Main方法中更新的代碼在SampleBackgroundServiceDebug模式下創建並啟動的實例,  並作為控制台應用程式運行。但是在發佈模式下創建並運行真正的Windows服務。

static  void Main()
{
    ILog logger = LogManager.GetLogger(typeof(Program));

#if DEBUG //在調試模式下作為常規控制台應用程式運行
     // 手動創建SampleBackgroundService類的實例並調用其start方法

    logger.Info(“正在啟動服務......”);

    SampleBackgroundService _backgroundService = new SampleBackgroundService ();
    _backgroundService.Start();

    logger.Info(服務已啟動。按Enter鍵停止...”);
    到Console.ReadLine();

    logger.Info(停止服務......”);
    _backgroundService.Stop();
    logger.Info(“已停止。”);

#else //在Release模式     ServiceBase [] ServicesToRun中創建並運行真正的Windows服務實例
 ;
    ServicesToRun = new ServiceBase []
    {
        新的 SampleWindowsService()
    };
    ServiceBase.Run(ServicesToRun);
#endif
 }

8-添加Service Installer組件,以便能夠使用InstallUtil.exe安裝此服務

要添加安裝程式組件,請在解決方案資源管理器上雙擊SampleWindowsService.cs它將顯示服務的設計視圖。

右鍵單擊設計區域,然後單擊上下文菜單中的“添加安裝程式”。

使用C#調試Windows服務模板項目

這會將ProjectInstaller.cs和設計器文件添加到項目中。刪除自動生成的代碼  ProjectInstaller.InitializeComponent()方法和自動生成的變數(serviceProcessInstaller1serviceInstaller1)。

將以下代碼添加到  ProjectInstaller.cs文件中;

public  partial  class ProjectInstaller:Installer
{
    public  const  string SERVICE_NAME = Sample Background Service” ;

    private  readonly ServiceProcessInstaller m_ServiceProcessInstaller;
    private  readonly ServiceInstaller m_ServiceInstaller;

    public ProjectInstaller()
    {
        // 安裝進程的安裝程式(在本例中為'DebuggableWindowsService.exe')
        // 只能有一個ServiceProcessInstaller 
        m_ServiceProcessInstaller = new ServiceProcessInstaller();
        m_ServiceProcessInstaller.Account = ServiceAccount.LocalSystem;

       // 在應用程式中註冊實際Windows服務實現的安裝程式
       // 可能有一個或多個ServiceInstaller 
        m_ServiceInstaller = new ServiceInstaller();
        m_ServiceInstaller.ServiceName = SERVICE_NAME;
        m_ServiceInstaller.Description = ” ;
        m_ServiceInstaller.StartType = ServiceStartMode.Automatic;
        m_ServiceInstaller.DelayedAutoStart = true ;            

        Installers.Add(m_ServiceProcessInstaller);
        Installers.Add(m_ServiceInstaller);

        的InitializeComponent();
    }

// ...

}

如果要在安裝服務之前和之後執行任何任務,可以覆蓋適當的基本方法,例如  OnBeforeInstall,  OnBeforeUninstall...

您無需安裝(或向Windows服務註冊表註冊服務)您的服務即可運行和調試。但是,如果需要,可以使用InstallUtil.exe來安裝和卸載服務。InstallUtil.exe位於.NET Framework安裝文件夾下。例如,“ C:\ Windows \ Microsoft.NET \ Framework \ v4.0.30319 ”

要註冊該服務,請打開命令行視窗並使用可執行文件的完整路徑運行InstallUtil.exe您可能需要“以管理員身份”運行命令行視窗才能註冊服務。

C :\ Windows \ Microsoft.NET \ Framework \ v4.0.30319> InstallUtil.exe“D:\ DebuggableWindowsService \ src \ bin \ Release \ DebuggableWindowsService.exe”

要卸載服務,請使用/ u選項運行相同的命令。

C :\ Windows \ Microsoft.NET \ Framework \ v4.0.30319> InstallUtil.exe / u“D:\ DebuggableWindowsService \ src \ bin \ Release \ DebuggableWindowsService.exe”

9-在調試模式下運行應用程式以查看日誌輸出和調試

下麵是在調試模式下運行應用程式時顯示的示例輸出。

使用C#調試Windows服務模板項目

關於Windows服務的重要說明

Windows Service應用程式在幾個方面與其他常規應用程式不同。因此,應用程式在調試(控制台應用程式模式)和發佈(Windows服務模式)模式下的行為可能不同。

首先,當您在調試模式下運行應用程式時,其工作目錄將是可執行文件所在的路徑。例如“ D:\ DebuggableWindowsService \ src \ bin \ Release \ DebuggableWindowsService.exe ”

但是,當您使用InstallUtil.exe或安裝應用程式安裝它並從Windows服務管理應用程式運行它時,其工作目錄將是“ C:\ Windows \ System32 ”或“ C:\ Windows \ SysWOW64 ”,具體取決於您的服務是64位32d無論是在32位還是64位Windows上運行。

如果要在安裝目錄中讀取或寫入文件而不是系統目錄,則可以在啟動時使用工作目錄。例如;

Environment.CurrentDirectory = Path.GetDirectoryName(Assembly.GetExecutingAssembly()。Location);

其次, Windows服務可以使用除登錄用戶之外的其他用戶帳戶運行。當應用程式rusn作為真正的Windows服務時,某些在調試模式下運行的操作可能無法運行。這些操作的示例是訪問目錄或網路路徑,打開埠......

第三, Windows服務沒有用戶界面,通常無法顯示用戶界面。Windows操作系統阻止了他們對顯卡的訪問。遺憾的是,無法使用Windows服務中的強大GPU。要瞭解有關此限制的更多信息,請搜索“會話0隔離”。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • jdk源碼每日一讀 (一) java.lang.Object 1. 類說明 Object是java繼承體系的根,是每一個類的基類,所有的類都實現了Object類的所有方法。 2.重要方法 3. 分析 1. getClass方法 getClass方法的返回值是Class對象,它返回的是對象消除靜態類型 ...
  • 類集 類集:主要功能就是Java數據結構的實現(java.util) 類集就是動態對象數組(鏈表也是動態數組) Collection 介面 Collection是整個類集之中單值保存的最大 父介面 。即:每一次僅可以向集合中保存一個對象 在Collection定義的常用操作方法 常用操作方法 向集合 ...
  • 使用反射調用類中的setter、getter方法 運行結果: ...
  • 1.什麼是SpringMVC? SpringMVC是Spring框架內置的MVC的實現。SpringMVC就是一個Spring內置的MVC框架。MVC框架,它解決WEB開發中常見的問題(參數接收、文件上傳、表單驗證、國際化等等),而且使用簡單,與Spring無縫集成。 支持 RESTful風格的 U ...
  • 15.迭代器:工具 1.可迭代對象: ​ 官方聲明,只要具有_\_iter\_\_方法的就是可迭代對象 list,dict,str,set,tuple 可迭代對象,使用靈活 2.迭代器: 官方聲明:只要具有\_\_iter\_\_方法_\_next\_\_方法就是迭代器 將可迭代對象,轉換成迭代器 ...
  • EF是微軟推出的官方ORM框架,預設防註入可以配合LINQ一起使用,更方便開發人員。 首先通過SQLSERVER現在有的資料庫類生產EF 右鍵-》添加-》新建項,選擇AOD.NET實體數據模型,來自資料庫的Code FIrst 完成添加後會生成多個文件,並且在你的項目的配置文件中有資料庫的鏈接字元串 ...
  • 目錄 1.開發工具 2.GitLab伺服器搭建 3.新建webapi 4.Dockerfile配置 5.配置docker compose.yml 6.配置.gitlab ci.yml 7.在GitLab上添加一個新項目 8.GitLib Runner安裝 9.提交代碼到gitlab 10.在GitL ...
  • 如下圖所示,新建的類不能直接使用,會顯示報錯,檢查命名空間什麼的,未果 通過百度搜索,發現這麼一篇文章:https://blog.csdn.net/younghaiqing/article/details/71627959 不錯,將類文件的屬性中的“生成操作”里的“內容”改成“編譯”,保存後就能解決 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...