Windows サービス インストーラーを作成する

まず、Wix ツールセットをインストールします。 Wix ツールセットは、XML ソース コードから Windows インストール パッケージをビルドする一連のツールです。

dotnet tool install --global wix

次に、 HEATWave for VS2022 拡張機能をインストールします。 インストール後、Visual Studio を再起動すると、使用可能な新しいプロジェクト テンプレートが表示されます。

Microsoft Visual Studio インストーラー プロジェクト拡張機能をインストールします。 インストール後、Visual Studio を再起動すると、使用可能な新しいプロジェクト テンプレートが表示されます。

Visual Studio でソリューションを開き、 F5 キーを押して、アプリが想定どおりにビルドおよび実行されるようにします。 Ctrl+キーを押してアプリを停止します。

Visual Studio でソリューションを開き、 F5 キーを押して、アプリが想定どおりにビルドおよび実行されるようにします。 Ctrl+キーを押してアプリを停止します。

取り付けスイッチを操作する

Windows サービス アプリは、インストール スイッチを処理する必要があります。 セットアップ プロジェクトは、インストール時とアンインストール時に、それぞれ /Install スイッチと /Uninstall スイッチを使用して Windows サービス アプリを呼び出します。 これらのスイッチが存在する場合、アプリは、Windows Service Control Manager 実行可能ファイル (sc.exe) を使用してのみインストールまたはアンインストールを実行するという点で、動作が異なります。

アプリで別のプロセスを呼び出すには、便宜上 CliWrap NuGet パッケージをインストールします。 CliWrap パッケージをインストールするには、次のコマンドを使用します。

dotnet add App.WindowsService.csproj package CliWrap

詳細については、「 dotnet package add」を参照してください。

CliWrapインストールされたら、 プロジェクトのApp.WindowsService ファイルを開きます。 using ディレクティブの後、IHostが作成される前に、次のコードを追加します。

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;
}

前述のコード:

• サービス名を const string 値として宣言します。
• args で 1 つの値を確認する。
• AppContext.BaseDirectoryから実行可能パスを取得します。
• "/Install" スイッチが存在すると、sc create ".NET Joke Service" binPath="path/to/App.WindowsService.exe" start=autoが呼び出されます。
• "/Uninstall" スイッチが存在すると、sc stop ".NET Joke Service"とsc delete ".NET Joke Service"が呼び出されます。

インストール スイッチが存在しない場合、アプリは以前と同じように動作しますが、インストール機能が含まれるようになりました。

新しい Wix セットアップ プロジェクトを追加するには、 ソリューション エクスプローラー でソリューションを右クリックし、[ 新しいプロジェクト > 追加] を選択します。

使用可能なテンプレートから MSI パッケージ (Wix v4) を選択し、[ 次へ] を選択します。 目的の 名前 と 場所を指定し、[ 作成] を選択します。

新しいセットアップ プロジェクトを追加するには、 ソリューション エクスプローラー でソリューションを右クリックし、[ 新しいプロジェクト > 追加] を選択します。

使用可能なテンプレートから [プロジェクトのセットアップ] を選択し、[ 次へ] を選択します。 目的の 名前 と 場所を指定し、[ 作成] を選択します。

セットアップ プロジェクトを構成するには、まず、 App.WindowsService プロジェクトへの参照を追加する必要があります。 ソリューション エクスプローラーでセットアップ プロジェクトを右クリックし、[プロジェクト参照>追加] を選択します。

テンプレートには、コンポーネント ファイルとローカライズ ファイルの例が含まれています。 Package.wxs ファイルのみを残すファイルを削除します。 プロジェクトには、次のような ProjectReference 要素が含まれるはずです。

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

プロジェクト参照が追加されたら、 Package.wxs ファイルを 構成します。 エディターでファイルを開き、内容を次のように置き換えます。

<?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 -->
        <Directory Id="TARGETDIR" Name="SourceDir">
            <Directory Id="ProgramFiles64Folder">

                <!-- 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>
            </Directory>
        </Directory>

        <!-- 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"
                                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>

プロジェクトをビルドすると、サービスのインストールとアンインストールに使用できる MSI ファイルが出力されます。

インストーラー プロジェクトを構成するには、 ソリューション エクスプローラーでプロジェクトを選択します。 F4 キーを押してプロジェクトのプロパティ ウィンドウを開きます。 アプリの "追加" アイコンと "削除" アイコン、作成者、製造元、製品名、タイトル、ターゲット プラットフォームなどを構成できます。

インストーラー プロジェクトでは、インストール動作に対して 2 つのカスタム アクションを定義する必要があります。 ソリューション エクスプローラーでプロジェクトを右クリックし、[カスタム アクション>表示] を選択します。

[ カスタム アクション] ウィンドウで、[ インストール] > [カスタム アクションの追加] を選択します。

アプリケーション フォルダーをダブルクリックして (または[出力の追加...] を選択し、[アプリケーション フォルダー] を選択して)、[App.WindowsService (アクティブ)] から [アイテムの発行] を選択します。

[ OK] を 選択して選択内容を確認します。 [インストール] の下にある App.WindowsService (アクティブ) ノードから追加された発行アイテムを右クリックし、[プロパティ] を選択します。

引数に /Install を追加 します。 [アンインストール] の場合と同じ手順に従い、引数に/Uninstallを追加します。

両方を完了すると、次の内容が表示されます。

これらの更新プログラムにより、セットアップ プロジェクトは、適切な引数を指定して Windows サービス アプリを呼び出す インストール アクションと アンインストール アクションを委任するように構成されています。

インストーラーをテストするには、 App.WindowsService プロジェクトを発行します。 ソリューション エクスプローラーでプロジェクトを右クリックし、[発行] を選択します。 前のチュートリアルで作成したプロファイルを使用して発行すると、実行可能ファイルは発行ディレクトリに格納されます。 次に、セットアップ プロジェクトを ビルド し、インストーラーを実行します。

インストールを管理者として実行する必要があります。 これを行うには、MSI ファイルを右クリックし、[ 管理者として実行] を選択します。

サービスがインストールされたら、 サービス を開いて、実行中のサービスを確認できます。 サービスをアンインストールするには、Windows の [プログラムの追加と削除] 機能を使用してインストーラーを呼び出します。

インストーラーをテストするには、Visual Studio で [ソリューション構成] を 展開し、[ リリース ] を選択します ( デバッグ が選択されていると仮定)。 ソリューションをビルドし、セットアップ プロジェクトを右クリックし、[ ビルド] を選択します。 既定では、セットアップ プロジェクトはビルドの一部ではありません。

[ 出力 > 表示] を選択し、[出力 の表示 ] ドロップダウンで [ビルド ] が選択されていることを確認します。 Microsoft インストーラー (MSI) ファイル パスが表示されます。 パスをコピーし、インストーラーを開きます。 インストーラーを実行します。

インストールを管理者として実行する必要があります。 これを行うには、MSI ファイルを右クリックし、[ 管理者として実行] を選択します。

サービスがインストールされたら、 サービス を開いてサービスを開始できます。 サービスをアンインストールするには、Windows の [プログラムの追加と削除] 機能を使用してインストーラーを呼び出します。