
WinSW简介与常见问题
winsw(windows service wrapper)是一个开源工具,旨在帮助用户将任何可执行文件(如jar文件、批处理脚本等)包装成windows服务运行。它通过一个xml或yaml配置文件来定义服务的行为、启动命令、日志设置等。
然而,在初次使用WinSW安装服务时,许多用户会遇到一个常见的错误:
> 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无法找到其预期的配置文件,即使在安装命令中明确指定了myapp.xml。问题的根源在于WinSW的特定配置查找逻辑。
错误原因分析
WinSW的设计哲学是,每个服务实例都由一对文件定义:一个WinSW可执行文件和一个同名的配置文件。当您运行Winsw.exe install命令时,WinSW并不会尝试解析您提供的myapp.xml作为要加载的配置路径。相反,它会默认在自身所在的目录下查找一个与自身文件名相同的XML或YAML文件。
例如,如果您的可执行文件是WinSW.exe,它会尝试查找WinSW.xml或WinSW.yml。如果您将其命名为myapp.xml,即使在同一目录下,WinSW也无法找到它,从而抛出FileNotFoundException。
解决方案
解决此问题的核心在于遵循WinSW的命名约定:WinSW可执行文件和其对应的配置文件必须具有相同的基本名称,并位于同一目录下。
-
重命名配置文件: 将您的XML配置文件重命名,使其与WinSW的可执行文件同名。
- 如果您的WinSW可执行文件是 WinSW.exe,那么配置文件应命名为 WinSW.xml。
- 如果您的WinSW可执行文件是 MyService.exe,那么配置文件应命名为 MyService.xml。
放置在同一目录: 确保重命名后的配置文件与WinSW可执行文件位于同一个目录下。
示例:
假设您有一个名为 my-application.jar 的Java应用,并希望将其作为服务运行。
下载WinSW: 从WinSW的GitHub发布页面下载最新的 WinSW.exe 文件。
创建服务目录: 创建一个专门的目录来存放您的服务文件,例如 C:\Services\MyApplicationService。
ECTouch移动商城系统下载ECTouch是上海商创网络科技有限公司推出的一套基于 PHP 和 MySQL 数据库构建的开源且易于使用的移动商城网店系统!应用于各种服务器平台的高效、快速和易于管理的网店解决方案,采用稳定的MVC框架开发,完美对接ecshop系统与模板堂众多模板,为中小企业提供最佳的移动电商解决方案。ECTouch程序源代码完全无加密。安装时只需将已集成的文件夹放进指定位置,通过浏览器访问一键安装,无需对已有
放置文件: 将 my-application.jar 和下载的 WinSW.exe 放入此目录。
-
创建配置文件: 创建一个XML配置文件,例如 service-config.xml,内容如下:
MyApplicationService My Application Service This is my sample Java application service. java -Xmx512m -jar "my-application.jar" %BASE%\logs 10240 8 -
重命名WinSW可执行文件和配置文件:
- 将 WinSW.exe 重命名为 MyApplicationService.exe。
- 将 service-config.xml 重命名为 MyApplicationService.xml。
现在,您的 C:\Services\MyApplicationService 目录结构应如下:
C:\Services\MyApplicationService\ ├── my-application.jar ├── MyApplicationService.exe └── MyApplicationService.xml
-
安装服务: 打开管理员权限的命令提示符或PowerShell,导航到服务目录,然后执行安装命令:
cd C:\Services\MyApplicationService MyApplicationService.exe install
此时,服务将成功安装。
部署多个服务
原始问题中提到,用户希望使用同一个 .exe 文件启动多个服务。根据WinSW的命名约定,这无法直接实现。每个独立的Windows服务都需要其自己的一套 WinSW 可执行文件和同名配置文件。
如果您需要部署多个不同的服务,您应该为每个服务重复上述步骤:
- 为每个服务创建一个独立的目录。
- 将 WinSW.exe 复制到每个服务目录中。
- 根据服务名称重命名 WinSW.exe(例如 ServiceA.exe, ServiceB.exe)。
- 为每个服务创建并重命名相应的XML配置文件(例如 ServiceA.xml, ServiceB.xml),确保它们与各自的 .exe 文件同名。
- 在每个服务目录中,使用对应的 .exe 文件执行 install 命令。
注意事项与最佳实践
- 管理员权限: 安装、卸载或管理Windows服务通常需要管理员权限。请确保在执行WinSW命令时使用管理员权限的命令提示符或PowerShell。
- 日志路径: 在XML配置文件中,logpath 元素通常使用 %BASE% 变量,它代表WinSW可执行文件所在的目录。这有助于保持日志文件的组织性。
- 服务ID与名称: id 元素是服务的唯一标识符,name 是在服务管理器中显示的用户友好名称。确保它们是唯一的。
- 官方文档: 遇到问题时,查阅WinSW的官方GitHub文档是获取最新和最准确信息的最可靠途径。
通过遵循这些指导原则,您可以有效避免WinSW服务安装中的FileNotFoundException错误,并成功地将您的应用程序部署为可靠的Windows服务。









