Создание установщика службы Windows

Начните с установки набора инструментов Wix. Набор инструментов Wix — это набор средств, которые создают пакеты установки Windows из исходного кода XML.

dotnet tool install --global wix

Затем установите расширение HeatWave для VS2022. После установки перезапустите Visual Studio и увидите доступные новые шаблоны проектов.

Установите расширение проектов установщика Microsoft Visual Studio. После установки перезапустите Visual Studio и увидите доступные новые шаблоны проектов.

Откройте решение в Visual Studio и выберите F5 , чтобы убедиться, что приложение создает и выполняется должным образом. Чтобы остановить приложение, нажмите клавиши CTRL+C.

Откройте решение в Visual Studio и выберите F5 , чтобы убедиться, что приложение создает и выполняется должным образом. Чтобы остановить приложение, нажмите клавиши CTRL+C.

Обработка коммутаторов установки

Приложение службы Windows должно обрабатывать параметры переключателей установки. Проект установки вызовет приложение службы Windows с переключателями /Install и /Uninstall во время установки и удаления соответственно. Если эти переключатели присутствуют, приложение будет вести себя по-разному, в том случае, что оно будет выполнять установку или удаление только с помощью исполняемого файла Диспетчера управления службами Windows (sc.exe).

Чтобы приложение вызывало отдельный процесс, установите пакет NuGet CliWrap в качестве удобства. Чтобы установить CliWrap пакет, используйте следующую команду.

dotnet add App.WindowsService.csproj package CliWrap

Дополнительные сведения см. в разделе dotnet package add.

После CliWrap установки откройте файлApp.WindowsService Program.cs проекта. 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 на одно значение.
• Получает исполняемый путь из файла 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 версии 4) из доступных шаблонов, а затем нажмите кнопку "Далее". Укажите нужное имя и расположение, а затем нажмите кнопку "Создать".

Чтобы добавить новый проект установки, щелкните правой кнопкой мыши решение в обозревателе решений и выберите команду Добавить > новый проект:

Выберите "Настройка проекта " из доступных шаблонов и нажмите кнопку "Далее". Укажите нужное имя и расположение, а затем нажмите кнопку "Создать".

Чтобы настроить проект установки, сначала необходимо добавить ссылку на 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 -->
        <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>

ServiceInstall Атрибут элемента Account указывает учетную запись, в которой выполняется служба. Учетная LocalService запись — это встроенная учетная запись с ограниченными привилегиями, подходящими для большинства служб. К общим значениям относятся:

• LocalService: встроенная учетная запись с ограниченными привилегиями и без сетевых учетных данных.
• NetworkService: аналогично LocalService, но имеет сетевые учетные данные.
• LocalSystem: высокий уровень привилегий (используйте с осторожностью).

При сборке проекта выходные данные — это MSI-файл, который можно использовать для установки и удаления службы.

Чтобы настроить проект установщика, выберите проект в обозревателе решений. Выберите F4 , чтобы открыть область свойств проекта. Вы можете настроить значки «добавить» и «удалить», автора, производителя, имя продукта, заголовок, целевую платформу и так далее.

Проект установщика должен определить два пользовательских действия для настройки процесса установки. Щелкните проект правой кнопкой мыши в обозревателе решений и выберите пункт "Просмотреть > настраиваемые действия".

В окне "Пользовательские действия" выберите "Установить > настраиваемое действие".

Дважды щелкните папку приложения (или выберите Добавить выходные данные... с выбранной папкой приложения), а затем выберите Опубликовать элементы из App.WindowsService (Active).

Нажмите кнопку "ОК ", чтобы подтвердить выбор. Щелкните правой кнопкой мыши по добавленному узлу Publish Items from App.WindowsService (Active) в категории «Установка», а затем выберите «Свойства».

Добавьте /Install в аргументы. Выполните те же действия для удаления, добавив /Uninstall в аргументы.

После выполнения обоих действий вы увидите следующее:

С этими обновлениями проект установки настроен для делегирования действий установки и удаления для вызова приложения службы Windows с соответствующими аргументами.

Чтобы протестировать установщик, опубликуйте проект App.WindowsService . Щелкните проект правой кнопкой мыши в обозревателе решений и выберите "Опубликовать". После публикации с профилем, созданным в предыдущем руководстве, исполняемый файл будет находиться в каталоге публикации. Затем вы создадите проект установки и запустите установщик.

Необходимо запустить установку от имени администратора. Для этого щелкните файл MSI правой кнопкой мыши и выберите команду "Запуск от имени администратора".

После установки службы можно открыть службы , чтобы увидеть запущенную службу. Чтобы удалить службу, используйте функцию "Добавление или удаление программ" Windows для вызова установщика.

Чтобы протестировать установщик, разверните конфигурации решений в Visual Studio и выберите "Выпуск " (при условии, что выбрана отладка ). Создайте решение, а затем щелкните правой кнопкой мыши на проекте установки и выберите Сборка. По умолчанию проекты установки не являются частью сборки.

Выберите «Просмотр > вывода» и проверьте, что в раскрывающемся списке «Показать вывод» выбрана Сборка. Отображается путь к файлу установщика Майкрософт (MSI). Скопируйте путь и откройте установщик. Запустите установщик.

Необходимо запустить установку от имени администратора. Для этого щелкните файл MSI правой кнопкой мыши и выберите команду "Запуск от имени администратора".

После установки службы можно открыть службы для запуска службы. Чтобы удалить службу, используйте функцию "Добавление или удаление программ" Windows для вызова установщика.