.NETヘルプ

Topshelf C#（開発者向けの動作方法）

更新日:6月 22, 2025

オープンソースパッケージのTopshelfは、.NETでWindowsサービスを作成するのを簡単にするために作成されました。このフレームワークは、Windowsサービスの作成、デプロイ、管理を簡素化し、サービス制御管理の複雑さではなく業務ロジックに集中できるようにします。 IronPDFと組み合わせて使用することで、開発者はPDFファイルの作成と変更を行う機能豊富なC#ライブラリを使用して、複雑な文書処理作業を管理できる信頼性のある強力なサービスを構築できます。

この接続により、企業はWindowsサービスのフレームワーク全体でPDFの作成、修正、配信を自動化することで、効果的で自動化されたドキュメントワークフローを必要とする企業にシームレスなソリューションを提供します。 TopshelfをC#のIronPDF for .NETと組み合わせて使用することで、開発者はサービスアプリケーションの機能性と保守性を高いレベルで確保し、堅牢さと使いやすさを保証します。

Topshelf C#とは何ですか？

オープンソースプロジェクトのTopshelf .NETパッケージは、Windowsサービスの開発、セットアップ、および実装を簡略化します。 Windowsサービスの作成のプロセスから多くの複雑さを排除することで、開発者はWindowsサービス管理の細部ではなくアプリケーションの重要な機能に集中できます。

Topshelfは、少ないコード変更でコンソールアプリをサービスに変換するのを簡単に行えます。また、依存関係やリカバリオプション、サービスの開始と停止のアクションを含むサービス設定を確立するための流動的なAPIを提供します。 .NET開発者が安定で管理しやすいWindowsサービスを効果的に作成しようとする際、Topshelfは使いやすさと適応性から人気があります。

Topshelf C# (How It Works For Developers): 図1

Topshelfが提供する多くの機能は、.NETでWindowsサービスを設計および維持するのを簡単にします。以下にその顕著な属性のいくつかを示します：

使いやすさ

Topshelfは、Windowsサービスの設定と管理のプロセスを簡素化する基本的で流動的なAPIを提供します。開発者は、ほとんどコードを変更しなくてもコンソールアプリをサービスに簡単に変換できます。

設定の柔軟性

開始、停止、一時停止、および継続のアクションを含む設定オプションをサポートしています。サービスの依存関係やサービスクラスのリカバリオプションを開発者が指定することもできます。

インストールとアンインストール

.NET Frameworkで書かれたホスティングサービスのデプロイメントは、サービスをインストールおよびアンインストールするためのTopshelfの組み込み機能によって容易になります。プログラムからまたはコマンドラインを通じてサービスをインストールできます。

ロギング

Topshelfは、log4net、NLog、Serilogなどの有名なロギングフレームワークと連携して、開発者がサービス操作やエラーを効率的にログに記録できるようにします。

サービス制御

一時停止、再開、開始、停止などの一般的なWindowsサービス制御のすべてに対応しています。開発者は、サービスライフサイクル全体を完全に制御できるようになりました。

例外処理

Topshelfの堅牢な例外処理の特徴は、サービスがエラーを上手に処理し、安定を維持できることを保証します。

複数のサービスインスタンス

同一のアプリケーション内で複数のサービスインスタンスを作成および管理できる機能を提供し、複雑なサービスアーキテクチャに柔軟性を与えます。

カスタムコマンドラインオプション

カスタムコマンドラインオプションにより、開発者はサービスの動作をさらにカスタマイズおよび制御できます。

環境認識

Topshelfは、プロダクションサーバー、テスト環境、または開発システムであろうと、その周囲を認識し適応することができます。

依存性注入のサポート

依存性注入フレームワークと組み合わせて使用することで、Topshelfはソフトウェアアーキテクチャを改善し、サービスの依存性の管理を容易にします。

クロスプラットフォーム機能

Topshelfは主にWindows用に作成されましたが、.NET Coreを使用することでLinuxやmacOSでもサービスを実行でき、他のオペレーティングシステムとの互換性を高めます。

Create and Config Topshelf C#

C#でTopshelfを使用してWindowsサービスを作成および構成するための手順は以下の通りです：

新しいVisual Studioプロジェクトを作成する

Visual Studioを使用してコンソールプロジェクトを簡単に作成できます。 Visual Studio環境でコンソールアプリケーションを開始するために、次の簡単な手順に従います：

