1. IronPDF
  2. IronPDF博客
  3. .NET 帮助
  4. Topshelf C#
.NET 帮助

Topshelf C#（它是如何为开发者工作的）

发布 2024年八月13日
分享:

介绍

一个名为顶层架构创建 "Windows 服务 "的目的是使在 .NET 中创建 Windows 服务变得更容易。 它提供的框架简化了创建、部署和管理的过程，并使之合理化。Windows 服务此外，译文还必须保证，开发人员可以专注于业务逻辑，而不是复杂的服务控制管理。 IronPDF 是一个功能丰富的 C# 库，用于创建和修改 PDF 文件，开发人员可以将其与 IronPDF 结合使用，构建可靠、强大的服务，管理错综复杂的文档处理工作。

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

什么是 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&num；

使用 C# 中的 Topshelf 来创建和配置 Windows 服务，具体步骤如下：

创建一个新的Visual Studio项目

使用Visual Studio创建控制台项目非常简单。 要在 Visual Studio 环境中启动控制台应用程序，请按照以下简单步骤操作：

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

开始一个新项目

选择文件、项目后，选择新建菜单。

Topshelf C#（它如何为开发人员工作）：图2

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

要为您的项目命名，请填写 "名称 "字段。

Topshelf C#（适用于开发人员的工作方式）：图3

选择项目的存储位置。

点击 "创建 "后，将打开控制台应用程序项目。

Topshelf C#（适用于开发人员的工作原理）：图 4

通过 NuGet 安装 Topshelf

使用 NuGet 软件包管理器，将 Topshelf 添加到您的项目中。 在软件包管理器和控制台应用程序中，执行以下命令：

Install-Package Topshelf
Install-Package Topshelf
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

创建服务类

描述类的服务逻辑。 除其他服务操作外，启动和停止也应在该类中实现。

using System;
using Topshelf;
namespace MyWindowsService
{
    public class MyService
    {
        public bool Start()
        {
            // Write start logic here
            Console.WriteLine("Service Started.");
            return true;
        }
        public bool Stop()
        {
            // Write stop logic here
            Console.WriteLine("Service Stopped.");
            return true;
        }
    }
    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                x.Service<MyService>(s =>
                {
                    s.ConstructUsing(name => new MyService());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });
                x.RunAsLocalSystem();
                x.SetServiceName("MyService");
                x.SetDisplayName("My Service");
                x.SetDescription("This is a sample service created using Topshelf.");
            });
        }
    }
}
using System;
using Topshelf;
namespace MyWindowsService
{
    public class MyService
    {
        public bool Start()
        {
            // Write start logic here
            Console.WriteLine("Service Started.");
            return true;
        }
        public bool Stop()
        {
            // Write stop logic here
            Console.WriteLine("Service Stopped.");
            return true;
        }
    }
    class Program
    {
        static void Main(string[] args)
        {
            HostFactory.Run(x =>
            {
                x.Service<MyService>(s =>
                {
                    s.ConstructUsing(name => new MyService());
                    s.WhenStarted(tc => tc.Start());
                    s.WhenStopped(tc => tc.Stop());
                });
                x.RunAsLocalSystem();
                x.SetServiceName("MyService");
                x.SetDisplayName("My Service");
                x.SetDescription("This is a sample service created using Topshelf.");
            });
        }
    }
}
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

Topshelf C#（它对开发者的工作原理）：图5

配置服务

MyService 类中包含启动和终止服务的机制。 服务定义及其生命周期方法(开始和停止)在程序类中，Topshelf 配置与相应的服务操作相连。 服务的属性（如名称、显示名称和描述）是通过单个服务类的运行方法设置的。 通过这个简洁的配置，使用 Topshelf 管理和部署 Windows 服务变得非常简单。

构建和安装服务

在构建项目时，请确保无误。 使用 install 命令和编译后的可执行文件从命令行启动服务：

MyWindowsService.exe install
MyWindowsService.exe install
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

启动服务

安装服务后，使用以下命令启动服务：

MyWindowsService.exe start
MyWindowsService.exe start
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

卸载服务

如有必要，请使用以下命令提示符卸载服务：

MyWindowsService.exe uninstall
MyWindowsService.exe uninstall
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

此示例向您展示如何在 C# 中使用 Topshelf 创建和配置 Windows 服务。Topshelf 简化了这一过程，便于定义、安装、设置和管理 Windows 服务，而且几乎不需要编码。

开始

要开始使用 IronPdf 和 Topshelf 在 C# 中构建 Windows 服务，请执行以下操作：

什么是IronPDF？

IronPDF for .NET 库C# PDF 是一个功能丰富的 .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。 支持媒体查询和响应式设计，这两种是现代的网页标准。 对于使用HTML和CSS动态装饰PDF账单、报告和文档非常有用。

PDF编辑

