.NET基于BackgroundService的Windows服务如何获取启动参数

一、代码侧实现逻辑 #

基于BackgroundService的Windows服务本身依托.NET泛型主机运行，启动参数会被主机配置系统默认捕获，不需要额外做底层拦截，按以下步骤配置即可：

• 首先确保程序入口将命令行参数完整传入主机构建流程，这是90%的人拿不到参数的核心漏项：
  如果你用.NET 6+的顶级语句模板（对应官方教程的默认写法），代码如下：

  // 必须将程序入口的args参数传入CreateDefaultBuilder，不能传空值
  var builder = Host.CreateDefaultBuilder(args)
      .UseWindowsService() // 启用Windows服务托管支持
      .ConfigureServices((hostContext, services) =>
      {
          services.AddHostedService<YourCustomBackgroundService>();
      });
  
  await builder.Build().RunAsync();
  

  如果你用传统的带显式Main入口的写法，确保不要把args参数丢弃：

  public static void Main(string[] args)
  {
      // 错误写法：传空数组会导致所有启动参数丢失
      // CreateHostBuilder(Array.Empty<string>()).Build().Run();
      
      // 正确写法：透传入口接收的args
      CreateHostBuilder(args).Build().Run();
  }
  
  public static IHostBuilder CreateHostBuilder(string[] args) =>
      Host.CreateDefaultBuilder(args)
          .UseWindowsService()
          .ConfigureServices((hostContext, services) =>
          {
              services.AddHostedService<YourCustomBackgroundService>();
          });
  

  CreateDefaultBuilder默认已经集成了命令行参数配置源，不需要你额外手动添加AddCommandLine配置，除非你自定义了配置源顺序。
• 在你的BackgroundService实现类中，通过构造函数注入IConfiguration即可读取参数，和读取普通配置项的逻辑完全一致：

  public class YourCustomBackgroundService : BackgroundService
  {
      private readonly IConfiguration _appConfig;
      public YourCustomBackgroundService(IConfiguration appConfig)
      {
          _appConfig = appConfig;
      }
  
      protected override async Task ExecuteAsync(CancellationToken stopToken)
      {
          // 例：传入的启动参数为 --servicePort 18080 --deployEnv production
          // 直接按键名取值即可
          var servicePort = _appConfig["servicePort"];
          var deployEnv = _appConfig["deployEnv"];
  
          // 如果需要获取原始未映射的参数列表，可通过配置节点读取
          var rawArgs = _appConfig.GetSection("hostConfiguration:commandLineArgs").Get<string[]>();
          
          // 你的服务业务逻辑
          while (!stopToken.IsCancellationRequested)
          {
              await Task.Delay(1000, stopToken);
          }
      }
  }
  

• 注意不要使用Environment.GetCommandLineArgs()获取自定义启动参数，该方法在Windows服务托管场景下会混入服务宿主的内置启动参数，会导致自定义参数解析错乱。

二、Windows服务侧传参配置注意事项 #

代码配置完成后，需要按正确方式给服务传入参数，否则参数不会被进程接收到：

• 安装服务时直接指定参数：使用sc create命令创建服务时，在binPath的可执行文件路径后拼接参数，注意可执行文件路径本身必须用双引号包裹：

  sc create YourServiceName binPath= "\"C:\app\your-service.exe\" --servicePort 18080 --deployEnv production" start= auto
  

• 已安装的服务追加/修改参数：不要直接在服务控制面板的属性页修改可执行路径，系统会自动重置这类修改。正确做法是打开注册表，定位到HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\你的服务名节点，编辑ImagePath字符串值，在原有exe路径的末尾加空格后拼接自定义启动参数，保存后重启服务即可生效。
• 排查问题时可以先在命令行直接启动exe、拼接测试参数，确认代码侧能正常读取参数后再部署为服务，能快速定位是代码问题还是服务配置问题。

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