Visual Studioを使用する前に、コンピュータにインストールされていることを確認してください。

新しいプロジェクトを開始する

ファイル、プロジェクトを選択した後、新しいメニューを選択します。

Topshelf C# (How It Works For Developers): 図2

以下のプロジェクトテンプレート参照リストから、「コンソールアプリ」または「コンソールアプリ（.NET Core）」を選択します。

プロジェクトに名前を付けるために「名前」フィールドに入力してください。

Topshelf C# (How It Works For Developers): 図3

プロジェクトの保存場所を選択します。

「作成」をクリックすると、コンソールアプリケーションプロジェクトが開きます。

Topshelf C# (How It Works For Developers): 図4

NuGetを介してTopshelfをインストールする

NuGetパッケージマネージャーを使用して、最初にプロジェクトにTopshelfを追加します。パッケージマネージャーおよびコンソールアプリケーションで、次のコマンドを実行します：

Install-Package Topshelf

サービスクラスを作成する

クラスのサービスロジックを説明します。このクラスで、開始および停止などのサービスアクションを実装する必要があります。

using System;
using Topshelf;

namespace MyWindowsService
{
    // Define a simple service class with Start and Stop methods
    public class MyService
    {
        public bool Start()
        {
            // Service start logic
            Console.WriteLine("Service Started.");
            return true;
        }

        public bool Stop()
        {
            // Service stop logic
            Console.WriteLine("Service Stopped.");
            return true;
        }
    }

    // Main program class to run the Topshelf service
    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                // Configure the service
                x.Service<MyService>(s =>
                {
                    s.ConstructUsing(name => new MyService());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });

                // Run the service as a local system
                x.RunAsLocalSystem();

                // Set service details
                x.SetServiceName("MyService");
                x.SetDisplayName("My Service");
                x.SetDescription("This is a sample service created using Topshelf.");
            });
        }
    }
}

using System;
using Topshelf;

namespace MyWindowsService
{
    // Define a simple service class with Start and Stop methods
    public class MyService
    {
        public bool Start()
        {
            // Service start logic
            Console.WriteLine("Service Started.");
            return true;
        }

        public bool Stop()
        {
            // Service stop logic
            Console.WriteLine("Service Stopped.");
            return true;
        }
    }

    // Main program class to run the Topshelf service
    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                // Configure the service
                x.Service<MyService>(s =>
                {
                    s.ConstructUsing(name => new MyService());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });

                // Run the service as a local system
                x.RunAsLocalSystem();

                // Set service details
                x.SetServiceName("MyService");
                x.SetDisplayName("My Service");
                x.SetDescription("This is a sample service created using Topshelf.");
            });
        }
    }
}

Imports System
Imports Topshelf

Namespace MyWindowsService
	' Define a simple service class with Start and Stop methods
	Public Class MyService
		Public Function Start() As Boolean
			' Service start logic
			Console.WriteLine("Service Started.")
			Return True
		End Function

		Public Function [Stop]() As Boolean
			' Service stop logic
			Console.WriteLine("Service Stopped.")
			Return True
		End Function
	End Class

	' Main program class to run the Topshelf service
	Friend Class Program
		Shared Sub Main(ByVal args() As String)
			HostFactory.Run(Sub(x)
				' Configure the service
				x.Service(Of MyService)(Sub(s)
					s.ConstructUsing(Function(name) New MyService())
					s.WhenStarted(Function(tc) tc.Start())
					s.WhenStopped(Function(tc) tc.Stop())
				End Sub)

				' Run the service as a local system
				x.RunAsLocalSystem()

				' Set service details
				x.SetServiceName("MyService")
				x.SetDisplayName("My Service")
				x.SetDescription("This is a sample service created using Topshelf.")
			End Sub)
		End Sub
	End Class
End Namespace

$vbLabelText $csharpLabel

Topshelf C# (How It Works For Developers): 図5

サービスを構成する

MyServiceクラスにサービスの開始と終了のメカニズムが含まれています。サービス定義およびそのライフサイクルメソッド（開始および停止）は、Topshelf構成が配置されたプログラムクラスの対応するサービスアクションに接続されています。単一のサービスクラスのrunメソッドを使用して、サービスの名前、表示名、説明などのプロパティを設定します。 Topshelfを使用してWindowsサービスを管理およびデプロイすることにより、この簡潔な構成が簡単に行えます。

