WinSW Windows服务部署指南：理解与解决配置文件命名约定

理解WinSW的配置文件定位机制

winsw（windows service wrapper）是一个强大的工具，用于将任何可执行文件（如java的jar包、node.js应用等）封装成windows服务。然而，在初次使用或部署多个服务时，用户常会遇到system.io.filenotfoundexception: unable to locate winsw.[xml|yml] file within executable directory错误。这个错误的核心原因在于winsw在执行install命令时，其配置文件（通常是xml或yml格式）的查找机制。

WinSW的默认行为是，当您运行WinSW.exe时，它会在同一目录下查找名为WinSW.xml或WinSW.yml的配置文件。如果将WinSW.exe重命名为MyService.exe，那么它将自动查找MyService.xml或MyService.yml。这意味着，install命令本身并不接受一个独立的配置文件路径作为参数，而是隐式地依赖于可执行文件的名称来确定配置文件的名称。

例如，如果您有一个WinSW.exe和一个名为myapp.xml的配置文件，并尝试执行以下命令：

WinSW.exe install myapp.xml

此时，WinSW会忽略myapp.xml这个参数，转而在当前目录下寻找WinSW.xml。由于WinSW.xml不存在，便会抛出FileNotFoundException错误：

> Winsw.exe install myapp.xml
2022-11-15 12:24:46,791 FATAL - Unhandled exception
System.IO.FileNotFoundException: Unable to locate Winsw.[xml|yml] file within executable directory
   at WinSW.Program.LoadConfigAndInitLoggers(Boolean inConsoleMode)
   at WinSW.Program.Run(String[] argsArray, IServiceConfig config)
   at WinSW.Program.Main(String[] args)

解决配置文件未找到错误：基础方法

要解决上述FileNotFoundException错误，关键在于遵循WinSW的命名约定：WinSW可执行文件与对应的配置文件必须同名，并置于同一目录下。

例如，如果您希望将一个JAR文件my-application.jar作为Windows服务运行，并使用my-application.xml作为其配置文件，正确的做法是：

1. 重命名WinSW可执行文件： 将下载的WinSW.exe（或WinSW.NET4.exe等）重命名为my-application.exe。
2. 确保配置文件同名： 将您的服务配置文件命名为my-application.xml。
3. 放置在同一目录： 将my-application.exe、my-application.xml和my-application.jar（或其他待运行程序）放置在同一个目录下。

完成上述步骤后，您就可以使用重命名后的可执行文件来安装服务了：

# 进入存放文件的目录
cd C:\Services\MyApplication

# 安装服务
my-application.exe install

# 启动服务
my-application.exe start

# 停止服务
my-application.exe stop

# 卸载服务
my-application.exe uninstall

通过这种方式，my-application.exe在执行install命令时，会自动查找并加载my-application.xml作为其配置，从而避免FileNotFoundException。

WinSW多服务部署策略

用户通常希望使用一个WinSW.exe实例来管理多个不同的Windows服务，以避免复制多个WinSW.exe文件。然而，鉴于WinSW的配置文件定位机制，使用单一WinSW.exe的名称来直接安装多个具有不同配置的服务（例如，WinSW.exe install service1.xml，然后WinSW.exe install service2.xml）是不被支持的。每次WinSW.exe执行install命令时，它都只会查找名为WinSW.xml的文件。

燕雀Logo

为用户提供LOGO免费设计在线生成服务

101

查看详情

因此，管理多个WinSW服务的推荐策略是：为每个服务复制并重命名WinSW可执行文件及其对应的XML配置文件。

推荐策略：为每个服务复制并重命名WinSW可执行文件

这种方法虽然意味着会有多个WinSW.exe的副本，但每个副本都被重命名以匹配其特定服务的配置文件，从而实现了清晰、独立的管理。

部署步骤：

1. 创建服务专用目录： 为每个Windows服务创建一个独立的目录。 例如：
   • C:\Services\ServiceA\
   • C:\Services\ServiceB\
2. 复制WinSW可执行文件： 将原始的WinSW.exe文件复制到每个服务目录中。
3. 重命名WinSW可执行文件： 在每个服务目录中，将复制的WinSW.exe重命名为与服务相关的名称。 例如：
   • 在C:\Services\ServiceA\中，将WinSW.exe重命名为ServiceA.exe。
   • 在C:\Services\ServiceB\中，将WinSW.exe重命名为ServiceB.exe。
4. 创建对应的配置文件： 在每个服务目录中，创建与重命名后的可执行文件同名的XML配置文件。 例如：
   • 在C:\Services\ServiceA\中，创建ServiceA.xml。
   • 在C:\Services\ServiceB\中，创建ServiceB.xml。
5. 放置服务程序： 将每个服务的实际可执行文件（如JAR包）放置在其对应的服务目录中。 例如：
   • 在C:\Services\ServiceA\中，放置service-a.jar。
   • 在C:\Services\ServiceB\中，放置service-b.jar。
6. 配置XML文件： 根据每个服务的具体需求编辑其XML配置文件。

目录结构示例：

C:\Services\
├── ServiceA\
│   ├── ServiceA.exe
│   ├── ServiceA.xml
│   └── service-a.jar
└── ServiceB\
    ├── ServiceB.exe
    ├── ServiceB.xml
    └── service-b.jar

安装和管理多个服务示例：

# 安装 ServiceA
cd C:\Services\ServiceA
ServiceA.exe install
ServiceA.exe start

# 安装 ServiceB
cd C:\Services\ServiceB
ServiceB.exe install
ServiceB.exe start

# 停止和卸载 ServiceA
cd C:\Services\ServiceA
ServiceA.exe stop
ServiceA.exe uninstall

通过这种策略，每个服务都拥有独立的WinSW可执行文件和配置文件，从而实现了完全隔离和独立的管理，避免了命名冲突和配置文件定位问题。

注意事项与最佳实践

• 配置文件内容： 确保每个服务的XML配置文件正确指向其对应的可执行文件（如JAR包路径），并配置好服务名称、显示名称、描述、日志路径、启动参数、JVM选项等。
• 日志配置： 在XML配置文件中，务必配置好日志输出路径。每个服务应有独立的日志文件，便于问题排查。
• 权限问题： 确保运行WinSW命令的用户具有足够的权限来安装、启动、停止和卸载Windows服务，以及读写服务目录下的文件。通常需要以管理员身份运行命令提示符或PowerShell。
• 服务名称唯一性： 在ServiceX.xml文件中定义的服务名称（<id>标签）在整个Windows系统中必须是唯一的。
• 路径管理： 在配置文件中指定JAR包或其他可执行文件路径时，可以使用相对路径（相对于ServiceX.exe的路径）或绝对路径。推荐使用相对路径，以提高部署的灵活性。
• 升级WinSW： 当需要升级WinSW版本时，只需替换每个服务目录中的ServiceX.exe文件即可。

总结

WinSW在部署Windows服务时，其配置文件定位机制要求可执行文件与配置文件同名并位于同一目录。install命令不接受外部配置文件路径作为参数。因此，为了解决FileNotFoundException并实现多服务管理，最可靠和推荐的方法是为每个服务复制一份WinSW可执行文件，并将其重命名以匹配该服务的配置文件。这种策略确保了每个服务都拥有独立的配置和管理入口，从而实现清晰、高效的Windows服务部署。遵循这些指南，您将能够更顺畅地利用WinSW来管理您的应用程序。

以上就是WinSW Windows服务部署指南：理解与解决配置文件命名约定的详细内容，更多请关注php中文网其它相关文章！