如何将控制台程序同时作为Microsoft.Extensions.Hosting服务与命令行工具？

原代码存在的核心问题 #

1. 用args.Length == 0区分运行模式不可靠——如果用户仅传入-v这类配置参数，会错误进入命令行分支，而非启动服务
2. 核心运行逻辑分散在Main和OnExecute中，容易出现重复
3. Verbose选项定义错误：bool类型的开关选项应该用CommandOptionType.NoValue，而非SingleValue

修正后的完整代码 #

using McMaster.Extensions.CommandLineUtils;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;

[Command(Name = "MyServiceApp")]
public class Program
{
    [Option("-v|--verbose", "启用详细日志输出", CommandOptionType.NoValue)]
    public bool Verbose { get; set; }

    [Option("--run-as-service", "以Windows服务模式运行", CommandOptionType.NoValue)]
    public bool RunAsService { get; set; }

    public static int Main(string[] args)
    {
        // 统一由CommandLineApplication处理所有参数，不再手动判断args长度
        return CommandLineApplication.Execute<Program>(args);
    }

    private readonly IHostBuilder _hostBuilder;

    // 通过构造注入获取HostBuilder，符合DI设计思想
    public Program(IHostBuilder hostBuilder)
    {
        _hostBuilder = hostBuilder;
    }

    public async Task<int> OnExecuteAsync(CommandLineApplication app, IConsole console)
    {
        // 根据Verbose选项配置日志级别
        var host = _hostBuilder
            .ConfigureLogging(logging =>
            {
                if (Verbose)
                {
                    logging.SetMinimumLevel(LogLevel.Debug);
                }
            })
            .Build();

        // 根据选项决定运行模式
        if (RunAsService)
        {
            console.WriteLine("以Windows服务模式启动...");
            await host.RunAsync();
        }
        else
        {
            console.WriteLine("以控制台模式启动...");
            // 复用Worker的核心业务逻辑，避免代码重复
            var worker = host.Services.GetRequiredService<Worker>();
            await worker.StartAsync(CancellationToken.None);
            try
            {
                console.WriteLine("按任意键退出...");
                Console.ReadKey();
            }
            finally
            {
                await worker.StopAsync(CancellationToken.None);
                await host.StopAsync();
            }
        }

        return 0;
    }

    // 抽离HostBuilder的基础配置，所有运行模式共享
    public static IHostBuilder CreateHostBuilder(string[] args)
    {
        return Host.CreateDefaultBuilder(args)
            .UseWindowsService() // 自动适配Windows服务环境
            .ConfigureServices((context, services) =>
            {
                // 注册核心业务逻辑的HostedService
                services.AddHostedService<Worker>();
                // 注册HostBuilder用于DI注入
                services.AddSingleton<IHostBuilder>(_ => CreateHostBuilder(args));
            });
    }
}

// 核心业务逻辑实现类，服务/控制台模式共用
public class Worker : BackgroundService
{
    private readonly ILogger<Worker> _logger;

    public Worker(ILogger<Worker> logger)
    {
        _logger = logger;
    }

    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        _logger.LogInformation("Worker 已启动");
        while (!stoppingToken.IsCancellationRequested)
        {
            _logger.LogInformation("Worker 正在运行... {Time}", DateTimeOffset.Now);
            await Task.Delay(10000, stoppingToken);
        }
        _logger.LogInformation("Worker 已停止");
    }
}

关键实现说明 #

1. 统一命令行入口：

   • Main仅负责启动CommandLineApplication，所有参数解析和逻辑调度交给OnExecuteAsync处理，彻底避免手动判断args长度的不可靠性
   • 通过明确的--run-as-service选项区分运行模式，用户可组合传入参数（如-v --run-as-service），同时启用详细日志并以服务运行

2. OnExecute的职责：

   • 作为命令行解析后的唯一执行入口，在这里完成选项判断、Host配置、模式切换逻辑
   • 利用DI注入IHostBuilder，提升代码的可测试性和扩展性

3. 避免逻辑重复：

   • 核心业务逻辑全部封装在Worker类中，服务模式和控制台模式直接复用这部分代码
   • CreateHostBuilder抽离了Host的基础配置，所有运行模式共享，消除重复代码

4. 选项定义修正：

   • bool类型的开关选项（如-v）使用CommandOptionType.NoValue，用户只需输入-v即可启用，无需额外传值

内容的提问来源于stack exchange，提问作者Rifat