サービスをビルドおよびインストールする

プロジェクトを構築中にエラーフリーであることを確認してください。コンパイルされた実行可能ファイルを使用して、コマンドラインからサービスを開始するには、インストールコマンドを使用します：

MyWindowsService.exe install

MyWindowsService.exe install

SHELL

サービスを開始する

サービスをインストールした後、次のコマンドを使用してサービスを起動します：

MyWindowsService.exe start

MyWindowsService.exe start

SHELL

サービスをアンインストールする

必要に応じてサービスをアンインストールするようにプロンプトを表示するために、次のコマンドを使用します：

MyWindowsService.exe uninstall

MyWindowsService.exe uninstall

SHELL

この例では、C#でTopshelfを使用してWindowsサービスを作成および構成する方法を示しています。Topshelfはプロセスを簡素化し、少ないコードでWindowsサービスの定義、インストール、セットアップ、管理を行うことを可能にします。

スタートガイド

IronPDFとTopshelfを使用してC#でWindowsサービスを構築を開始するために、次のアクションを実行します：

IronPDFとは何ですか？

IronPDF for .NET Librariesは、C#プログラムがPDFドキュメントを作成、読み取り、編集できる機能豊富な.NETライブラリです。このプログラムを使用すると、開発者はHTML、CSS、JavaScriptコンテンツから印刷可能な高品質のPDFを簡単に生成できます。 PDFの分割と結合、ドキュメントへの透かしの追加、ヘッダーとフッターの追加、およびHTMLのPDFへの変換は、基本機能の一部です。 IronPDFは、.NET Frameworkと. NET Coreの両方をサポートしており、さまざまなアプリケーションに役立ちます。

PDFは統合が簡単で、豊富なドキュメントがあるため、開発者はそれを簡単にプログラムへ組み込むことができます。 IronPDFは、複雑なレイアウトやフォーマットをスムーズに処理することで、生成されたPDFがソースHTMLコンテンツを密接に再現することを保証します。

Topshelf C# (How It Works For Developers): 図6

IronPDFの機能

HTMLからのPDF生成

JavaScript、HTML、およびCSSをPDFに変換します。メディアクエリおよびレスポンシブデザインといった現代のウェブ標準をサポートします。 HTMLとCSSでPDFの請求書、レポート、ドキュメントを動的に装飾するのに便利です。

PDF編集

既存のPDFにテキスト、画像、その他のコンテンツを追加できます。 PDFファイルからテキストや画像を抽出します。複数のPDFを1つのファイルに結合します。PDFファイルを複数の別々のドキュメントに分割します。ウォーターマーク、注釈、ヘッダー、フッターを追加します。

PDF変換

Word、Excel、画像ファイルなどのさまざまなファイル形式をPDF形式に変換します。 PDFから画像（PNG、JPEG、など）への変換。

パフォーマンスと信頼性

高性能と高信頼性は、産業環境における望ましい設計品質です。大規模なドキュメントセットを簡単に管理します。

IronPDFをインストールする

.NETプロジェクトでPDFを操作するためのツールを手に入れるために、IronPDFパッケージをインストールしてください。

Install-Package IronPdf

IronPDFを使用してサービスクラスを作成する

PDFファイルの作成と修正を行うIronPDFの機能と、クラスのサービスロジックを定義します。

using System;
using IronPdf;
using Topshelf;

namespace PdfService
{
    // Define a service class with PDF generation logic
    public class MyPdfService
    {
        public bool Start()
        {
            Console.WriteLine("Service Starting...");
            GeneratePdf();
            return true;
        }

        public bool Stop()
        {
            Console.WriteLine("Service Stopping...");
            return true;
        }

        // Method to generate a PDF using IronPDF
        private void GeneratePdf()
        {
            var renderer = new HtmlToPdf();
            var pdf = renderer.RenderHtmlAsPdf("<h1>Hello, PDF!</h1>");
            pdf.SaveAs("GeneratedDocument.pdf");
            Console.WriteLine("PDF Generated.");
        }
    }

    // Main program to configure and run the service using Topshelf
    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                x.Service<MyPdfService>(s =>
                {
                    s.ConstructUsing(name => new MyPdfService());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });

                x.RunAsLocalSystem();
                x.SetServiceName("MyPdfService");
                x.SetDisplayName("My PDF Service");
                x.SetDescription("A service that generates PDF files using IronPDF and Topshelf.");
            });
        }
    }
}

