起因
哈哈首先,先说明一下,真实问题肯定要比标题要复杂一些,我以node应用程序作为一个栗子去做演示,原理是一样的。
那么废话不多说,我们先来看看如何去实现标题的需求呢。
你看到这个标题是不是脑海中会浮现docker、pm2、eggjs工程自带开机自启等等。我今天分享的是另一个我觉得挺有意思的开源工具——WinSW。
什么是WinSW?
WinSW 是一个开源工具,可以将任何可执行文件包装成 Windows 服务。它支持多种配置选项,使得管理服务变得非常灵活和方便。
看这里——任何可执行文件,那也就是说,bat,exe等等都是符合的。
准备工作
在开始之前,请确保你已经安装了以下软件:
1. Node.js 和 npm(Node 包管理器)
2. WinSW 工具
你可WinSW 的 GitHub 页面 下载最新版本的 WinSW。
地址:
https://github.com/winsw/winsw/releases
将下载好的WinSW.exe更改你所想要的服务名,如node-demo-service.exe。
配置 WinSW
首先,我们需要创建一个 XML 配置文件,用于定义服务的各项属性。以下是一个示例配置文件 `node-demo-service.xml`(和exe保持同名):
<service>
<!-- 服务ID。它应该在整个Windows系统中是唯一的-->
<id>node-demo-service</id>
<!-- 在系统服务中显示的名称 -->
<name>node-demo-service</name>
<!-- 服务描述 -->
<description>node express demo 服务</description>
<!-- 启动可执行文件的路径 -->
<executable>D:\Adam\installPath\nvm\v20.12.2\node.exe</executable>
<!-- Node.js应用程序的路径 -->
<arguments>D:\Adam\project\my-project\node-serve\app.js</arguments>
<!-- 日志路径(如不配置,日志文件默认在可执行文件的路径),注意:要注释,不能保留空标签,启动会报错 -->
<!-- <logpath></logpath> -->
<!-- 日志模式 -->
<logmode="roll-by-size">
<sizeThreshold>10240</sizeThreshold>
<keepFiles>8</keepFiles>
</logmode>
</service>
注册服务
1. 将下载的 WinSW 可执行文件重命名为 `node-demo-service.exe`,并将其放置在与 `node-demo-service.xml` 相同的目录下。
2. 打开命令提示符(以管理员身份运行),切换到包含 `node-demo-service.exe` 和 `node-demo-service.xml` 的目录。
3. 运行以下命令注册服务:
node-demo-service.exe install
// 补充,删除服务命令
// node-demo-service.exe uninstall
如果一切顺利,你应该会看到类似以下的输出:
- Installing service 'node-demo-service (node-demo-service)'...
- Service 'node-demo-service (node-demo-service)' was installed successfully.
启动和管理服务
服务注册成功后,你可以在服务中去开启和停止服务:
设置开机自启
双击服务,选择自动即可。
运行效果
好了附一下node代码
// app.js
const express = require('express');
const app = express();
const port = 3000;
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(port, () => {
console.log(`Server is running at http://localhost:${port}`);
});
总结
通过使用 WinSW,我们可以轻松地将 Node.js 应用程序注册为 Windows 服务,从而实现自动启动和管理。这不仅提高了应用程序的可靠性,还简化了部署和维护过程。希望本文对你有所帮助,祝你在使用 WinSW 时一切顺利!