Laden...

[Tutorial] Windows Services mit C#

Erstellt von egrath vor 17 Jahren Letzter Beitrag vor 8 Jahren 137.018 Views
egrath Themenstarter:in
871 Beiträge seit 2005
vor 17 Jahren
[Tutorial] Windows Services mit C#

Programmierung von Windows Services mit C#

In diesem kurzen Tutorial lernen Sie, wie sie ein Windows Service mittels der Programmiersprache C# und dem Microsoft.NET Framework erstellen. Ziel soll nicht sein, einen tiefen Einblick in die Gesamtarchitektur von Windows Services zu geben, sondern nur einen groben Überblick wie ein Grundlegendes Service implementiert wird.

Was sind Windows Services?

Ein Windows Service (im folgenden nur noch kurz "WS" genannt), ist prinzipiell nichts anderes, als eine Windows Applikation welche folgende Besonderheiten aufweist:

* Läuft auch dann, wenn kein Benutzer am System angemeldet ist.  
* Interagiert im Normalfall nicht mit dem Desktop des Benutzers.  
* Wird vom Windows Service Manager gestartet, angehalten und gestoppt.  

Der Sinn eines WS liegt darin, dass ein System Dienste zur Verfügung stellen kann, ohne dass ein Benutzer dieses explizit starten muss.

Die Entwicklung eines WS

Wir werden in diesem Tutorial ein WS entwickeln, welches folgende Aufgaben übernimmt:

* An einem Netzwerkport horchen  
* Für jede Anfrage auf diesem einen neuen Thread starten und das aktuelle Datum und Uhrzeit zurückschreiben  

Der erste Schritt besteht darin, das Grundgestell unseres WS zu erstellen. Dies sieht in unserem Fall folgendermassen aus:


public class TestWinService : ServiceBase
{
    private NetworkDateServer m_DateServer;

    public static void Main( string[] args )
    {
        System.ServiceProcess.ServiceBase.Run( new TestWinService() );
    }

    protected override void OnStart( string[] args )
    {
        m_DateServer = new NetworkDateServer();
        Thread dateServerThread = new Thread( new ThreadStart( m_DateServer.StartServer ));
        dateServerThread.Start();
    }

    protected override void OnStop()
    {
        m_DateServer.StopServer();
    }
}

Obige Klasse dient als Einsprungspunkt unseres WS und ist für folgende Aktionen zuständig:

* Starten des Service Prozesses  
* Behandeln der Events "OnStart" und "OnStop"  

Wird vom Service Manager das WS gestartet, so wird das Event "OnStart" ausgelöst, welches in unserem Fall dafür zuständig ist, die Klasse "NetworkDateServer" zu instanziieren und diesen Server zu starten. Analog wird beim beenden durch den Service Manager das Event "OnStop" ausgelöst, welches den Server beendet. Wie dieser Server aufgebaut ist, sehen wir untenstehend:


public class NetworkDateServer
{
    private TcpListener m_TcpListener;
    private bool m_StopServer;

    public void StopServer()
    {
        m_StopServer = true;
    }

    public void StartServer()
    {
        m_StopServer = false;
        m_TcpListener = new TcpListener( IPAddress.Any, 27200 );
        m_TcpListener.Start();

        while( ! m_StopServer )
        {
            TcpClient client = m_TcpListener.AcceptTcpClient();
            Thread dateSender = new Thread( new ParameterizedThreadStart(( new DateSender()).SendDateToClient ));
            dateSender.Start( client );
        }

        m_TcpListener.Stop();
    }

    internal class DateSender
    {
        public void SendDateToClient( object client )
        {
            TcpClient networkClient = ( TcpClient ) client;
            NetworkStream networkStream = networkClient.GetStream();
            
            byte[] dateBuffer = System.Text.Encoding.ASCII.GetBytes( DateTime.Now.ToString() );
            networkStream.Write( dateBuffer, 0, dateBuffer.Length );
            
            networkStream.Close();
            networkClient.Close();
        }
    }
}

Im Endeffekt realisiert die Klasse "NetworkDateServer" einen Multi-Threaded Server, welcher am Port 27200 horcht und für jeden sich verbindenden Client einen neuen Thread startet, welcher anschliessen das aktuelle Datum und Uhrzeit an diesen schickt.

