Een Windows-service-installatieprogramma maken

Begin met het installeren van de Wix Toolset. De Wix Toolset is een set hulpprogramma's waarmee Windows-installatiepakketten worden gebouwd op basis van XML-broncode.

dotnet tool install --global wix

Installeer vervolgens de HeatWave voor VS2022-extensie. Nadat u Visual Studio hebt geïnstalleerd, start u Visual Studio opnieuw op en ziet u dat er nieuwe projectsjablonen beschikbaar zijn.

Installeer de extensie Microsoft Visual Studio Installer Projects. Nadat u Visual Studio hebt geïnstalleerd, start u Visual Studio opnieuw op en ziet u dat er nieuwe projectsjablonen beschikbaar zijn.

Open de oplossing in Visual Studio en selecteer F5 om ervoor te zorgen dat de app wordt gebouwd en uitgevoerd zoals verwacht. Druk op Ctrl+C- om de app te stoppen.

Open de oplossing in Visual Studio en selecteer F5 om ervoor te zorgen dat de app wordt gebouwd en uitgevoerd zoals verwacht. Druk op Ctrl+C- om de app te stoppen.

Installatieswitches afhandelen

De Windows Service-app moet installatieswitches afhandelen. Het installatieproject roept de Windows Service-app aan met de schakelaars /Install tijdens de installatie en /Uninstall tijdens de deïnstallatie. Wanneer deze schakelopties aanwezig zijn, gedraagt de app zich anders, omdat de app alleen installatie of verwijdering uitvoert met behulp van het uitvoerbare bestand van Windows Service Control Manager (sc.exe).

Installeer het CliWrap NuGet-pakket voor gebruiksgemak om de app een afzonderlijk proces te laten aanroepen. Gebruik de volgende opdracht om het CliWrap pakket te installeren.

dotnet add App.WindowsService.csproj package CliWrap

Zie dotnet-pakket toevoegen voor meer informatie.

Als CliWrap dit is geïnstalleerd, opent u het Program.cs-bestand van het App.WindowsService project. Voeg na de using instructies, maar voordat de IHost code wordt gemaakt, de volgende code toe:

using CliWrap;

const string ServiceName = ".NET Joke Service";

if (args is { Length: 1 })
{
    try
    {
        string executablePath =
            Path.Combine(AppContext.BaseDirectory, "App.WindowsService.exe");

        if (args[0] is "/Install")
        {
            await Cli.Wrap("sc")
                .WithArguments(new[] { "create", ServiceName, $"binPath={executablePath}", "start=auto" })
                .ExecuteAsync();
        }
        else if (args[0] is "/Uninstall")
        {
            await Cli.Wrap("sc")
                .WithArguments(new[] { "stop", ServiceName })
                .ExecuteAsync();

            await Cli.Wrap("sc")
                .WithArguments(new[] { "delete", ServiceName })
                .ExecuteAsync();
        }
    }
    catch (Exception ex)
    {
        Console.WriteLine(ex);
    }

    return;
}

De voorgaande code:

• Declareert de servicenaam als een const string waarde.
• Controleer args op een enkele waarde.
• Hiermee haalt u het uitvoerbare pad op van de AppContext.BaseDirectory.
• Wanneer de "/Install" schakelaar aanwezig is, sc create ".NET Joke Service" binPath="path/to/App.WindowsService.exe" start=auto wordt aangeroepen.
• Wanneer de "/Uninstall" schakelaar aanwezig is, worden sc stop ".NET Joke Service" en sc delete ".NET Joke Service" aangeroepen.

Wanneer er geen installatieswitches aanwezig zijn, gedraagt de app zich zoals voorheen, maar bevat deze nu de installatiefunctionaliteit.

Als u een nieuw Wix-installatieproject wilt toevoegen, klikt u met de rechtermuisknop op de oplossing in Solution Explorer en selecteert u Nieuw project toevoegen>:

Selecteer MSI-pakket (Wix v4) in de beschikbare sjablonen en klik op vervolgens Volgende. Geef de gewenste naam en locatie op en selecteer Creëren.

