EasyService: Windows 系统服务注册及管理工具

Devops · 2019-11-20

介绍

如果你的 Windows 程序需要在后台长期运行,而且你希望它在开机后用户登录之前就自动运行、且在用户注销之后也不停止,那么你需要将程序注册为一个系统服务。

然而,在 Windows 下编写一个可注册为系统服务的程序并不是一件简单的事情。首先,程序必须是二进制的可执行程序,这就排除了脚本语言和虚拟机语言;其次,程序必须按系统服务的格式编写,过程繁琐,编写示例可见:MS 官方文档

EasyService 是一个可以将常规程序注册为系统服务的工具,体积只有 25KB 。你可以按常规的方法编写程序,然后用 EasyService 注册为一个系统服务,这样你的程序就可以在开机后用户登录之前自动运行、且在用户注销之后也不会停止。

如果你需要在 Windows 系统下部署网站、API 或其他需要长期在后台运行的服务, EasyService 将是一个很有用的工具。

安装

下载 源码及程序,解压。右键单击 bin 目录下的 register-this-path.bat ,以管理员身份运行,将 bin 目录加入至系统路径中,也可以手动将此目录加入至系统路径。

重新打开 “我的电脑” ,在任意位置打开一个命令行窗口,输入 svc -v ,如果正常输出版本信息,则表明安装成功。

使用方法

(1) 编写、测试你的程序,EasyService 对程序仅有一个强制要求和一个建议:

其中建议要求是非强制性的,程序不满足此要求也可以。

典型的程序见 index.js (nodejs 版), main.py (python 版) 或 SampleWorker.cs (C# 版),这三个程序都是每隔 1 秒打印一行信息,键入回车后退出。

(2) 打开命令行窗口,输入 svc create hello-svc ,将创建一个样板工程 hello-svc 。

(3) 打开 hello-svc/svc.conf 文件,修改配置:

# Windows 系统服务名称、不能与系统中已有服务重名
ServiceName: my-service

# 需要运行的可执行程序及命令行参数
Worker: node index.js

# 程序运行的工作目录,请确保该目录已存在
WorkingDir: worker

# 输出目录,程序运行过程的输出将会写到这个目录下面,请确保该目录已存在
OutFileDir: outfiles

# 程序输出的编码,如果不确定,请设为空
WorkerEncoding: utf8

(4) 用管理员身份打开命令行窗口(Win10 系统下,需要在开始菜单中搜索 cmd 然后右键以管理员身份运行), cd 到 hello-svc 目录:

a. 运行 svc check 命令检查配置是否合法

b. 运行 svc test-worker 命令测试 Worker 程序是否能正常运行

若测试无误:

c. 运行 svc install 命令安装并启动系统服务,此时程序就已经开始在后台运行了

d. 运行 svc stop|start|restart|remove 停止、启动、重启或删除本系统服务

e. 运行 svc log 查看正在运行的服务程序的输出

注册多个服务

如果需要注册多个服务,可以用 svc create 创建多个目录,修改 svc.conf 中的服务名和程序名等内容,再在这些目录下打开命令行窗口执行 svc check|test-worker|install 等命令就可以了。需要注意的是:

注意事项

为保证服务的一致性,要求:

内部实现

EasyService 实质是将自己(svc.exe)注册为一个系统服务,此服务启动时,会读取 svc.conf 中的配置,创建一个子进程运行 Worker 中指定的程序及命令行参数,之后,监视该子进程,如果发现子进程停止运行,会重新启动一个子进程。而当此服务停止时,会向子进程的标准输入中写入数据 “exit” ,并等待子进程退出,如果等待时间超过 5 秒,则直接终止子进程。

EasyService 源码见 src

与 NSSM 的对比

Windows 下部署服务的同类型的工具还有 NSSM ,与 EasyService 相比, NSSM 主要优点有:

NSSM 主要缺点是界面和文档都是英文的,对新手也不见得更友好,另外在远程通过命令行编辑和管理服务稍微麻烦一些,需要记住它的命令的参数。

总体而言, EasyService 已实现了大部分服务程序需要的功能,主要优点有:

v1.0.1 版的新功能

典型用例

Appin 网站介绍了用 EasyService 部署 frp 内网穿透服务的方法,请看 这里