Da diese beiden Klassen schon unser gesamtes WS ausmachen, sehen wir abschliessend im nächsten Kapitel wie man die Installationsroutine programmatisch entwickeln kann.

Die Installation eines WS

Klassischerweise wird die Installation eines WS auf zwei verschiedene Arten durchgeführt:

* Per Hand durch erstellen der notwendigen Registry Einträge  
* Vom Installer der Applikation  

Wir werden den Schritt des Applikationsinstallers wählen und können dies mit .NET eigenen Bordmitteln relativ schnell und elegant realisieren. Dazu fügen wir zu unserem WS folgende Klasse hinzu:


[RunInstaller( true )]
public class TestWinInstaller : Installer
{
    private ServiceInstaller m_ThisService;
    private ServiceProcessInstaller m_ThisServiceProcess;

    public TestWinInstaller()
    {
        m_ThisService = new ServiceInstaller();
        m_ThisServiceProcess = new ServiceProcessInstaller();

        m_ThisServiceProcess.Account = ServiceAccount.NetworkService;
        m_ThisService.ServiceName = "Simple Test Service";
        m_ThisService.StartType = ServiceStartMode.Manual;

        Installers.Add( m_ThisService );
        Installers.Add( m_ThisServiceProcess );
    }
}

Wenn unser WS als kompilierte EXE Datei vorliegt können wir diese dann durch einen simplen aufruf von "installutil dateiname.exe" installieren. Dies funktioniert, weil wir das Attribut "RunInstaller" angegeben haben und das "installutil" mittels Reflection nachsieht welche Klasse dieses besitzt, diese dann lädt und ausführt.

Kompletter Sourcecode des WS inklusive Installers


using System;
using System.Configuration.Install;
using System.ComponentModel;
using System.ServiceProcess;
using System.IO;
using System.Net.Sockets;
using System.Net;
using System.Threading;

[RunInstaller( true )]
public class TestWinInstaller : Installer
{
    private ServiceInstaller m_ThisService;
    private ServiceProcessInstaller m_ThisServiceProcess;

    public TestWinInstaller()
    {
        m_ThisService = new ServiceInstaller();
        m_ThisServiceProcess = new ServiceProcessInstaller();

        m_ThisServiceProcess.Account = ServiceAccount.NetworkService;
        m_ThisService.ServiceName = "Simple Test Service";
        m_ThisService.StartType = ServiceStartMode.Manual;

        Installers.Add( m_ThisService );
        Installers.Add( m_ThisServiceProcess );
    }
}

public class TestWinService : ServiceBase
{
    private NetworkDateServer m_DateServer;

    public static void Main( string[] args )
    {
        System.ServiceProcess.ServiceBase.Run( new TestWinService() );
    }

    protected override void OnStart( string[] args )
    {
        m_DateServer = new NetworkDateServer();
        Thread dateServerThread = new Thread( new ThreadStart( m_DateServer.StartServer ));
        dateServerThread.Start();
    }

    protected override void OnStop()
    {
        m_DateServer.StopServer();
    }
}

public class NetworkDateServer
{
    private TcpListener m_TcpListener;
    private bool m_StopServer;

    public void StopServer()
    {
        m_StopServer = true;
    }

    public void StartServer()
    {
        m_StopServer = false;
        m_TcpListener = new TcpListener( IPAddress.Any, 27200 );
        m_TcpListener.Start();

        while( ! m_StopServer )
        {
            TcpClient client = m_TcpListener.AcceptTcpClient();
            Thread dateSender = new Thread( new ParameterizedThreadStart(( new DateSender()).SendDateToClient ));
            dateSender.Start( client );
        }

        m_TcpListener.Stop();
    }

    internal class DateSender
    {
        public void SendDateToClient( object client )
        {
            TcpClient networkClient = ( TcpClient ) client;
            NetworkStream networkStream = networkClient.GetStream();
            
            byte[] dateBuffer = System.Text.Encoding.ASCII.GetBytes( DateTime.Now.ToString() );
            networkStream.Write( dateBuffer, 0, dateBuffer.Length );
            
            networkStream.Close();
            networkClient.Close();
        }
    }
}

[EDIT=herbivore]Siehe auch Debuggen von Windows-Dienstanwendungen[/EDIT]

