跳至页脚内容
.NET 帮助

Topshelf C#(开发人员如何使用)

一个受欢迎的开源包叫做Topshelf,是为了简化在.NET中创建Windows服务而开发的。 它提供的框架简化并使得创建、部署和管理Windows服务变得合理,使开发人员能够专注于业务逻辑而不是服务控制管理的复杂性。 结合IronPDF,一个用于创建和修改PDF文件的功能丰富的C#库,开发人员可以构建可靠且强大的服务来处理复杂的文档处理任务。

通过自动化在完整的Windows服务框架内创建、修订和分发PDF文件,这一连接为需要有效和自动化文档工作流程的企业提供了无缝解决方案。 通过在C#中使用Topshelf和IronPDF for .NET,开发人员可以在他们的服务应用程序中获得高水平的功能和可维护性,保证稳健性和易用性。

Topshelf C#是什么?

Topshelf .NET包的开源项目帮助简化了Windows服务的开发、设置和实现。 通过消除创建Windows服务过程中很多的复杂性,开发人员能够更专注于他们应用程序的基本功能而不是Windows服务管理的复杂细节。

Topshelf使得开发人员无需大量代码更改即可轻松将控制台应用程序转换为服务。 它还提供了流畅的API来配置服务设置,包括依赖关系、恢复选项以及启动和停止服务的动作。 对于希望有效创建稳定可管理的Windows服务的.NET开发人员来说,由于其易用性和适应性,Topshelf是一个受欢迎的选择。

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#

通过执行以下步骤,在C#中使用Topshelf创建和配置Windows服务:

创建新的 Visual Studio 项目

使用 Visual Studio 创建一个控制台项目很容易。 要在Visual Studio环境中启动一个控制台应用程序,请按照以下简单步骤操作:

在使用Visual Studio之前,请确保已在计算机上安装。

启动新项目

选择文件后,项目,选择新菜单。

Topshelf C# (开发人员如何使用): 图2

在下面的项目模板引用列表中选择"控制台应用程序"或"控制台应用程序(.NET Core)"。

要给您的项目命名,请填写"名称"字段。

Topshelf C# (开发人员如何使用): 图3

选择项目存储的位置。

当您点击"创建"时,将打开控制台应用程序项目。

Topshelf C# (开发人员如何使用): 图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# (开发人员如何使用): 图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

此示例向您展示了如何在C#中使用Topshelf创建和配置Windows服务。Topshelf简化了该过程,促进了Windows服务的定义、安装、设置和管理,几乎无需代码。

入门

要使用IronPDF和Topshelf在C#中开始构建Windows服务,请采取以下操作:

