|
|
51CTO旗下网站
|
|
移动端

“Exit Trap” 让你的Bash脚本更稳固可靠

有个简单实用的技巧可以让你的 bash 脚本更稳健 -- 确保总是执行必要的收尾工作,哪怕是在发生异常的时候。要做到这一点,秘诀就是 bash 提供的一个叫做 EXIT 的伪信号,你可以 trap 它,当脚本因为任何原因退出时,相应的命令或函数就会执行。我们来看看它是如何工作的。

作者:Aaron Maxwell来源:Linux中国|2018-05-14 15:55

http://s1.51cto.com/oss/201805/14/5d02c55b92d4af8535409997c774c222.jpeg-wh_651x-s_3945587282.jpeg

有个简单实用的技巧可以让你的 bash 脚本更稳健 -- 确保总是执行必要的收尾工作,哪怕是在发生异常的时候。要做到这一点,秘诀就是 bash 提供的一个叫做 EXIT 的伪信号,你可以 trap 它,当脚本因为任何原因退出时,相应的命令或函数就会执行。我们来看看它是如何工作的。

基本的代码结构看起来像这样:

  1. #!/bin/bash
  2. function finish {
  3. # 你的收尾代码
  4. }
  5. trap finish EXIT

你可以把任何你觉得务必要运行的代码放在这个 finish 函数里。一个很好的例子是:创建一个临时目录,事后再删除它。

  1. #!/bin/bash
  2. scratch=$(mktemp -d -t tmp.XXXXXXXXXX)
  3. function finish {
  4. rm -rf "$scratch"
  5. }
  6. trap finish EXIT

这样,在你的核心代码中,你就可以在这个 $scratch 目录里下载、生成、操作中间或临时数据了。注1

  1. # 下载所有版本的 linux 内核…… 为了科学研究!
  2. for major in {1..4}; do
  3. for minor in {0..99}; do
  4. for patchlevel in {0..99}; do
  5. tarball="linux-${major}-${minor}-${patchlevel}.tar.bz2"
  6. curl -q "http://kernel.org/path/to/$tarball" -o "$scratch/$tarball" || true
  7. if [ -f "$scratch/$tarball" ]; then
  8. tar jxf "$scratch/$tarball"
  9. fi
  10. done
  11. done
  12. done
  13. # 整合成单个文件
  14. # 复制到目标位置
  15. cp "$scratch/frankenstein-linux.tar.bz2" "$1"
  16. # 脚本结束, scratch 目录自动被删除

比较一下如果不用 trap ,你是怎么删除 scratch 目录的:

  1. #!/bin/bash
  2. # 别这样做!
  3.  
  4. scratch=$(mktemp -d -t tmp.XXXXXXXXXX)
  5.  
  6. # 在这里插入你的几十上百行代码
  7.  
  8. # 都搞定了,退出之前把目录删除
  9. rm -rf "$scratch"

这有什么问题么?很多:

  • 如果运行出错导致脚本提前退出, scratch 目录及里面的内容不会被删除。这会导致资料泄漏,可能引发安全问题。
  • 如果这个脚本的设计初衷就是在脚本末尾以前退出,那么你必须手动复制粘贴 rm 命令到每一个出口。

  • 这也给维护带来了麻烦。如果今后在脚本某处添加了一个 exit ,你很可能就忘了加上删除操作 -- 从而制造潜在的安全漏洞。

无论如何,服务要在线

另外一个场景: 想象一下你正在运行一些自动化系统运维任务,要临时关闭一项服务,最后这项服务需要重启,而且要万无一失,即使脚本运行出错。那么你可以这样做:

  1. function finish {
  2. # 重启服务
  3. sudo /etc/init.d/something start
  4. }
  5. trap finish EXIT
  6. sudo /etc/init.d/something stop
  7. # 主要任务代码
  8.  
  9. # 脚本结束,执行 finish 函数重启服务