4.506 Beiträge seit 2004
vor 17 Jahren

Hallo egrath,

ich finde den Artikel sehr gut, da viele Programmierer den guten alten WS doch vergessen haben 😉

Auch dass eine Installationsroutine mit beschrieben wird, finde ich sehr gut.

Also 1+ 😉

Gruß
Norman-Timo

A: “Wie ist denn das Wetter bei euch?”
B: “Caps Lock.”
A: “Hä?”
B: “Na ja, Shift ohne Ende!”

1.130 Beiträge seit 2005
vor 17 Jahren

Auch von mir: Daumen hoch 👍
Sehr schön geschrieben.

K
80 Beiträge seit 2006
vor 17 Jahren

Japp das hat mir jetzt auch geholfen, denn ein "Nicht Debug Build" von meinen IRC Services schreit ja geradezu nach WS 🙂 Schön einfach, danke dir auch von mir: 👍 👍 👍 👍 👍 5 / 5 Gummipunkte ^^

T
147 Beiträge seit 2005
vor 17 Jahren

also egrath,

ich muss auch sagen dass der Artikel sehr gut ist, ich selbst habe schon mehrere Services erstellt die mehr oder minder trivial waren. Aber ich denke mal mit deinem Tut werden es Neueinsteiger im Bereich der Dienstentwicklung um einiges einfacher haben.

👍 👍

S
37 Beiträge seit 2005
vor 17 Jahren

Nicht schlecht Herr Specht...

schöner Artikel. Wenn ich mal Zeit kann poste ich gern noch einen Teil über das Remoting mit dem Service und vorallem die ServiceController-Class.

In diesem Sinne nice Work...

  1. :rolleyes:98,5 % aller IT-Probleme werden durch Fehlfunktionen des Layer 8 ausgelöst!! :rolleyes:8)
2.921 Beiträge seit 2005
vor 17 Jahren

Wie mache ich das mit dem Installer in VS.Net 2003?

Muss es leider mit der Version machen, da gibt's aber kein
StartType
ServiceName
DisplayName
?

Ok [RunInstallerAttribute(true)] anstatt [RunInstallertrue)]
bringts anscheinend.

Seit der Erkenntnis, dass der Mensch eine Nachricht ist, erweist sich seine körperliche Existenzform als überflüssig.

J
222 Beiträge seit 2006
vor 17 Jahren

hallo eine frage ....

kann man in vs 2005 std edition kein windows service erstellen oder muss man da zusätzlich was installiern denn ich finde keinen projekt typ dafür ?

egrath Themenstarter:in
871 Beiträge seit 2005
vor 17 Jahren

Hallo,

das Template "Windows Service" ist erst ab der Professional Edition enthalten - das fehlen dieser sollte dich aber trotzdem nicht davon abhalten einen Service zu erstellen (Empty Project)

Grüsse, Egon

M
253 Beiträge seit 2006
vor 17 Jahren

Guter Artikel!

190 Beiträge seit 2005
vor 17 Jahren
Befehl an einen Windows Service senden

Befehl an diesen Windows Service senden

Möchte man nun einen Befehl an diesen Windows Service senden, kann man das auf sehr einfache Art mit dem Überschreiben der Methode _OnCustomCommand _[MSDN: ServiceBase.OnCustomCommand-Methode] bewerkstelligen. Egon's Code wird wie folgt erweitert:


public class TestWinService : ServiceBase
{
    private NetworkDateServer m_DateServer;

    public static void Main( string[] args )
    {
        System.ServiceProcess.ServiceBase.Run( new TestWinService() );
    }

    protected override void OnStart( string[] args )
    {
        m_DateServer = new NetworkDateServer();
        Thread dateServerThread = new Thread( new ThreadStart( m_DateServer.StartServer ));
        dateServerThread.Start();
    }

    protected override void OnStop()
    {
        m_DateServer.StopServer();
    }

    protected override void OnCustomCommand(int command) // <---- überschreiben
    {
        switch (command)
        {
              case 150: // z.B. DateServer starten
                 // ...
                 break;

              case 151: // DateServer stoppen
                 m_DateServer.StopServer();
                 break;
        }
     }
} 

Jetzt können die Befehle '150' und '151' von einem anderen Programm abgesetzt werden, um den DateServer zu starten/stoppen. Der Windows Service läuft weiter. Ein mögliches Programm könnte eventl. so aussehen:


