理解WinSW及其配置机制
winsw（windows service wrapper）是一个开源工具，旨在帮助开发者将任何可执行文件（如jar文件通过java运行时）或脚本封装成windows服务。它通过一个xml或yml配置文件来定义服务的行为，包括启动命令、停止命令、日志路径、依赖项等。
在安装WinSW服务时，通常会使用命令 winsw install [配置文件名]。然而，用户在尝试使用 Winsw.exe install myapp.xml 命令时，常会遇到以下错误：
> 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)
这个错误表明WinSW无法在其可执行文件所在的目录中找到名为 Winsw.xml 或 Winsw.yml 的配置文件。即使在命令中指定了 myapp.xml，WinSW的默认行为仍然是查找与其自身可执行文件同名的配置文件。
WinSW配置文件的查找规则： WinSW在加载配置时遵循一个关键原则：它会查找与其可执行文件（.exe）具有相同基本名称且位于同一目录下的配置文件。例如：
- 如果可执行文件是 WinSW.exe，它会查找 WinSW.xml 或 WinSW.yml。
- 如果可执行文件是 MyService.exe，它会查找 MyService.xml 或 MyService.yml。
这意味着，即使您在 install 命令中指定了不同的XML文件名，WinSW仍然会优先查找与其自身可执行文件同名的配置文件。
解决方案：单服务部署
对于单个服务的部署，最直接的解决方案是确保WinSW可执行文件和其配置文件具有相同的基本名称，并放置在同一目录中。
步骤：
- 将下载的 WinSW.exe 和您的服务配置文件（例如 myapp.xml）放置在同一目录。
- 将服务配置文件重命名，使其与 WinSW.exe 具有相同的基本名称。例如，如果您的可执行文件是 WinSW.exe，则将配置文件重命名为 WinSW.xml。
- 打开命令行，导航到该目录，然后执行安装命令：
WinSW.exe install
或者，如果您的WinSW版本支持，可以直接使用：
WinSW.exe install WinSW.xml
但更推荐的做法是遵循同名约定，直接使用 WinSW.exe install。
解决方案：多服务部署策略
当您希望使用同一个WinSW二进制文件来启动多个独立的Windows服务时，上述的同名约定似乎会成为障碍。然而，WinSW的设计巧妙地解决了这个问题：您可以通过重命名 WinSW.exe 可执行文件本身来为每个服务实例创建独立的配置。
多服务部署步骤：
假设您有 ServiceA 和 ServiceB 两个服务需要部署。
准备WinSW可执行文件： 下载 WinSW.exe 文件。
-
创建服务配置文件： 为每个服务创建独立的XML配置文件。例如：
- ServiceA.xml：用于配置 ServiceA 的启动命令、日志等。
- ServiceB.xml：用于配置 ServiceB 的启动命令、日志等。
示例 ServiceA.xml 配置：
<service> <id>MyServiceA</id> <name>My Java Service A</name> <description>This is my Java Service A running a JAR file.</description> <executable>java</executable> <arguments>-Xmx256m -jar "C:\path\to\your\ServiceA.jar"</arguments> <log mode="roll-by-size"> <sizeThreshold>10240</sizeThreshold> <keepFiles>8</keepFiles> </log> <onfailure action="restart" delay="60 sec"/> <onfailure action="restart" delay="120 sec"/> </service> -
为每个服务重命名WinSW可执行文件： 这是关键一步。将 WinSW.exe 复制并重命名为每个服务实例的名称。
- 将 WinSW.exe 复制一份，并重命名为 ServiceA.exe。
- 将 WinSW.exe 复制一份，并重命名为 ServiceB.exe。
-
组织文件结构： 将每个重命名后的WinSW可执行文件与其对应的配置文件放置在同一个目录中。建议为每个服务创建一个独立的目录，以保持清晰。
例如：
C:\Services\ ├── ServiceA\ │ ├── ServiceA.exe (重命名后的WinSW.exe) │ ├── ServiceA.xml (ServiceA的配置文件) │ └── ServiceA.jar (ServiceA的JAR文件) └── ServiceB\ ├── ServiceB.exe (重命名后的WinSW.exe) ├── ServiceB.xml (ServiceB的配置文件) └── ServiceB.jar (ServiceB的JAR文件) -
安装服务： 打开命令行，导航到每个服务的目录，然后使用重命名后的可执行文件安装服务。
# 安装 ServiceA cd C:\Services\ServiceA ServiceA.exe install # 安装 ServiceB cd C:\Services\ServiceB ServiceB.exe install
安装成功后，您可以在Windows服务管理器中看到 My Java Service A 和 My Java Service B 两个服务。
注意事项与最佳实践
- 路径配置： 在XML配置文件中，executable 和 arguments 中的路径应使用绝对路径，或者相对于服务运行目录的相对路径。
-
日志管理： 合理配置
标签，确保服务日志能够被有效记录和轮转，便于故障排查。 -
依赖项： 如果您的服务依赖于其他Windows服务，可以在XML配置中使用
标签指定。 - 权限： 确保运行WinSW安装命令的用户具有足够的权限来安装和管理Windows服务。
- 卸载服务： 使用相应的重命名可执行文件来卸载服务，例如 ServiceA.exe uninstall。
- 版本兼容性： 始终参考您使用的WinSW版本的官方文档，以了解最新的功能和最佳实践。
通过遵循上述策略，您可以有效地解决WinSW配置文件定位问题，并灵活地部署和管理多个独立的Windows服务，充分利用WinSW的强大功能。
