用C語言編寫windows服務程式

下載原始碼
原文出處：Five Steps to Writing Windows Services in C


摘要

　　Windows 服務被設計用於需要在後臺執行的應用程式以及實現沒有使用者互動的任務。為了學習這種控制檯應用程式的基礎知識，C（不是C++）是最佳選擇。本文將建立並實現一個簡單的服務程式，其功能是查詢系統中可用實體記憶體數量，然後將結果寫入一個文字檔案。最後，你可以用所學知識編寫自己的 Windows 服務。
　　當初我寫第一個 NT 服務時，我到 MSDN 上找例子。在那裡我找到了一篇 Nigel Thompson 寫的文章：“Creating a Simple Win32 Service in C++”，這篇文章附帶一個 C++ 例子。雖然這篇文章很好地解釋了服務的開發過程，但是，我仍然感覺缺少我需要的重要資訊。我想理解通過什麼框架，呼叫什麼函式，以及何時呼叫，但 C++ 在這方面沒有讓我輕鬆多少。物件導向的方法固然方便，但由於用類對底層 Win32 函式呼叫進行了封裝，它不利於學習服務程式的基本知識。這就是為什麼我覺得 C 更加適合於編寫初級服務程式或者實現簡單後臺任務的服務。在你對服務程式有了充分透徹的理解之後，用 C++ 編寫才能遊刃有餘。當我離開原來的工作崗位，不得不向另一個人轉移我的知識的時候，利用我用 C 所寫的例子就非常容易解釋 NT 服務之所以然。
　　服務是一個執行在後臺並實現勿需使用者互動的任務的控制檯程式。Windows NT/2000/XP 作業系統提供為服務程式提供專門的支援。人們可以用服務控制皮膚來配置安裝好的服務程式，也就是 Windows 2000/XP 控制皮膚|管理工具中的“服務”（或在“開始”|“執行”對話方塊中輸入 services.msc /s——譯者注）。可以將服務配置成作業系統啟動時自動啟動，這樣你就不必每次再重啟系統後還要手動啟動服務。
　　本文將首先解釋如何建立一個定期查詢可用實體記憶體並將結果寫入某個文字檔案的服務。然後指導你完成生成，安裝和實現服務的整個過程。


第一步：主函式和全域性定義

首先，包含所需的標頭檔案。例子要呼叫 Win32 函式（windows.h）和磁碟檔案寫入（stdio.h）：
#include <windows.h>
#include <stdio.h>

接著，定義兩個常量：
#define SLEEP_TIME 5000
#define LOGFILE "C://MyServices//memstatus.txt"

SLEEP_TIME 指定兩次連續查詢可用記憶體之間的毫秒間隔。在第二步中編寫服務工作迴圈的時候要使用該常量。
LOGFILE 定義日誌檔案的路徑，你將會用 WriteToLog 函式將記憶體查詢的結果輸出到該檔案，WriteToLog 函式定義如下：
int WriteToLog(char* str)
{
    FILE* log;
    log = fopen(LOGFILE, "a+");
    if (log == NULL)
    return -1;
    fprintf(log, "%s/n", str);
    fclose(log);
    return 0;
}

宣告幾個全域性變數，以便在程式的多個函式之間共享它們值。此外，做一個函式的前向定義：
SERVICE_STATUS ServiceStatus;
SERVICE_STATUS_HANDLE hStatus;

void ServiceMain(int argc, char** argv);
void ControlHandler(DWORD request);
int InitService();

　　現在，準備工作已經就緒，你可以開始編碼了。服務程式控制臺程式的一個子集。因此，開始你可以定義一個 main 函式，它是程式的入口點。對於服務程式來說，main 的程式碼令人驚訝地簡短，因為它只建立分派表並啟動控制分派機。
void main()
{
    SERVICE_TABLE_ENTRY ServiceTable[2];
    ServiceTable[0].lpServiceName = "MemoryStatus";
    ServiceTable[0].lpServiceProc = (LPSERVICE_MAIN_FUNCTION)ServiceMain;
   
    ServiceTable[1].lpServiceName = NULL;
    ServiceTable[1].lpServiceProc = NULL;

    // 啟動服務的控制分派機執行緒
    StartServiceCtrlDispatcher(ServiceTable);
}

　　一個程式可能包含若干個服務。每一個服務都必須列於專門的分派表中（為此該程式定義了一個 ServiceTable 結構陣列）。這個表中的每一項都要在 SERVICE_TABLE_ENTRY 結構之中。它有兩個域：
lpServiceName: 指向表示服務名稱字串的指標；當定義了多個服務時，那麼這個域必須指定；
lpServiceProc: 指向服務主函式的指標（服務入口點）；