using System.ServiceProcess;

public partial class MyServiceGUI : Form
{
        ServiceController sc;

        public MyServiceGUI()
        {
              sc = new ServiceController("Simple Test Service"); // festgelegt in der Klasse [I]TestWinInstaller[/I]

              sc.ExecuteCommand(151);   // -> Auswertung in OnCustomCommand des Services; hier [I]DateServer[/I] stoppen
        }
}

Es gibt natürlich noch andere Möglichkeiten (Remoting,...), um Befehle an Windows Services zu senden, dies scheint mir aber der einfachste.

Gruß cx°

P
2 Beiträge seit 2005
vor 17 Jahren
Gute Ergänzung

👍 Super Artikel mit toller Ergänzung von cx°

Kann nur Gratulieren! 🙂

L
17 Beiträge seit 2007
vor 16 Jahren
Windows Dienst mit .net 2003

Hallo, ich habe eine Frage an dr4g0n76 gestellt, zu der er gern das Projekt posten möchte:
Hier unser Dialog:

-----Ursprüngliche Nachricht-----
Nachricht von: Leia2011
Gesendet: 03.07.2007 13:24
An: dr4g0n76
Betreff: Dein Beitrag im Forum: Community-Index » Diskussionsforum » Knowledge Base » Artikel » [Tutorial] Wi

Hi!

hast du rausgefunden, welche Namespaces und welche Sachen man beachten muss, wenn man einen Windows - Dienst mit VS 2003 erstellen möchte?
Ich finde leider nur Beispiele fürs .net Framework 2.0.

Meine Anwendung darf aber unbedingt nur 1.1 verwenden.

Kannst du mir da vllt ein paar Tipps geben?
Dafür wäre ich sehr dankbar.

Nachricht von dr4g0n76 vom 03.07.2007 15:15:

Unbedingt diese beiden Verweise einbinden:

System.Configuration.Install;
System.ServiceProcess;

sonst läufts nicht.

Hast Du ne Windows-Dienst-Vorlage?

Oder schreib Die Frage ins Forum, vielelicht am besten angehängt beim Artikel Thread zu den Windows-Services, dann könnte ich die Projekt-Vorlage hinzufügen.

Gruss, dr4g0n76

2.921 Beiträge seit 2005
vor 16 Jahren

So, dieser Dienst sollte auch in VS 2003 funktionieren, bzw. das Grundgerüst.

Seit der Erkenntnis, dass der Mensch eine Nachricht ist, erweist sich seine körperliche Existenzform als überflüssig.

H
212 Beiträge seit 2007
vor 16 Jahren

👍

:rolleyes: 😁 😮

C
26 Beiträge seit 2007
vor 16 Jahren
Beliebiges Programm als Dienst einrichten

Kommt zwar von der "AdminSeite", könnte aber für den ein oder anderen von Interesse
sein.

Create your own user-defined services Windows NT/2000/XP/2003
http://www.tacktech.com/display.cfm?ttid=197

O
79 Beiträge seit 2011
vor 8 Jahren

Mit VS2013 Community und gegen .NET4.5 muß man eine Kleinigkeit beachten. Denn: Der Namespace "System.Configuration.Install" scheint gar nicht mehr zu existieren 8o Die MSDN-Hilfe von Microsoft führt auf eine völlig falsche Fährte (man ist geneigt zu glauben, das sei .NET3.5 und älter).

Tatsächlich muß man zunächst einen Verweis auf "System.Configuration.Install" hinzufügen, dann hat man auch einen ".Install"-Namespace und auch eine Klasse "Installer".

1.040 Beiträge seit 2007
vor 8 Jahren

Denn: Der Namespace "System.Configuration.Install" scheint gar nicht mehr zu existieren 8o

Tatsächlich muß man zunächst einen Verweis auf "System.Configuration.Install" hinzufügen

🤔
Ohne den Rest des Themas gelesen zu haben, die Aussagen widersprechen sich doch völlig?
Das man einen Verweis auf fehlende .dll's hinzufügen muss, ist doch vollkommen normal...

Siehe auch: [FAQ] CS0234 / CS0246 - Der Typ- oder Namespacename "Foo" konnte nicht gefunden werden