现有的PDF可以添加文本、照片和其他内容。 从PDF文件中提取文本和图片。 将多个PDF合并为一个文件。将PDF文件分割成多个独立的文档。 包括水印、注释、页眉和页脚。

PDF 转换

将多种文件格式（包括 Word、Excel 和图片文件）转换为 PDF 格式。 将 PDF 转换为图像(PNG、JPEG 等。).

性能和可靠性

高性能和可靠性是在工业环境中所期望的设计特性。 轻松管理大型文档集。

安装 IronPDF

要获得在 .NET 项目中处理 PDF 所需的工具，请安装 IronPDF for .NET 软件包。

Install-Package IronPDF
Install-Package IronPDF
'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Install-Package IronPDF
VB   C#

使用 IronPdf 创建您的服务类

定义 IronPdf 创建和修改 PDF 文件的功能以及类的服务逻辑。

using System;
using IronPdf;
using Topshelf;
namespace PdfService
{
    public class MyPdfService
    {
        public bool Start()
        {
            Console.WriteLine("Service Starting...");
            GeneratePdf();
            return true;
        }
        public bool Stop()
        {
            Console.WriteLine("Service Stopping...");
            return true;
        }
        private void GeneratePdf()
        {
            var renderer = new HtmlToPdf();
            var pdf = renderer.RenderHtmlAsPdf("<h1>Hello, PDF!</h1>");
            pdf.SaveAs("GeneratedDocument.pdf");
            Console.WriteLine("PDF Generated.");
        }
    }
    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
{
    public class MyPdfService
    {
        public bool Start()
        {
            Console.WriteLine("Service Starting...");
            GeneratePdf();
            return true;
        }
        public bool Stop()
        {
            Console.WriteLine("Service Stopping...");
            return true;
        }
        private void GeneratePdf()
        {
            var renderer = new HtmlToPdf();
            var pdf = renderer.RenderHtmlAsPdf("<h1>Hello, PDF!</h1>");
            pdf.SaveAs("GeneratedDocument.pdf");
            Console.WriteLine("PDF Generated.");
        }
    }
    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.");
            });
        }
    }
}
IRON VB CONVERTER ERROR developers@ironsoftware.com
VB   C#

开发人员可以通过将 Topshelf 与 IronPDF in C# 结合使用，快速设计出用于 PDF 制作和操作的强大 Windows 服务。 Topshelf 提供流畅、用户友好的 API，使 Windows 服务的设置和管理变得更加容易。

Topshelf C#（开发人员的工作原理）：图7

MyPdfService 类实现了启动(开始)和结束(停止)在给出的示例中，"服务 "封装了服务逻辑。 在开始方法中使用 IronPdf 创建一个简单的使用 HTML 的 PDF 文档译自 HTML 文本。 演示了使用 IronPDF 的 HtmlToPdf 类将 HTML 呈现为 PDF 格式的能力，展示了如何将基本的 HTML 信息(例如 "

你好, PDF!

)转换为PDF文件("GeneratedDocument.pdf").

Topshelf C#（对开发人员的工作原理）：图8

该集成演示了 Topshelf 如何管理服务的生命周期以确保其作为完整的 Windows 服务运行，以及 IronPDF 如何管理轻松创建 PDF 这一具有挑战性的过程。 借助 Topshelf 和 IronPDF 在 C# 中的组合功能，该集成非常适合需要自动创建或修改文档的应用程序。 它提供了可靠性和易维护性。

结论

总之，通过 Topshelf 和 IronPDF 在 C# 中的结合，创建和管理需要创建和操作 PDF 的 Windows 服务成为可能。 通过为服务配置和管理提供用户友好的 API，Topshelf 简化了 Windows 服务的部署。 通过促进服务逻辑内的 HTML 信息顺利生成 PDF 文档，IronPDF 在此期间改善了功能。

这种集成可确保自动化文档工作流程中可靠而强大的性能，同时还能简化开发流程。 Topshelf with IronPDF in C# 作为一种灵活有效的选择脱颖而出，使开发人员能够轻松创建复杂的文档处理解决方案，无论是创建报告、发票还是其他任何基于 PDF 的任务。

IronPDF 和IronSoftware 许可证信息将 Iron Software 提供的无比灵活的系统和套件与其核心支持相结合，为开发人员提供更多的在线应用程序和功能，以及更有效的开发。

如果许可证选项明确且针对项目，开发人员就能更容易地确定哪种模式是最佳的。 这些优势使开发人员能够以清晰、有效和内聚集成的方式解决各种问题。

< 前一页
EasyNetQ .NET（开发人员的工作原理）
下一步 >
CSLA .NET（它对开发人员的工作原理）

报告问题

准备开始了吗？ 版本： 2024.11 刚刚发布

免费NuGet下载 总下载量: 11,436,010 查看许可证 >