　　分派表的最後一項必須是服務名和服務主函式域的 NULL 指標，文字例子程式中只宿主一個服務，所以服務名的定義是可選的。
　　服務控制管理器（SCM：Services Control Manager）是一個管理系統所有服務的程式。當 SCM 啟動某個服務時，它等待某個程式的主執行緒來呼叫 StartServiceCtrlDispatcher 函式。將分派表傳遞給 StartServiceCtrlDispatcher。這將把呼叫程式的主執行緒轉換為控制分派器。該分派器啟動一個新執行緒，該執行緒執行分派表中每個服務的 ServiceMain 函式（本文例子中只有一個服務）分派器還監視程式中所有服務的執行情況。然後分派器將控制請求從 SCM 傳給服務。

注意：如果 StartServiceCtrlDispatcher 函式30秒沒有被呼叫，便會報錯，為了避免這種情況，我們必須在 ServiceMain 函式中（參見本文例子）或在非主函式的單獨執行緒中初始化服務分派表。本文所描述的服務不需要防範這樣的情況。

　　分派表中所有的服務執行完之後（例如，使用者通過“服務”控制皮膚程式停止它們），或者發生錯誤時。StartServiceCtrlDispatcher 呼叫返回。然後主程式終止。


第二步：ServiceMain 函式

　　Listing 1 展示了 ServiceMain 的程式碼。該函式是服務的入口點。它執行在一個單獨的執行緒當中，這個執行緒是由控制分派器建立的。ServiceMain 應該儘可能早早為服務註冊控制處理器。這要通過呼叫 RegisterServiceCtrlHadler 函式來實現。你要將兩個引數傳遞給此函式：服務名和指向 ControlHandlerfunction 的指標。
　　它指示控制分派器呼叫 ControlHandler 函式處理 SCM 控制請求。註冊完控制處理器之後，獲得狀態控制程式碼（hStatus）。通過呼叫 SetServiceStatus 函式，用 hStatus 向 SCM 報告服務的狀態。
Listing 1 展示瞭如何指定服務特徵和其當前狀態來初始化 ServiceStatus 結構，ServiceStatus 結構的每個域都有其用途：
dwServiceType：指示服務型別，建立 Win32 服務。賦值 SERVICE_WIN32；
dwCurrentState：指定服務的當前狀態。因為服務的初始化在這裡沒有完成，所以這裡的狀態為 SERVICE_START_PENDING；
dwControlsAccepted：這個域通知 SCM 服務接受哪個域。本文例子是允許 STOP 和 SHUTDOWN 請求。處理控制請求將在第三步討論；
dwWin32ExitCode 和 dwServiceSpecificExitCode：這兩個域在你終止服務並報告退出細節時很有用。初始化服務時並不退出，因此，它們的值為 0；
dwCheckPoint 和 dwWaitHint：這兩個域表示初始化某個服務程式時要30秒以上。本文例子服務的初始化過程很短，所以這兩個域的值都為 0。

　　呼叫 SetServiceStatus 函式向 SCM 報告服務的狀態時。要提供 hStatus 控制程式碼和 ServiceStatus 結構。注意 ServiceStatus 一個全域性變數，所以你可以跨多個函式使用它。ServiceMain 函式中，你給結構的幾個域賦值，它們在服務執行的整個過程中都保持不變，比如：dwServiceType。
　　在報告了服務狀態之後，你可以呼叫 InitService 函式來完成初始化。這個函式只是新增一個說明性字串到日誌檔案。如下面程式碼所示：
// 服務初始化
int InitService()
{
    int result;
    result = WriteToLog("Monitoring started.");
    return(result);
}

　　在 ServiceMain 中，檢查 InitService 函式的返回值。如果初始化有錯（因為有可能寫日誌檔案失敗），則將服務狀態置為終止並退出 ServiceMain：
error = InitService();
if (error)
{
    // 初始化失敗，終止服務
    ServiceStatus.dwCurrentState = SERVICE_STOPPED;
    ServiceStatus.dwWin32ExitCode = -1;
    SetServiceStatus(hStatus, &ServiceStatus);
    // 退出 ServiceMain
    return;
}

如果初始化成功，則向 SCM 報告狀態：
// 向 SCM 報告執行狀態
ServiceStatus.dwCurrentState = SERVICE_RUNNING;
SetServiceStatus (hStatus, &ServiceStatus);