using System;
using IronPdf;
using Topshelf;

namespace PdfService
{
    // Define a service class with PDF generation logic
    public class MyPdfService
    {
        public bool Start()
        {
            Console.WriteLine("Service Starting...");
            GeneratePdf();
            return true;
        }

        public bool Stop()
        {
            Console.WriteLine("Service Stopping...");
            return true;
        }

        // Method to generate a PDF using IronPDF
        private void GeneratePdf()
        {
            var renderer = new HtmlToPdf();
            var pdf = renderer.RenderHtmlAsPdf("<h1>Hello, PDF!</h1>");
            pdf.SaveAs("GeneratedDocument.pdf");
            Console.WriteLine("PDF Generated.");
        }
    }

    // Main program to configure and run the service using Topshelf
    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                x.Service<MyPdfService>(s =>
                {
                    s.ConstructUsing(name => new MyPdfService());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });

                x.RunAsLocalSystem();
                x.SetServiceName("MyPdfService");
                x.SetDisplayName("My PDF Service");
                x.SetDescription("A service that generates PDF files using IronPDF and Topshelf.");
            });
        }
    }
}

Imports System
Imports IronPdf
Imports Topshelf

Namespace PdfService
	' Define a service class with PDF generation logic
	Public Class MyPdfService
		Public Function Start() As Boolean
			Console.WriteLine("Service Starting...")
			GeneratePdf()
			Return True
		End Function

		Public Function [Stop]() As Boolean
			Console.WriteLine("Service Stopping...")
			Return True
		End Function

		' Method to generate a PDF using IronPDF
		Private Sub GeneratePdf()
			Dim renderer = New HtmlToPdf()
			Dim pdf = renderer.RenderHtmlAsPdf("<h1>Hello, PDF!</h1>")
			pdf.SaveAs("GeneratedDocument.pdf")
			Console.WriteLine("PDF Generated.")
		End Sub
	End Class

	' Main program to configure and run the service using Topshelf
	Friend Class Program
		Shared Sub Main(ByVal args() As String)
			HostFactory.Run(Sub(x)
				x.Service(Of MyPdfService)(Sub(s)
					s.ConstructUsing(Function(name) New MyPdfService())
					s.WhenStarted(Function(tc) tc.Start())
					s.WhenStopped(Function(tc) tc.Stop())
				End Sub)

				x.RunAsLocalSystem()
				x.SetServiceName("MyPdfService")
				x.SetDisplayName("My PDF Service")
				x.SetDescription("A service that generates PDF files using IronPDF and Topshelf.")
			End Sub)
		End Sub
	End Class
End Namespace

$vbLabelText $csharpLabel

開発者はC#でTopshelfとIronPDFを組み合わせることで、PDF生成と操作のための強力なWindowsサービスを迅速に設計できます。 Topshelfは、流動的でユーザーフレンドリーなAPIを提供し、Windowsサービスの設定と管理を簡素化します。

Topshelf C# (How It Works For Developers): 図7

例で示されているMyPdfServiceクラスは、サービスの開始（Start）と終了（Stop）のメソッドを実装しており、サービスロジックをカプセル化しています。 IronPDFはStartメソッドで使用されており、HTMLテキストからHTMLでPDFドキュメントを作成します。 The ability to render HTML into a PDF format using IronPDF's HtmlToPdf class is demonstrated, showing how to turn basic HTML information (such as "

Hello, PDF!

") into a PDF file ("GeneratedDocument.pdf").

Topshelf C# (How It Works For Developers): 図8

この統合は、Topshelfがサービスのライフタイムを管理し、完全なWindowsサービスとして機能することを保証する方法と、IronPDFがPDFの生成のような困難なプロセスを容易に管理する方法を示しています。 C#でTopshelfとIronPDFを組み合わせたこの統合は、自動化されたドキュメント作成や変更が必要なアプリケーションに最適です。それは信頼性と保守の容易さを提供します。

結論

結論として、TopshelfとIronPDFをC#で組み合わせることで、PDFの作成と操作に関与するWindowsサービスの作成と管理が可能になります。 Topshelfはサービス構成および管理のための使いやすいAPIを提供することで、Windowsサービスのデプロイメントを簡素化します。一方で、IronPDFはサービスロジック内でのHTML情報を元にPDFドキュメントのスムーズ生成を促進することにより、機能性を向上させます。