Als u een nieuw installatieproject wilt toevoegen, klikt u met de rechtermuisknop op de oplossing in Solution Explorer en selecteert u Nieuw project toevoegen>:

Selecteer Project instellen in de beschikbare sjablonen en selecteer vervolgens volgende. Geef de gewenste naam en locatie op en selecteer Creëren.

Als u het installatieproject wilt configureren, moet u eerst een verwijzing naar het App.WindowsService project toevoegen. Klik met de rechtermuisknop op het installatieproject in Solution Explorer en selecteer Vervolgens Projectverwijzing toevoegen>.

De sjabloon bevat voorbeeldonderdelen en lokalisatiebestanden. Verwijder deze bestanden, zodat alleen het bestand Package.wxs overblijft. Uw project moet nu een ProjectReference element bevatten dat er ongeveer als volgt uitziet:

<Project Sdk="WixToolset.Sdk/4.0.0">
  <ItemGroup>
    <ProjectReference Include="..\App.WindowsService.csproj" />
  </ItemGroup>
</Project>

Nadat de projectreferentie is toegevoegd, configureert u het bestand Package.wxs . Open het bestand in de editor en vervang de inhoud door het volgende:

<?xml version="1.0" encoding="UTF-8"?>

<!-- Define the variables in "$(var.*) expressions" -->
<?define Name = ".NET Joke Service" ?>
<?define Manufacturer = "Microsoft" ?>
<?define Version = "1.0.0.0" ?>
<?define UpgradeCode = "9ED3FF33-8718-444E-B44B-69A2344B7E98" ?>

<Wix xmlns="http://wixtoolset.org/schemas/v4/wxs">
    <Package Name="$(Name)"
             Manufacturer="$(Manufacturer)"
             Version="$(Version)"
             UpgradeCode="$(var.UpgradeCode)"
             Compressed="true">

        <!-- Allow upgrades and prevent downgrades -->
        <MajorUpgrade DowngradeErrorMessage="A later version of [ProductName] is already installed. Setup will now exit." />

        <!-- Define the directory structure -->
        <StandardDirectory Id="ProgramFiles6432Folder">

            <!-- Create a folder inside program files -->
            <Directory Id="ROOTDIRECTORY" Name="$(var.Manufacturer)">

                <!-- Create a folder within the parent folder given the name -->
                <Directory Id="INSTALLFOLDER" Name="$(Name)" />
            </Directory>
        </StandardDirectory>

        <!-- The files inside this DirectoryRef are linked to
             the App.WindowsService directory via INSTALLFOLDER -->
        <DirectoryRef Id="INSTALLFOLDER">

            <!-- Create a single component which is the App.WindowsService.exe file -->
            <Component Id="ServiceExecutable" Bitness="always64">

                <!-- Copies the App.WindowsService.exe file using the
                     project reference preprocessor variables -->
                <File Id="App.WindowsService.exe"
                      Source="$(var.App.WindowsService.TargetDir)publish\App.WindowsService.exe"
                      KeyPath="true" />

                <!-- Remove all files from the INSTALLFOLDER on uninstall -->
                <RemoveFile Id="ALLFILES" Name="*.*" On="both" />

                <!-- Tell WiX to install the Service -->
                <ServiceInstall Id="ServiceInstaller"
                                Type="ownProcess"
                                Name="App.WindowsService"
                                DisplayName="$(Name)"
                                Description="A joke service that periodically logs nerdy humor."
                                Start="auto"
                                Account="LocalService"
                                ErrorControl="normal" />

                <!-- Tell WiX to start the Service -->
                <ServiceControl Id="StartService"
                                Start="install"
                                Stop="both"
                                Remove="uninstall"
                                Name="App.WindowsService"
                                Wait="true" />
            </Component>
        </DirectoryRef>

        <!-- Tell WiX to install the files -->
        <Feature Id="Service" Title="App.WindowsService Setup" Level="1">
            <ComponentRef Id="ServiceExecutable" />
        </Feature>

    </Package>
