把服务检查写成可重复执行的 Bash 脚本

从单条 curl 命令开始,学习变量、参数、条件、循环和退出状态,编写可重复执行的 Node.js 服务巡检脚本。

🎯 引言

部署 Node.js 服务后,我们通常会用 curl 检查接口是否正常。如果每次发布都要重新输入命令,既麻烦,也容易漏掉检查步骤。

Bash 脚本可以把这些命令保存在文件中,下次只需要运行脚本,就能重复执行相同的检查。本篇将以 /health 接口为例,学习变量、参数、条件判断、循环和退出状态,最终让脚本能够报告检查是否成功,并在服务尚未启动时重试。

运行前提:本机已启动一个监听 127.0.0.1:3000、并提供 GET /health 接口的 Node.js 服务;该接口正常时返回 HTTP 200。如果你的服务端口或路由不同,请替换示例地址。下文的输出均为示例,实际结果取决于服务是否运行。


🧱 从命令到脚本

平时在终端输入一条命令,Shell 就执行一条。Shell 脚本只是把多条命令写进一个文件,方便以后一起执行。我们使用 Bash 来执行脚本,文件通常以 .sh 结尾。

先用一条命令检查接口:

curl -i http://127.0.0.1:3000/health

-i 会把 HTTP 响应头也显示出来。如果服务正常,可以从输出中看到类似 HTTP/1.1 200 OK 的状态行。但脚本不需要展示完整响应,只需要知道状态码。

1. 用变量保存检查地址

check_url="http://127.0.0.1:3000/health"
echo "$check_url"

输出示例:

http://127.0.0.1:3000/health

check_url 是变量名,等号右边是保存的值。赋值时等号两侧不能有空格;使用变量时写成 $check_url。这样以后更换检查地址,只需修改一处。

2. 取得接口返回的状态码

curl -sS --max-time 3 -o /dev/null -w '%{http_code}' -- "$check_url"

接口正常时,可能输出:

200

这里各参数的作用是:-sS 不显示进度,但请求出错时仍显示错误;--max-time 3 最多等待 3 秒;-o /dev/null 不显示响应体;-w '%{http_code}' 只输出 HTTP 状态码;-- 表示后面不再解析命令选项。

如果希望在后续代码中判断状态码,就把命令输出保存起来:

http_status=$(curl -sS --max-time 3 -o /dev/null -w '%{http_code}' -- "$check_url")
echo "$http_status"

$(...) 会先执行括号里的命令,再把它的输出赋给 http_status。例如接口返回 200 时,变量中保存的就是 200。

3. 根据检查结果决定成功或失败

创建保存脚本的目录,并用 Vim 编辑文件:

mkdir -p "$HOME/linux-lab/bin"
vim "$HOME/linux-lab/bin/health-check.sh"

把下面的完整代码写入文件(也可下载示例:health-check.sh):

health-check.sh
#!/bin/bash

