信息圖標
跳過到頁腳內容
  1. IronPDF
  2. IronPDF博客
  3. .NET幫助
  4. Topshelf C#
.NET幫助

Topshelf C#（對於開發者的運行原理）

Curtis Chau
Curtis Chau
更新日期:

一個受歡迎的開源套件叫做Topshelf，旨在簡化在.NET中創建Windows服務。 它提供的框架簡化了創建、部署和管理Windows服務的過程，讓開發人員專注於業務邏輯，而不是服務控制管理的複雜性。 結合IronPDF，一個功能豐富的C#庫，用於創建和修改PDF文件，開發人員可以構建可靠和強大的服務，用於處理複雜的文檔處理任務。

這種連接通過自動化創建、修改和分發PDF文件，提供企業一個無縫的解決方案，適用於需要有效的自動化文檔工作流的情況。 通過在C#中將Topshelf與IronPDF for .NET結合使用，開發人員可以在其服務應用程序中獲得高功能性和可維護性，保證既穩健又易於使用。

什麼是Topshelf C#？

開源項目Topshelf .NET套件的幫助下，開發、設置和實施Windows服務變得更簡單。 通過消除創建Windows服務過程中的許多複雜性，開發人員可以更專注於應用程序的基本功能，而不是Windows服務管理的細節。

Topshelf允許開發人員不需過多代碼更改即輕鬆將控制台應用程序轉換為服務。 它還提供流暢的API，用於設置服務配置，包括依賴、恢復選項和啟停服務的操作。 由於易於使用和適應性強，Topshelf對於希望高效創建穩定且易於管理的Windows服務的.NET開發人員來說是一個受歡迎的選擇。

Topshelf C# (開發人員如何運作)：圖1

Topshelf提供的多種功能，使設計和維護.NET中的Windows服務變得更容易。 以下是其一些顯著特點：

易用性

Topshelf提供基本且流暢的API，簡化使用它配置和管理Windows服務的過程。 開發人員可以輕鬆地將控制台應用程序轉換為服務，而幾乎不需代碼修改。

配置靈活性

支持的配置選項包括啟動、停止、暫停和繼續操作。 開發人員還可以指定服務類的依賴關係和恢復選項。

安裝和卸載

Topshelf的內置功能促進了通過.NET Framework編寫的托管服務的部署。 可以通過編程或命令行安裝服務。

日誌記錄

Topshelf與著名的日誌框架如log4net、NLog和Serilog集成，使開發人員能夠高效地記錄服務操作和故障。

服務控制

它兼容所有常見的Windows服務控制，例如暫停、繼續、啟動和停止。開發人員現在可以完全控制整個服務生命周期。

異常處理

Topshelf的強大異常處理功能保證服務能夠優雅地處理故障並保持穩定。

多服務實例

允許在同一應用程序內創建和管理許多服務實例，使其為複雜服務架構提供靈活性。

自定義命令行選項

自定義命令行選項使開發人員能進一步定制和控制其服務的行為。

環境意識

無論是生產服務器、測試環境或開發系統，Topshelf都能識別並適應其環境。

依賴注入支持

當與依賴注入框架一起使用時，Topshelf使服務依賴的管理變得更容易，並提供更好的軟件架構。

跨平台功能

Topshelf最初是為Windows創建，但當使用.NET Core時，也可以在Linux和macOS上運行服務，從而增加其與其他操作系統的兼容性。

創建和配置Topshelf C

使用Topshelf在C#中創建和配置Windows服務，請執行以下步驟：

創建新的 Visual Studio 項目

使用 Visual Studio 創建控制台項目很簡單。 要在Visual Studio環境中啟動控制台應用程序，請按以下簡單步驟進行：

使用Visual Studio之前，請確保您已在計算機上安裝它。

啟動新項目

選擇文件、項目後，選擇新建菜單。

Topshelf C# (開發人員如何運作)：圖2

在下面的項目模板引用列表中選擇"Console App"或"Console App (.NET Core)"。

請填寫“名稱”字段以給您的項目命名。

Topshelf C# (開發人員如何運作)：圖3

選擇項目存儲位置。

當您點擊"創建"時，控制台應用程序項目將打開。

Topshelf C# (開發人員如何運作)：圖4

通過NuGet安裝Topshelf

首先使用NuGet Package Manager將Topshelf添加到您的項目中。 在Package Manager和Console應用程序中執行以下命令：

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# (開發人員如何運作)：圖5

配置服務

MyService類中包含了啟動和終止服務的機制。 服務定義及其生命周期方法（啟動和停止）與Program類中的對應服務操作鏈接，該類容納Topshelf配置。 通過單一服務類的運行方法設置服務的屬性，例如名稱、顯示名稱和說明。 使Topshelf管理和部署Windows服務簡單化的這一簡明配置。

構建和安裝服務

在構建項目時，確保無錯誤。 使用安裝命令和編譯的可執行文件，從命令行啟動服務：

MyWindowsService.exe install
MyWindowsService.exe install
SHELL

啟動服務

安裝後使用以下命令啟動服務：

MyWindowsService.exe start
MyWindowsService.exe start
SHELL

卸載服務

如果需要，使用以下命令提示符卸載服務：

MyWindowsService.exe uninstall
MyWindowsService.exe uninstall
SHELL

此示例演示如何使用Topshelf在C#中創建和配置Windows服務。Topshelf簡化了該過程，使定義、安裝、設置和管理Windows服務變得輕而易舉。

