TopShelf作为服务运行时无法传递命令行参数问题排查

直接用run命令启动程序时，命令行参数会被即时解析赋值；但作为Windows服务运行时，服务由系统服务管理器启动，不会自动携带你之前run时的参数。你的代码缺少参数持久化配置，导致服务启动时无法读取到所需参数，只能使用默认值。

方案1：配置参数持久化（用命令行参数） #

1. 修改代码添加持久化配置 #

在HostFactory.Run的配置块中加入x.PersistSettings()，让安装服务时传递的参数保存到Windows注册表，服务启动时自动读取：

static void Main(string[] args)
{
    var exitCode = HostFactory.Run(x =>
    {
        // 保留原有的参数绑定逻辑
        x.AddCommandLineDefinition("h", v => hostName = v); 
        x.AddCommandLineDefinition("p", v => port = Int32.Parse(v));                                                                             
        x.AddCommandLineDefinition("U", v => user = v);
        x.AddCommandLineDefinition("pwd", v => password = v);
        x.AddCommandLineDefinition("d", v => dbName = v);
        x.AddCommandLineDefinition("tbl", v => tableName = v);
        x.AddCommandLineDefinition("dbms", v => dbType = Int32.Parse(v));               

        // 添加参数持久化配置
        x.PersistSettings();
        // 可选：允许通过服务管理器手动修改启动参数（需重启服务生效）
        x.EnableCommandLineBypass();

        x.Service<DataReplicator>(r =>
        {
            r.ConstructUsing(replicate => new DataReplicator(hostName, dbName, user, password, port, tableName, dbType));
            r.WhenStarted(replicate => replicate.Start());
            r.WhenStopped(replicate => replicate.Stop());
        });

        x.RunAsLocalSystem();

        x.SetServiceName("TopShelfDataReplicator");
        x.SetDisplayName("TopShelf Data Replicator");
        x.SetDescription("Replicate the local data to the network");
        x.StartAutomatically();
    });

    int exitValue = (int)Convert.ChangeType(exitCode, exitCode.GetTypeCode());
    Environment.ExitCode = exitValue;
}

2. 重新安装服务（带参数） #

先卸载旧服务：

DataReplicator.exe uninstall

再用带参数的命令重新安装：

DataReplicator.exe install -h:localhost -d:networkdatabase -U:root -pwd:testpwd -tbl:testtable -dbms:1 -p:3306

方案2：使用配置文件（更推荐） #

命令行参数不适合存储敏感信息（比如密码），用配置文件更安全易维护：

1. 添加App.config配置文件 #

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="hostName" value="localhost"/>
    <add key="port" value="3306"/>
    <add key="user" value="root"/>
    <add key="password" value="testpwd"/>
    <add key="dbName" value="networkdatabase"/>
    <add key="tableName" value="testtable"/>
    <add key="dbType" value="1"/>
  </appSettings>
</configuration>

2. 修改代码读取配置 #

static void Main(string[] args)
{
    // 从配置文件读取参数
    var hostName = System.Configuration.ConfigurationManager.AppSettings["hostName"];
    var port = int.Parse(System.Configuration.ConfigurationManager.AppSettings["port"]);
    var user = System.Configuration.ConfigurationManager.AppSettings["user"];
    var password = System.Configuration.ConfigurationManager.AppSettings["password"];
    var dbName = System.Configuration.ConfigurationManager.AppSettings["dbName"];
    var tableName = System.Configuration.ConfigurationManager.AppSettings["tableName"];
    var dbType = int.Parse(System.Configuration.ConfigurationManager.AppSettings["dbType"]);

    var exitCode = HostFactory.Run(x =>
    {
        x.Service<DataReplicator>(r =>
        {
            r.ConstructUsing(replicate => new DataReplicator(hostName, dbName, user, password, port, tableName, dbType));
            r.WhenStarted(replicate => replicate.Start());
            r.WhenStopped(replicate => replicate.Stop());
        });

        x.RunAsLocalSystem();

        x.SetServiceName("TopShelfDataReplicator");
        x.SetDisplayName("TopShelf Data Replicator");
        x.SetDescription("Replicate the local data to the network");
        x.StartAutomatically();
    });

    int exitValue = (int)Convert.ChangeType(exitCode, exitCode.GetTypeCode());
    Environment.ExitCode = exitValue;
}

修改配置后重启服务即可生效，无需重新安装。

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