check_url=${1:-http://127.0.0.1:3000/health}

if http_status=$(curl -sS --max-time 3 -o /dev/null -w '%{http_code}' -- "$check_url") &&
    [[ "$http_status" == 200 ]]; then
    printf 'OK %s\n' "$check_url"
    exit 0
fi

printf 'FAILED %s\n' "$check_url" >&2
exit 1

这段脚本按顺序完成三件事:

  1. 确定地址:${1:-默认地址} 表示优先使用运行脚本时传入的第一个参数 $1;没有传入或传入空值时,使用默认 /health 地址。
  2. 检查接口:if 判断两个条件是否都成立:curl 命令执行成功,并且 [[ "$http_status" == 200 ]]。中间的 && 表示“前一个条件成功,才继续判断后一个条件”;then 开始成功分支,fi 结束判断。
  3. 返回结果:成功时用 printf 输出 OK 并 exit 0;否则输出 FAILED 并 exit 1。\n 表示换行,>&2 表示把失败信息写到标准错误,便于其他工具区分正常输出和错误提示。

文件第一行 #!/bin/bash 指明直接执行文件时使用 Bash;如果用 bash 文件名 启动,则已经明确指定了解释器。

这里的“成功”有一个明确标准:接口请求成功,并且 HTTP 状态码恰好为 200。例如 404、500 或请求超时都会被判为失败;即使其他 2xx 状态码表示请求成功,这个脚本也不会把它们当作检查通过。


🛠 运行脚本并读取退出状态

执行脚本后,立即查看它返回的状态:

bash "$HOME/linux-lab/bin/health-check.sh"
printf '退出状态 %s\n' "$?"

如果 /health 返回 200,输出示例是:

OK http://127.0.0.1:3000/health
退出状态 0

如果接口无法访问,或者没有返回 200,则可能看到:

FAILED http://127.0.0.1:3000/health
退出状态 1

如果是连接失败,curl 还可能额外输出错误信息。退出状态是命令结束时返回的数字:0 通常表示成功,非零表示失败。$? 表示刚执行完的上一条命令的退出状态,所以必须紧跟在脚本执行之后查看。

也可以赋予文件执行权限后直接运行:

chmod u+x "$HOME/linux-lab/bin/health-check.sh"
"$HOME/linux-lab/bin/health-check.sh" http://127.0.0.1:3000/api/notes

u+x 表示为文件所有者添加执行权限。末尾传入的 URL 就是脚本的第一个参数,会替换默认的 /health 地址。

这个脚本只能判断指定接口是否返回 200;接口返回 200 不一定代表数据库等依赖也正常。如果需要检查这些依赖,应由应用提供相应的健康检查接口。


🧰 用循环批量检查和等待启动

1. 用 for 依次检查多个接口

如果发布后要检查 /health 和 /api/notes,不必手动重复输入两次命令。for 循环可以依次取出两个路由,把它们交给同一个巡检脚本:

for route in /health /api/notes; do
    bash "$HOME/linux-lab/bin/health-check.sh" "http://127.0.0.1:3000$route"
done

第一次循环时,route 是 /health;第二次是 /api/notes。do 表示循环执行的命令从这里开始,done 表示循环结束。假设两个接口都返回 200,输出示例是:

OK http://127.0.0.1:3000/health
OK http://127.0.0.1:3000/api/notes

注意:这段循环会逐个执行检查,不会因为某个接口失败就自动停止。要将多个接口的结果汇总为一个退出状态,还需要额外处理;本节先掌握 for 的基本用法。

2. 用 while 等待服务启动

Node.js 服务刚启动时,可能还没有开始监听端口。如果只检查一次,就可能把“尚未启动完成”当成持续故障。可以用 while 重复检查,最多尝试三次,成功就停止。

为了让“重试三次仍失败”的结果能够准确返回给其他工具,把下面的代码保存为另一个脚本:

vim "$HOME/linux-lab/bin/wait-for-health.sh"
wait-for-health.sh
#!/bin/bash

attempt=1

while [[ "$attempt" -le 3 ]]; do
    if bash "$HOME/linux-lab/bin/health-check.sh"; then
        printf '服务已就绪\n'
        exit 0
    fi

    attempt=$((attempt + 1))
    if [[ "$attempt" -le 3 ]]; then
        sleep 1
    fi
done

printf '重试三次后,服务仍未就绪\n' >&2
exit 1

这里的执行顺序是:

  1. attempt=1,从第一次检查开始。
  2. [[ "$attempt" -le 3 ]] 判断尝试次数是否小于或等于 3,成立就继续执行循环。
  3. 如果健康检查成功,exit 0 立即结束整个等待脚本;失败则用 $((attempt + 1)) 把次数加 1。
  4. 如果还有下一次机会,就用 sleep 1 等待 1 秒;三次全部失败后,跳出循环并 exit 1。

运行并查看最终结果:

bash "$HOME/linux-lab/bin/wait-for-health.sh"
printf '退出状态 %s\n' "$?"

如果第一次检查成功,会立即输出 服务已就绪,退出状态为 0。如果三次都失败,则会输出三次 FAILED、最后的 重试三次后,服务仍未就绪,退出状态为 1。

这样,部署流程就可以根据等待脚本本身的退出状态判断是否继续下一步,而不会因为最后执行了 sleep 而误判为成功。


❓ 知识问答

Q1:为什么 URL 要放在双引号里?

双引号可以让变量展开后的内容保持为一个参数,避免空格或通配符造成意外拆分。即使当前地址没有空格,也建议保留这种写法。

Q2:打印 FAILED 和 exit 1 有什么区别?

FAILED 是给人看的提示;exit 1 是脚本交给调用者的失败状态。其他脚本或自动化工具可以直接根据退出状态判断是否继续运行。

Q3:为什么既要判断 curl 成功,又要判断状态码为 200?

因为“请求能够完成”和“接口返回预期结果”不是同一回事。比如服务器返回 404 时,curl 通常仍能正常执行,但这不代表要检查的接口正常。


🧪 小练习

使用本篇的 health-check.sh 完成以下验证:

  1. 确保本地 /health 能返回 200,运行脚本并紧接着打印 $?;验收结果应为 OK 和 0。
  2. 将检查地址改为 http://127.0.0.1:3000/missing(确保该路由返回 404),再次执行;验收结果应为 FAILED 和 1。
  3. 用 if bash "$HOME/linux-lab/bin/health-check.sh"; then printf 'ready\n'; fi 验证:只有检查成功时才输出 ready。
  4. 停止本地服务后运行 wait-for-health.sh,确认它最多检查三次,并在全部失败后返回 1。

如果你的服务没有 /health 接口,可先使用一个确定返回 200 的接口替代;练习重点是观察脚本的输出和退出状态是否一致。


🎉 你已经把手动执行的接口检查变成了可重复运行的 Bash 脚本,还能通过退出状态让其他程序判断检查结果!