</Wix>

Het ServiceInstall kenmerk van Account het element geeft het account op waaronder de service wordt uitgevoerd. Het LocalService account is een ingebouwd account met verminderde bevoegdheden die geschikt zijn voor de meeste services. Veelvoorkomende waarden zijn:

• LocalService: Een ingebouwd account met beperkte bevoegdheden en geen netwerkreferenties.
• NetworkService: Vergelijkbaar met LocalService, maar heeft netwerkreferenties.
• LocalSystem: Het hoogste bevoegdheidsniveau (gebruik met voorzichtigheid).

Wanneer u het project bouwt, is de uitvoer een MSI-bestand dat kan worden gebruikt om de service te installeren en te verwijderen.

Als u het installatieproject wilt configureren, selecteert u het project in Solution Explorer. Selecteer F4 om het deelvenster Projecteigenschappen te openen. U kunt de pictogrammen 'toevoegen' en 'verwijderen' van de app configureren, auteur, fabrikant, productnaam, titel, doelplatform, enzovoort.

Het installatieproject moet twee aangepaste acties voor installatiegedrag definiëren. Klik met de rechtermuisknop op het project in Solution Explorer en selecteer Aangepaste acties weergeven>.

In het venster Aangepaste acties, selecteer Installeren > Aangepaste actie toevoegen.

Dubbelklik op de toepassingsmap (of selecteer Uitvoer toevoegen... met Toepassingsmap geselecteerd) en selecteer Items publiceren in App.WindowsService (actief).

Selecteer OK om de selectie te bevestigen. Klik met de rechtermuisknop op het toegevoegde knooppunt Publiceren Items vanuit App.WindowsService (Actief) onder Installeren en selecteer Eigenschappen.

Toevoegen /Install aan de argumenten. Volg deze stappen voor Verwijderen en voeg deze toe aan /Uninstall de argumenten.

Als u beide hebt gedaan, ziet u het volgende:

Met deze updates is het installatieproject geconfigureerd voor het delegeren van de acties installeren en verwijderen om met de juiste argumenten in te schakelen in de Windows Service-app.

Publiceer het App.WindowsService-project om het installatieprogramma te testen. Klik met de rechtermuisknop op het project in Solution Explorer en selecteer Publiceren. Nadat het uitvoerbare bestand is gepubliceerd met het profiel dat u in de vorige tutorial hebt gemaakt, bevindt het zich in de map voor publicatie. Vervolgens bouwt u het installatieproject en voert u het installatieprogramma uit.

U moet de installatie uitvoeren als beheerder. Hiervoor klikt u met de rechtermuisknop op het MSI-bestand en selecteert u Uitvoeren als administrator.

Zodra de service is geïnstalleerd, kunt u Services openen om te zien of de service wordt uitgevoerd. Als u de service wilt verwijderen, gebruikt u de functie Windows Programma's toevoegen of verwijderen om het installatieprogramma aan te roepen.

Als u het installatieprogramma wilt testen, vouwt u Oplossingsconfiguraties uit in Visual Studio en selecteert u Release (ervan uitgaande dat foutopsporing is geselecteerd). Bouw de oplossing en klik met de rechtermuisknop op het installatieproject en selecteer Build. Standaard maken installatieprojecten geen deel uit van de build.

Selecteer Uitvoer Weergeven >, en zorg ervoor dat de vervolgkeuzelijst uitvoer weergeven vanBuild is geselecteerd. Het bestandspad van de Microsoft Installer (MSI) wordt weergegeven. Kopieer het pad en open het installatieprogramma. Voer het installatieprogramma uit.

U moet de installatie uitvoeren als beheerder. Hiervoor klikt u met de rechtermuisknop op het MSI-bestand en selecteert u Uitvoeren als administrator.

Zodra de service is geïnstalleerd, kunt u Services openen om de service te starten. Als u de service wilt verwijderen, gebruikt u de functie Windows Programma's toevoegen of verwijderen om het installatieprogramma aan te roepen.