Windows 서비스 설치 프로그램 만들기

아티클
02/17/2024

.NET Windows 서비스(.NET Framework Windows 서비스와 혼동하지 말 것)를 만들 때 서비스에 대한 설치 프로그램을 만들 수 있습니다. 설치 프로그램이 없으면 사용자는 서비스를 설치하고 구성하는 방법을 알아야 합니다. 설치 프로그램은 앱의 실행 파일을 번들로 묶고 사용자 지정 가능한 설치 사용자 환경을 제공합니다. 이 자습서는 Windows 서비스 만들기 자습서의 연속입니다. .NET Windows 서비스용 설치 프로그램을 만드는 방법을 보여 줍니다.

이 자습서에서는 다음 작업을 수행하는 방법을 알아봅니다.

Visual Studio 설치 관리자 프로젝트 확장을 설치합니다.
설치 프로젝트를 만듭니다.
설치를 지원하도록 기존 .NET Worker 프로젝트를 업데이트합니다.
Windows 서비스 제어 관리자를 사용하여 설치 및 제거를 자동화합니다.

필수 조건

Windows 서비스 만들기 자습서를 완료했거나 샘플 리포지토리를 복제할 준비가 되어 있어야 합니다.
.NET 8.0 SDK 이상
Windows OS
.NET IDE(통합 개발 환경)
- 자유롭게 사용할 수 있는 Visual Studio
기존 .NET Windows 서비스

Wix 도구 집합을 설치하여 시작합니다. Wix 도구 집합은 XML 소스 코드에서 Windows 설치 패키지를 빌드하는 도구 집합입니다.

dotnet tool install --global wix

다음으로, VS2022용 HeatWave 확장을 설치합니다. 설치 후 Visual Studio를 다시 시작하면 사용 가능한 새 프로젝트 템플릿이 표시됩니다.

기존 프로젝트 가져오기

이 자습서는 BackgroundService를 사용하여 Windows 서비스 만들기 자습서의 일부로 만들어진 앱을 기반으로 합니다. 샘플 리포지토리를 복제하거나 이전 자습서에서 빌드한 앱을 사용할 수 있습니다.

팁

모든 ‘.NET의 작업자’ 예제 소스 코드는 샘플 브라우저에서 다운로드할 수 있습니다. 자세한 내용은 코드 샘플 찾아보기: .NET의 작업자를 참조하세요.

WiX 도구 집합
Microsoft 설치 프로그램 확장

Visual Studio에서 솔루션을 열고 F5를 선택하여 앱이 예상대로 빌드되고 실행되는지 확인합니다. 앱을 중지하려면 Ctrl+C를 누릅니다.

핸들 설치 스위치

Windows 서비스 앱은 설치 스위치를 처리해야 합니다. 설치 프로젝트는 설치 및 제거 중에 각각 /Install 및 /Uninstall 스위치를 사용하여 Windows 서비스 앱을 호출합니다. 이러한 스위치가 있으면 앱은 Windows 서비스 제어 관리자 실행 파일(sc.exe)을 사용하여 설치 또는 제거만 수행한다는 점에서 다르게 작동합니다.

앱이 별도의 프로세스를 호출하려면 편의를 위해 CliWrap NuGet 패키지를 설치합니다. CliWrap 패키지를 설치하려면 dotnet add package 명령을 사용합니다.

dotnet add App.WindowsService.csproj package CliWrap

자세한 내용은 dotnet add package를 참조하세요.

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 도구 집합을 사용하는 것이 좋습니다.

새 설치 프로젝트 추가

WiX 도구 집합
Microsoft 설치 프로그램 확장

새 Wix 설정 프로젝트를 추가하려면 솔루션 탐색기에서 솔루션을 마우스 오른쪽 단추로 클릭하고 > 새 프로젝트 추가를 선택합니다.

Add new project dialog: New MSI Package (Wix v4) Project.

사용 가능한 템플릿에서 MSI 패키지(Wix v4)를 선택한 후 다음을 선택합니다. 원하는 이름과 위치를 입력한 다음 만들기를 선택합니다.

설치 프로그램 프로젝트 구성

WiX 도구 집합
Microsoft 설치 프로그램 확장

설정 프로젝트를 구성하려면 먼저 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를 선택하여 프로젝트 속성 창을 엽니다. 앱의 "추가" 및 "제거" 아이콘, 작성자, 제조업체, 제품 이름, 제목, 대상 플랫폼 등을 구성할 수 있습니다.

Installer project properties pane.

설치 프로그램 프로젝트는 설치 작업에 대한 두 가지 사용자 지정 작업을 정의해야 합니다. 솔루션 탐색기에서 프로젝트를 마우스 오른쪽 단추로 클릭한 다음 > 사용자 지정 작업 보기를 선택합니다.

Installer project Custom Actions context menu.

사용자 지정 작업 창에서 설치 > 사용자 지정 작업 추가를 선택합니다.

Custom Actions properties dialog: select item.

애플리케이션 폴더를 두 번 클릭하고(또는 애플리케이션 폴더가 선택된 상태에서 출력 추가... 선택, App.WindowsService에서 항목 게시(활성)를 선택합니다.

Custom Actions properties dialog: select item app folder.

확인을 선택하여 선택을 확인합니다. 설치 아래에 추가된 Publish Items from App.WindowsService(Active) 노드를 마우스 오른쪽 단추로 클릭한 다음 속성을 선택합니다.

Publish items properties.

인수에 /Install을 추가합니다. 제거에 대해서도 동일한 단계를 수행하여 인수에 /Uninstall을 추가합니다.

두 가지를 모두 완료하면 다음이 표시됩니다.

Custom Actions with Install and Uninstall actions defined.

이러한 업데이트를 통해 설치 프로젝트는 적절한 인수를 사용하여 Windows 서비스 앱을 호출하도록 설치 및 제거 작업을 위임하도록 구성되었습니다.

테스트 설치

WiX 도구 집합
Microsoft 설치 프로그램 확장

설치 프로그램을 테스트하려면 App.WindowsService 프로젝트를 게시합니다. 솔루션 탐색기에서 프로젝트를 마우스 오른쪽 단추로 클릭한 다음 게시를 선택합니다. 이전 자습서에서 만든 프로필을 사용하여 게시하면 실행 파일이 게시 디렉터리에 있게 됩니다. 다음으로 설치 프로젝트를 빌드하고 설치 프로그램을 실행합니다.

관리자 권한으로 설치를 실행해야 합니다. 이렇게 하려면 MSI 파일을 마우스 오른쪽 단추로 클릭한 다음 관리자 권한으로 실행을 선택합니다.

서비스가 설치되면 서비스를 열어 실행 중인 서비스를 확인할 수 있습니다. 서비스를 제거하려면 Windows 프로그램 추가/제거 기능을 사용하여 설치 프로그램을 호출합니다.