什么是 IronPDF? [IronPDF for .NET Libraries](https://ironpdf.com) 是一个功能丰富的.NET库,C#程序可使用它来创建、读取和编辑PDF文档。 通过此程序,开发人员可以轻松地从HTML、CSS和JavaScript内容中生成打印就绪的高质量PDF。 拆分和合并PDF、给文件加水印、添加页眉页脚以及将HTML转换为PDF是几个基本功能。 IronPDF支持.NET Framework和.NET Core,使其在各类应用程序中都有用。 由于PDF集成简单且具有丰富的文档,开发人员可以轻松将它们集成到他们的程序中。 IronPDF确保生成的PDF文件与源HTML内容紧密匹配,可以轻松处理复杂的布局和格式。 ![Topshelf C# (开发人员如何使用): 图6](/static-assets/pdf/blog/topshelf-csharp/topshelf-csharp-6.webp) ### IronPDF的功能 **从HTML生成PDF** 将JavaScript、HTML和CSS转换为PDF。 支持媒体查询和响应式设计等现代网络标准。 用于动态修饰带有HTML和CSS的PDF账单、报告和文件。 **PDF编辑** 可以将文本、照片和其他内容添加到现有 PDF 中。 从PDF文件中提取文本和图片。 将多个PDF合并为一个文件。将PDF文件拆分为多个单独的文档。 添加水印、注释、标题和页脚。 **PDF转换** 将多种文件格式,包括Word、Excel和图像文件,转换为PDF格式。 PDF到图像转换(PNG、JPEG等)。 **性能和可靠性** 在工业环境中,高性能和可靠性是理想的设计特性。 轻松管理大型文档集。 ### 安装IronPDF 为了在.NET项目中获得处理PDF所需的工具,请安装IronPDF包。 ```shell :ProductInstall ``` ### 使用IronPDF创建您的服务类 定义IronPDF创建和修改PDF文件的功能以及类的服务逻辑。 ```csharp 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("

Hello, PDF!

"); 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(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."); }); } } } ``` 通过在C#中结合使用Topshelf和IronPDF,开发人员可以快速设计出用于PDF生成和操作的强大Windows服务。 Topshelf提供了一个流畅且用户友好的API,使得设置和管理Windows服务更加容易。 ![Topshelf C# (开发人员如何使用): 图7](/static-assets/pdf/blog/topshelf-csharp/topshelf-csharp-7.webp) 一个实现服务启动方法(`Start`)和结束方法(`Stop`)的`MyPdfService`类封装了给定示例中的服务逻辑。 在`Start`方法中使用IronPDF从HTML文本创建一个简单的[HTML的PDF](/examples/using-html-to-create-a-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](/static-assets/pdf/blog/topshelf-csharp/topshelf-csharp-8.webp) 此集成演示了如何通过Topshelf管理服务的生命周期以确保其作为完整的Windows服务运行,以及如何通过IronPDF轻松管理创建PDF的复杂过程。 对于需要自动化文档创建或修改的应用程序,结合Topshelf和IronPDF在C#中的功能使此集成更加完美。 它提供了可靠性和易维护性。 ## 结论 总之,在C#中结合Topshelf和IronPDF的功能使得创建和管理涉及PDF产生和操作的Windows服务变得可能。 Topshelf通过提供用于服务配置和管理的用户友好型API,简化了Windows服务的部署。 通过在服务逻辑中轻松生成来自HTML信息的PDF文档,IronPDF增强了功能。 这种集成保证在自动化文档工作流程中实现可靠和强大的性能,并简化了开发过程。 Topshelf结合C#中的IronPDF脱颖而出,作为一个灵活且有效的选择,使得开发人员可以轻松创建复杂的文档处理解决方案,无论是用于生成报告、发票还是任何其他基于PDF的任务。 IronPDF和[Iron Software Licensing Information](/licensing/)结合了来自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,编写一个具有StartStop方法的服务类,使用Topshelf的API配置服务,然后构建项目。最后,使用命令行命令安装并启动服务。

Topshelf用于服务管理的关键特性是什么?

Topshelf提供易用性、配置灵活性、日志记录、强大的异常处理、多服务实例支持以及与常见Windows服务控制的兼容性,使其成为.NET开发人员的多功能工具。

如何通过Windows服务实现自动化文档工作流?

通过将Topshelf与IronPDF集成,可以创建处理PDF生成、修改和分发等任务的Windows服务,从而在服务框架内实现自动化文档工作流。

IronPDF有哪些许可选项?

IronPDF提供了灵活的许可选项,以满足不同项目的需要,使开发人员能够根据其特定需求高效地将PDF功能集成到其应用程序中。

Curtis Chau
技术作家

Curtis Chau 拥有卡尔顿大学的计算机科学学士学位,专注于前端开发,精通 Node.js、TypeScript、JavaScript 和 React。他热衷于打造直观且美观的用户界面,喜欢使用现代框架并创建结构良好、视觉吸引力强的手册。

除了开发之外,Curtis 对物联网 (IoT) 有浓厚的兴趣,探索将硬件和软件集成的新方法。在空闲时间,他喜欢玩游戏和构建 Discord 机器人,将他对技术的热爱与创造力相结合。