開始使用

使用IronPDF和Topshelf在C#中開始構建Windows服務，請採取以下措施：

什麼是 IronPDF？

IronPDF for .NET Libraries是一個功能豐富的.NET庫，C#程序可用於創建、讀取和編輯PDF文檔。 使用此程序，開發人員可以輕鬆從HTML、CSS和JavaScript內容中生成打印準備的高質量PDF文件。 拆分和合併PDF文件，給文檔加水印，添加頁眉和頁腳，以及將HTML轉換為PDF都是一些基本功能。 IronPDF支持.NET Framework和.NET Core，適用於多種應用程序。

因為PDF文件易於集成且擁有充足的文檔，開發人員可以輕鬆將它們集成到他們的程序中。 IronPDF保證生成的PDF文件能夠輕鬆處理複雜布局和格式設置，從而與源HTML內容非常相似。

Topshelf C# (開發人員如何運作)：圖6

IronPDF 的特點

從HTML生成PDF

將 JavaScript、HTML 和 CSS 轉換為 PDF。 支持媒體查詢和響應設計這兩種現代 Web 標準。 對動態裝飾PDF賬單、報告和文檔與HTML和CSS非常有用。

PDF編輯功能

可以在現有的 PDF 上添加文本、影像和其他內容。 從PDF文件中提取文字和圖片。 將多個PDF合併為一個文件。將PDF文件拆分成多個獨立文件。 添加水印、註釋、頁首和頁尾。

PDF轉換功能

將包括Word、Excel和圖片文件在內的多種文件格式轉換為PDF格式。 PDF 到圖像轉換（PNG、JPEG 等）。

性能和可靠性

在工業環境中，高性能和可靠性是期望的設計品質。 輕鬆處理大型文檔集。

首先，確保你的項目安裝了 IronPDF 庫。

要獲取在 .NET 專案中處理解 PDF 的工具包，請安裝 IronPDF 套件。

Install-Package IronPdf

用IronPDF創建您的服務類

定義IronPDF的功能，以創建和修改PDF文件以及類的服務邏輯。

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# (開發人員如何運作)：圖7

在給定的示例中，MyPdfService類，實現了啟動(Start)和結束(Stop)服務的方法，封裝了服務邏輯。 IronPDF在Start方法中使用，以從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# (開發人員如何運作)：圖8

此整合展示了如何利用IronPDF輕鬆處理創建PDF的複雜過程，使其作為完整的Windows服務運行，Topshelf如何控制服務的生命周期以保證功能。 使用Topshelf和IronPDF的結合能力在C#中，此集成非常適合需要自動文檔創建或修改的應用程序。 它提供可靠性和易維護性。

結論

總而言之，Topshelf和IronPDF的組合使在C#創建和管理包含PDF生成和操作的Windows服務成為可能。 Topshelf透過為服務配置和管理提供用戶友好的API，簡化了Windows服務的部署。 通過打通服務邏輯內從HTML資訊生成PDF文檔的過程，IronPDF提高了功能性，從而改善整體性能。

此集成保證自動化文檔工作流中的可靠和強力表現，同時也優化了開發過程。 結合Topshelf和IronPDF在C#中，以開發報告、發票或任何其他基於PDF的任務的複雜文檔處理解決方案的開發人員是一個靈活且高效的選擇。

IronPDF與Iron Software Licensing Information結合了Iron Software的超靈活系統和套件及其核心支持，為開發人員提供更多線上應用和功能以及更有效的開發。

如果許可選項明確且具體到項目，開發人員更容易確定哪個模型是最佳的。 這些優勢使開發人員能夠以明確、有效和整體集成的方式解決各種問題。

常見問題解答

Topshelf 如何簡化 .NET 中 Windows 服務的創建？

Topshelf 提供一個簡單的 API，允許開發者通過最小代碼更改將控制台應用程序轉換為 Windows 服務。它專注於使用方便、配置靈活性和強大的異常處理，使開發者能夠專注於業務邏輯而不是服務管理的複雜性。

Topshelf 可以在 Windows 以外的平台使用嗎？

可以，雖然 Topshelf 主要設計為 Windows，但它也可以在 Linux 和 macOS 上運行，使用 .NET Core 增強其跨平台能力。

將 IronPDF 與 Topshelf 整合有何好處？

將 IronPDF 與 Topshelf 整合允許開發者在 Windows 服務中自動化 PDF 文檔工作流程。這種組合提供了一個健壯的解決方案來創建、修改和分發 PDF 文檔，利用 Topshelf 的服務管理和 IronPDF 的 PDF 功能。

如何在 C# 中將 HTML 內容轉換為 PDF 文檔？

您可以使用 IronPDF 通過其為 HTML 到 PDF 轉換而設計的方法將 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
  立即與工程團隊聊天
技術作家

Curtis Chau 擁有卡爾頓大學計算機科學學士學位，專注於前端開發，擅長於 Node.js、TypeScript、JavaScript 和 React。Curtis 熱衷於創建直觀且美觀的用戶界面，喜歡使用現代框架並打造結構良好、視覺吸引人的手冊。

除了開發之外，Curtis 對物聯網 (IoT) 有著濃厚的興趣，探索將硬體和軟體結合的創新方式。在閒暇時間，他喜愛遊戲並構建 Discord 機器人，結合科技與創意的樂趣。

相關文章

30 天試用→完整產品。無限制。無需信用卡。 開始免費試用