一个具体的实例:比如 Ubuntu 服务器上运行着 MongoDB ,你要为 crond 写一个脚本来临时关闭服务并做一些日常维护工作。你应该这样写:

  1. function finish {
  2. # 重启服务
  3. sudo service mongdb start
  4. }
  5. trap finish EXIT
  6. # 关闭 mongod 服务
  7. sudo service mongdb stop
  8. # (如果 mongod 配置了 fork ,比如 replica set ,你可能需要执行 sudo killall --wait /usr/bin/mongod”) 

控制开销

有一种情况特别能体现 EXIT trap 的价值:如果你的脚本运行过程中需要初始化一下成本高昂的资源,结束时要确保把它们释放掉。比如你在 AWS (Amazon Web Services) 上工作,要在脚本中创建一个镜像。

(名词解释: 在亚马逊云上的运行的服务器叫“实例”。实例从亚马逊机器镜像Amazon Machine Image创建而来,通常被称为 “AMI” 或 “镜像” 。AMI 相当于某个特殊时间点的服务器快照。)

我们可以这样创建一个自定义的 AMI :

  1. 基于一个基准 AMI 运行一个实例(例如,启动一个服务器)。
  2. 在实例中手动或运行脚本来做一些修改。
  3. 用修改后的实例创建一个镜像。
  4. 如果不再需要这个实例,可以将其删除。

最后一步相当重要。如果你的脚本没有把实例删除掉,它会一直运行并计费。(到月底你的账单让你大跌眼镜时,恐怕哭都来不及了!)

如果把 AMI 的创建封装在脚本里,我们就可以利用 trap EXIT 来删除实例了。我们还可以用上 EC2 的命令行工具:

  1. #!/bin/bash
  2. # 定义基准 AMI ID
  3. ami=$1
  4. # 保存临时实例的 ID
  5. instance=''
  6. # 作为 IT 人,让我们看看 scratch 目录的另类用法
  7. scratch=$(mktemp -d -t tmp.XXXXXXXXXX)
  8. function finish {
  9. if [ -n "$instance" ]; then
  10. ec2-terminate-instances "$instance"
  11. fi
  12. rm -rf "$scratch"
  13. }
  14. trap finish EXIT
  15. # 创建实例,将输出(包含实例 ID )保存到 scratch 目录下的文件里
  16. ec2-run-instances "$ami" > "$scratch/run-instance"
  17. # 提取实例 ID
  18. instance=$(grep '^INSTANCE' "$scratch/run-instance" | cut -f 2)

脚本执行到这里,实例(EC2 服务器)已经开始运行 注2。接下来你可以做任何事情:在实例中安装软件,修改配置文件等,然后为最终版本创建一个镜像。实例会在脚本结束时被删除 -- 即使脚本因错误而提前退出。(请确保实例创建成功后再运行业务代码。)

更多应用

这篇文章只讲了些皮毛。我已经使用这个 bash 技巧很多年了,现在还能不时发现一些有趣的用法。你也可以把这个方法应用到你自己的场景中,从而提升你的 bash 脚本的可靠性。

尾注

  • 注1. mktemp 的选项 -t 在 Linux 上是可选的,在 OS X 上是必需的。带上此选项可以让你的脚本有更好的可移植性。
  • 注2. 如果只是为了获取实例 ID ,我们不用创建文件,直接写成 instance=$(ec2-run-instances "$ami" | grep '^INSTANCE' | cut -f 2) 就可以。但把输出写入文件可以记录更多有用信息,便于调试 ,代码可读性也更强。 

【编辑推荐】

  1. 如何在Linux上查看用户的创建日期
  2. 千万千万不可运行的Linux命令
  3. 在Ubuntu和Linux Mint中轻松安装Android Studio
  4. 女生适不适合进入IT行业做Linux运维工程师?
  5. 逼格高又实用的Linux高级命令,开发运维都要懂
【责任编辑:庞桂玉 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

读 书 +更多

《ASP.NET AJAX Web 应用开发秘诀(VB版)》

本书详细介绍了AJAX在Web开发上的应用。主要内容包括:ASP.NET AJAX技术概述、实现异步局部更新页面、UpdatePanel编程功能、PageRequestMan...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