dotnet-win32-service 项目使用指南

1. 项目介绍

dotnet-win32-service 是一个用于将 .NET Core 应用程序作为 Windows 服务运行的开源项目。该项目通过 P/Invoke 调用 Windows 原生 API，使得开发者可以在不依赖完整 .NET Framework 的情况下，将 .NET Core 应用程序作为 Windows 服务运行。

该项目的主要特点包括：

• 无需完整 .NET Framework：可以在 Windows Nano Server 等环境中运行。
• 支持 Windows 服务：可以直接将 .NET Core 应用程序注册为 Windows 服务。
• 跨平台：虽然主要针对 Windows 服务，但代码本身是跨平台的，可以在 Linux 上作为守护进程运行。

2. 项目快速启动

2.1 环境准备

• .NET Core SDK 2.0.3 或更高版本
• Windows 操作系统
• 管理员权限的命令提示符

2.2 安装项目

首先，克隆项目到本地：

git clone https://github.com/dasMulli/dotnet-win32-service.git

2.3 运行示例服务

进入示例服务的目录：

cd dotnet-win32-service/samples/TestService

还原依赖包：

dotnet restore

注册并启动服务：

dotnet run --register-service --urls http://*:5080

成功注册并启动服务后，打开浏览器访问 http://localhost:5080，你应该会看到 "Hello world"。

2.4 代码示例

以下是一个简单的示例代码，展示了如何使用 dotnet-win32-service 创建一个 Windows 服务：

using DasMulli.Win32.ServiceUtils;

class Program
{
    public static void Main(string[] args)
    {
        var myService = new MyService();
        var serviceHost = new Win32ServiceHost(myService);
        serviceHost.Run();
    }
}

class MyService : IWin32Service
{
    public string ServiceName => "Test Service";

    public void Start(string[] startupArguments, ServiceStoppedCallback serviceStoppedCallback)
    {
        // 启动服务逻辑
    }

    public void Stop()
    {
        // 停止服务逻辑
    }
}

3. 应用案例和最佳实践

3.1 应用案例

• Windows Nano Server：在 Windows Nano Server 上运行 .NET Core 应用程序作为服务。
• 跨平台服务：开发一个可以在 Windows 上作为服务运行，在 Linux 上作为守护进程运行的应用程序。

3.2 最佳实践

• 错误处理：在服务中添加适当的错误处理逻辑，以确保服务在遇到问题时能够优雅地停止。
• 日志记录：使用日志记录库（如 Microsoft.Extensions.Logging）记录服务的关键操作和错误信息。
• 服务配置：使用配置文件或环境变量来管理服务的配置，避免硬编码。

4. 典型生态项目

4.1 ASP.NET Core

dotnet-win32-service 可以与 ASP.NET Core 结合使用，将 ASP.NET Core 应用程序作为 Windows 服务运行。这使得开发者可以在 Windows 环境中部署和运行 ASP.NET Core 应用程序，而无需依赖 IIS。

4.2 BackgroundService

BackgroundService 是 .NET 中用于运行后台任务的基类。结合 dotnet-win32-service，可以将 BackgroundService 实现的服务注册为 Windows 服务，从而在后台持续运行任务。

4.3 其他相关项目

• Topshelf：另一个流行的 .NET 服务框架，支持将 .NET 应用程序作为服务运行。
• NSSM (Non-Sucking Service Manager)：一个用于将应用程序包装为 Windows 服务的工具，支持多种编程语言。

通过这些生态项目，开发者可以构建更加复杂和强大的 Windows 服务应用程序。