一个软件程序可能会用到其它的服务(service),例如网站应用程序会去使用到数据库服务。当这类软件程序运行的时候,如果它所使用到的外部服务还处于不可用的状态的话,那么这个软件程序就很有可能在运行的时候出现问题。

上述的状况很常发生在运行于 Docker 容器中的软件程序,即便 Docker Compose 本身有提供 depends_on 的功能,可以让一个容器在其它一个或多个容器被启动之后才被启动,但它并无法保证容器是在某个或是某些「服务」被启动之后才启动,因为启动容器并不表示容器中的服务也立刻完成启动进程了。

实际上已经有一个 wait-for-it 项目就是要来解决这样的问题,使用 Bash 来实现,还蛮多人用的。然而 wait-for-it 只支持 TCP 服务,且一次只能够等待一个服务,如果有多个服务要等待,就只能写好几个 wait-for-it 指令。此外,wait-for-it 也不能够直接读取外部的设置值,因为有可能在不同运行环境下我们要等待的服务的地址是不一样的,这就会让 wait-for-it 用起来挺绑手绑脚的。wait-for-it 也还需要有 Bash 环境才可以运行,在 Windows 操作系统上使用不易。

Wait Service

「Wait Service」是笔者用纯 Rust 编程语言制作的工具,可以测试并且等待服务的可用性,当这些服务全都处于可用的状态后,才去运行指定的指令。除了支持 TCP 服务之外,也支持 UDS (Unix Domain Socket)的服务,也可以透过设置文件来指定「Wait Service」要等待哪些服务。

GitHub:

使用 Wait Service

建议在您软件程序的运行环境上编译出「Wait Service」的可执行文件,以达到最轻量的结果。可以使用以下指令来编译并安装 wait-service 指令工具,当然还要有 Rust 编译环境才能运行。

cargo install wait-service

wait-service 指令工具的用法很简单。使用 wait-service -h 可以查看用法。

wait-service -h 显示的用法

下面以几个 wait-service 指令来进行说明:

wait-service --tcp localhost:27017 --tcp localhost:27018 -t 5 -- npm start

以上指令会等待(最多 5 秒)localhost:27017 和 localhost:27018 这两个 TCP 服务启动之后,才去运行 npm start 指令。

wait-service --tcp localhost:27017 --uds /var/run/app.sock -t 0 -- npm start

以上指令会等待(因为 -t 设为 0,所以无时间上限)localhost:27017 TCP 服务和 /var/run/app.sock UDS 服务启动之后,才去运行 npm start 指令。

wait-service --uds /var/run/app.sock --json /path/to/json -- npm start

以上指令会等待(最多 60 秒)/var/run/app.sock UDS 服务和被定义在 /path/to/json 这个设置档中的所有服务都启动之后,才去运行 npm start 指令。

Wait Service 的设置档

wait-service 指令的 --json 参数可以传入一个设置档的文件路径,设置档是 JSON 格式的纯文字文件,必须是一个 JSON 对象的数组。数组中的每个 JSON 对象表示一个要让 wait-service 测试并等待的服务。

对于一个 TCP 服务,JSON 对象的格式如下:

{
    "host": "example.com",
    "port": 443
}

对于一个 UDS 服务,JSON 对象的格式如下:

{
    "uds": "/path/to/socket_file"
}