接著，啟動工作迴圈。每五秒鐘查詢一個可用實體記憶體並將結果寫入日誌檔案。

如 Listing 1 所示，迴圈一直到服務的狀態為 SERVICE_RUNNING 或日誌檔案寫入出錯為止。狀態可能在 ControlHandler 函式響應 SCM 控制請求時修改。
 

第三步：處理控制請求

　　在第二步中，你用 ServiceMain 函式註冊了控制處理器函式。控制處理器與處理各種 Windows 訊息的視窗回撥函式非常類似。它檢查 SCM 傳送了什麼請求並採取相應行動。
　　每次你呼叫 SetServiceStatus 函式的時候，必須指定服務接收 STOP 和 SHUTDOWN 請求。Listing 2 示範瞭如何在 ControlHandler 函式中處理它們。
　　STOP 請求是 SCM 終止服務的時候傳送的。例如，如果使用者在“服務”控制皮膚中手動終止服務。SHUTDOWN 請求是關閉機器時，由 SCM 傳送給所有執行中服務的請求。兩種情況的處理方式相同：
寫日誌檔案，監視停止；
向 SCM 報告 SERVICE_STOPPED 狀態；

　　由於 ServiceStatus 結構對於整個程式而言為全域性量，ServiceStatus 中的工作迴圈在當前狀態改變或服務終止後停止。其它的控制請求如：PAUSE 和 CONTINUE 在本文的例子沒有處理。
　　控制處理器函式必須報告服務狀態，即便 SCM 每次傳送控制請求的時候狀態保持相同。因此，不管響應什麼請求，都要呼叫 SetServiceStatus。


圖一 顯示 MemoryStatus 服務的服務控制皮膚


第四步：安裝和配置服務

　　程式編好了，將之編譯成 exe 檔案。本文例子建立的檔案叫 MemoryStatus.exe，將它拷貝到 C:/MyServices 資料夾。為了在機器上安裝這個服務，需要用 SC.EXE 可執行檔案，它是 Win32 Platform SDK 中附帶的一個工具。（譯者注：Visaul Studio .NET 2003 IDE 環境中也有這個工具，具體存放位置在：C:/Program Files/Microsoft Visual Studio .NET 2003/Common7/Tools/Bin/winnt）。使用這個實用工具可以安裝和移除服務。其它控制操作將通過服務控制皮膚來完成。以下是用命令列安裝 MemoryStatus 服務的方法：
sc create MemoryStatus binpath= c:/MyServices/MemoryStatus.exe

　　發出此建立命令。指定服務名和二進位制檔案的路徑（注意 binpath= 和路徑之間的那個空格）。安裝成功後，便可以用服務控制皮膚來控制這個服務（參見圖一）。用控制皮膚的工具欄啟動和終止這個服務。


圖二 MemoryStatus 服務的屬性視窗

　　MemoryStatus 的啟動型別是手動，也就是說根據需要來啟動這個服務。右鍵單擊該服務，然後選擇上下文選單中的“屬性”選單項，此時顯示該服務的屬性視窗。在這裡可以修改啟動型別以及其它設定。你還可以從“常規”標籤中啟動/停止服務。以下是從系統中移除服務的方法：
sc delete MemoryStatus

指定 “delete” 選項和服務名。此服務將被標記為刪除，下次西通重啟後，該服務將被完全移除。


第五步：測試服務

　　從服務控制皮膚啟動 MemoryStatus 服務。如果初始化不出錯，表示啟動成功。過一會兒將服務停止。檢查一下 C:/MyServices 資料夾中 memstatus.txt 檔案的服務輸出。在我的機器上輸出是這樣的：
Monitoring started.
273469440
273379328
273133568
273084416
Monitoring stopped.

　　為了測試 MemoryStatus 服務在出錯情況下的行為，可以將 memstatus.txt 檔案設定成只讀。這樣一來，服務應該無法啟動。
　　去掉只讀屬性，啟動服務，在將檔案設成只讀。服務將停止執行，因為此時日誌檔案寫入失敗。如果你更新服務控制皮膚的內容，會發現服務狀態是已經停止。
 

開發更大更好的服務程式

　　理解 Win32 服務的基本概念，使你能更好地用 C++ 來設計包裝類。包裝類隱藏了對底層 Win32 函式的呼叫並提供了一種舒適的通用介面。修改 MemoryStatus 程式程式碼，建立滿足自己需要的服務！為了實現比本文例子所示範的更復雜的任務，你可以建立多執行緒的服務，將作業劃分成幾個工作者執行緒並從 ServiceMain 函式中監視它們的執行。