C#如何实现一个Windows服务?TopShelf框架创建C#后台服务教程

来源:这里教程网 时间:2026-02-21 17:31:43 作者:

用C#实现一个Windows服务,最简单高效的方式是使用TopShelf框架。它能将普通的控制台应用快速转换为可安装的Windows服务,无需处理复杂的ServiceBase类和注册表配置。开发阶段可以直接运行调试,部署时再安装为服务,极大提升开发效率。

1. 安装TopShelf NuGet包

创建一个C#控制台应用程序(.NET Framework 或 .NET Core/.NET 5+均可),然后通过NuGet安装TopShelf:

Install-Package Topshelf

如果你计划在.NET 6+中使用,建议选择支持跨平台的服务托管方案,但TopShelf依然适用于Windows环境下的传统部署。

2. 编写服务逻辑类

定义一个类来封装你的后台任务逻辑。这个类需要包含Start和Stop方法,由TopShelf调用。

示例代码:

public class MyService
{
    public bool Start()
    {
        // 启动服务时执行的逻辑
        Console.WriteLine("服务已启动...");
        // 可在此处启动定时任务、监听线程等
        return true;
    }

    public bool Stop()
    {
        // 停止服务前清理资源
        Console.WriteLine("服务正在停止...");
        return true;
    }
}

3. 配置并运行服务主机

在Program.cs的Main方法中使用TopShelf配置服务。

using Topshelf;

class Program
{
    static void Main(string[] args)
    {
        HostFactory.Run(configure =>
        {
            configure.Service(service =>
            {
                service.ConstructUsing(s => new MyService());
                service.WhenStarted(s => s.Start());
                service.WhenStopped(s => s.Stop());
            });

            // 设置服务基本信息
            configure.SetServiceName("MySampleService");
            configure.SetDisplayName("我的示例服务");
            configure.SetDescription("这是一个用TopShelf创建的后台服务示例。");

            // 以本地系统账户运行(也可设为其他账户)
            configure.RunAsLocalSystem();

            // 开启事件日志(可选)
            configure.EnableServiceRecovery(r => r.RestartService(1)); // 崩溃后重启
        });
    }
}

4. 安装与管理服务

编译生成exe文件后,通过命令行安装为Windows服务。

安装服务:以管理员身份运行命令提示符,执行
YourApp.exe install
启动服务YourApp.exe start 停止服务YourApp.exe stop 卸载服务YourApp.exe uninstall

你也可以添加-p或--prompt参数,在安装时提示输入运行账户信息。

例如:YourApp.exe install --prompt

基本上就这些。TopShelf让C#开发Windows服务变得像写控制台程序一样简单。你可以结合log4net记录日志,或者集成Quartz.NET做定时任务,轻松构建稳定可靠的后台服务。

相关推荐

热文推荐