この統合は、開発プロセスを合理化し、自動化されたドキュメントワークフローでの信頼性のある強力なパフォーマンスを保証します。 C#でTopshelfとIronPDFを組み合わせることで、開発者は複雑なドキュメント処理ソリューションを簡単に作成できる、柔軟で効果的なオプションとして際立っています、報告書、請求書、その他のPDFベースのタスクの作成において。

IronPDFとIron Software Licensing Informationは、Iron Softwareの非常に柔軟なシステムおよびスイートをそのコアサポートと組み合わせることで、より多くのオンラインアプリと機能を開発者に提供し、より効果的な開発を実現します。

ライセンスオプションがプロジェクトに明確で具体的である場合、開発者はどのモデルが最適かをより簡単に判断できます。これらの利点により、開発者は幅広い問題を明確、効果的、そして密接に統合された方法で解決することができます。

よくある質問

Topshelfは.NETでWindowsサービスの作成をどのように簡素化しますか？

Topshelfは、コンソールアプリケーションを最小限のコード変更でWindowsサービスに変換する簡単なAPIを提供します。使いやすさ、設定の柔軟性、強力な例外処理に重点を置いており、サービス管理の複雑さではなくビジネスロジックに専念することができます。

TopshelfはWindows以外のプラットフォームでも使用できますか？

はい、Topshelfは主にWindows向けに設計されていますが、.NET Coreを使用することでLinuxやmacOS上でも動作し、そのクロスプラットフォームの能力が高まります。

TopshelfとIronPDFを統合することでどのような利点がありますか？

IronPDFをTopshelfと統合することで、Windowsサービス内でPDFドキュメントのワークフローを自動化することができます。この組み合わせにより、Topshelfのサービス管理とIronPDFのPDF機能を活用して、PDFドキュメントの作成、修正、および配布を行うための堅牢なソリューションが提供されます。

C#でHTMLコンテンツをPDFドキュメントに変換するにはどうすればよいですか？

IronPDFを使用して、HTML、CSS、およびJavaScriptコンテンツをPDFドキュメントに変換することができます。IronPDFは、最新のWeb標準とレスポンシブデザインをサポートしており、高品質なPDF出力を保証します。

Topshelfを使用してWindowsサービスを構築するプロセスは何ですか？

Topshelfを使用してWindowsサービスを構築するには、Visual Studioで新しいプロジェクトを作成し、NuGet経由でTopshelfをインストールし、StartとStopメソッドを持つサービスクラスを書き、TopshelfのAPIを使用してサービスを構成し、プロジェクトを構築します。最後に、コマンドラインコマンドを使用してサービスをインストールして起動します。

サービス管理におけるTopshelfの主要な機能は何ですか？

Topshelfは、使いやすさ、設定の柔軟性、ログ記録、強力な例外処理、複数のサービスインスタンスのサポート、および一般的なWindowsサービスコントロールとの互換性などの機能を提供し、.NET開発者にとって多用途なツールとなっています。

Windowsサービスを使用して自動文書ワークフローを実装する方法は？

TopshelfとIronPDFを統合することで、PDFの生成、修正、配布などのタスクをサービスフレームワーク内で処理するWindowsサービスを作成して、自動文書ワークフローを実装できます。

IronPDFのライセンスオプションはどのようになっていますか？

IronPDFは、さまざまなプロジェクトのニーズに合わせた柔軟なライセンスオプションを提供し、開発者が特定の要件に応じてアプリケーションにPDF機能を効率的に統合できるようにします。

Curtis Chau

今すぐエンジニアリングチームとチャット

テクニカルライター

Curtis Chauは、カールトン大学でコンピュータサイエンスの学士号を取得し、Node.js、TypeScript、JavaScript、およびReactに精通したフロントエンド開発を専門としています。直感的で美しいユーザーインターフェースを作成することに情熱を持ち、Curtisは現代のフレームワークを用いた開発や、構造の良い視覚的に魅力的なマニュアルの作成を楽しんでいます。

開発以外にも、CurtisはIoT（Internet of Things）への強い関心を持ち、ハードウェアとソフトウェアの統合方法を模索しています。余暇には、ゲームをしたりDiscordボットを作成したりして、技術に対する愛情と創造性を組み合わせています。