SHELL脚本技巧学习总结

àì夳堔傛蜴生んèń 2022-12-29 11:28 157阅读 0赞

产品的最终用户通常不懂技术，所以不管你怎么折腾产品代码都无所谓。但脚本代码不一样，它们是开发人员写给开发人员的。

有多少次，你运行./script.sh，然后输出一些东西，但却不知道它刚刚都做了些什么。这是一种很糟糕的脚本用户体验。我将在这篇文章中介绍如何写出具有良好开发者体验的 shell 脚本。

产品的最终用户通常不懂技术，所以不管你怎么折腾产品代码都无所谓。但脚本代码不一样，它们是开发人员写给开发人员的。

**这样会导致一些问题：**

*  混乱的脚本——我知道，我们都是工程师，读得懂代码，但即使这样，也请为我们这些对 Shell 脚本不是很熟练的人考虑一下（我们在写代码时也会为你们考虑的）。
 *  满屏的日志和错误输出——就算我们也是工程师，并不代表我们了解你所做的一切。
 *  弄得一团糟却没有做好清理工作——是的，我们可以顺着你的脚本手动撤销变更，但你真的会让那些信任你的脚本的人这么做吗？

所以，我们可以通过一些方法来为自己和别人写出更好的 shell 脚本。这里给出的所有示例都可以使用与 POSIX 标准兼容的 shell 运行（\#!/bin/sh），因为它是最常用的。嫌文章太长了可以只看以下总结部分：

*  提供--help标记
 *  检查所有命令的可用性
 *  独立于当前工作目录
 *  如何读取输入：环境变量 vs. 标记
 *  打印对系统执行的所有操作
 *  如果有必要，提供--silent选项
 *  重新开启显示
 *  用动画的方式显示进度
 *  用颜色编码输出
 *  出现错误立即退出脚本
 *  自己执行清理工作
 *  在退出时使用不同的错误码
 *  在结束时打印一个新行

有时间的话可以接着往下看具体内容：

**提供--help标记**

安装在系统上的二进制文件通常带有man帮助文档，但对于脚本来说就不一定了。因此我们通常需要为脚本提供-h或--help标记来打印有关如何使用脚本的信息。如果其他工程师需要修改脚本，这也可以作为脚本的内联文档：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>#!/bin/sh</code> <code>if</code> <code>[ ${ </code><code>#@} -ne 0 ] &amp;&amp; [ "${@#"--help"}" = "" ]; then</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'...help...\n'</code><code>;</code> <code>&nbsp;</code><code>exit</code> <code>0;</code> <code>fi</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

这段脚本先计算参数长度（$\{\#@\} -ne 0），只有当参数长度不为零时才会检查--help标记。下一个条件会检查参数中是否存在字符串“--help” 。第一个条件是必需的，如果参数长度为零则不需要打印帮助信息。

**检查所有命令的可用性**

脚本通常会调用其他脚本或二进制文件。在调用可能不存在的命令时，请先检查它们是否可用。可以使用“command -v 二进制文件名称”来执行此操作，看看它的退出代码是否为零。如果命令不可用，可以告诉用户应该如何获得这个二进制文件：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>#!/bin/sh</code> <code>_=$(</code><code>command</code> <code>-</code><code>v</code> <code>docker);</code> <code>if</code> <code>[ </code><code>"$?"</code> <code>!= </code><code>"0"</code> <code>]; </code><code>then</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'You don\'t seem to have Docker installed.\n'</code><code>;</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'Get it: <a href="https://www.docker.com/community-edition" rel="nofollow">https://www.docker.com/community-edition</a>\n'</code><code>;</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'Exiting with code 127...\n'</code><code>;</code> <code>&nbsp;</code><code>exit</code> <code>127;</code> <code>fi</code><code>;</code> <code># ...</code> </td> 
 </tr> 
 </tbody> 
</table>

**独立于当前工作目录**

从不同的目录执行脚本可能会发生错误，这样的脚本没有人会喜欢。要解决这个问题，请使用绝对路径（/path/to/something）和脚本的相对路径（如下所示）。

可以使用dirname $0引用脚本的当前路径：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>#!/bin/sh</code> <code>CURR_DIR=</code><code>"$(dirname $0);"</code> <code>printf</code> <code>-- </code><code>'moving application to /opt/app.jar'</code><code>;</code> <code>mv</code> <code>"${CURR_DIR}/application.jar"</code> <code>/opt/app</code><code>.jar;</code> </td> 
 </tr> 
 </tbody> 
</table>

**如何读取输入：环境变量 vs. 标记**

脚本通过两种方式接受输入：环境变量和选项标记（参数）。根据经验，对于不影响脚本行为的值，可以使用环境变量，而对于可能触发脚本不同流程的值，可以使用脚本参数。

不影响脚本行为的变量可能是访问令牌和 ID 之类的东西：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>#!/bin/sh</code> <code># do this</code> <code>export</code> <code>AWS_ACCESS_TOKEN=</code><code>'xxxxxxxxxxxx'</code><code>;</code> <code>.</code><code>/provision-everything螺纹钢jiancai.mysteel.com</code> <code># and not</code> <code>.</code><code>/provisiong-everything</code> <code>--token </code><code>'xxxxxxxxxxx'</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

影响脚本行为的变量可能是需要运行实例的数量、是异步还是同步运行、是否在后台运行等参数：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>#!/bin/sh</code> <code># do this</code> <code>.</code><code>/provision-everything</code> <code>--async --instance-count 400</code> <code># and not</code> <code>INSTANCE_COUNT=400 ASYNC=</code><code>true</code> <code>.</code><code>/provision-everything</code> </td> 
 </tr> 
 </tbody> 
</table>

**打印对系统执行的所有操作**

脚本通常会对系统执行有状态的更改。不过，由于我们不知道用户何时会向发送SIGINT，也不知道脚本错误何时可能导致脚本意外终止，因此很有必要将正在做的事情打印在终端上，这样用户就可以在不去查看脚本的情况下回溯这些步骤：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>#!/bin/sh</code> <code>printf</code> <code>-- </code><code>'Downloading required document to ./downloaded... '</code><code>;</code> <code>wget -o .</code><code>/downloaded</code> <code>https:</code><code>//some</code><code>.site.com</code><code>/downloaded</code><code>;</code> <code>printf</code> <code>-- </code><code>'Moving ./downloaded to /opt/downloaded...'</code><code>;</code> <code>mv</code> <code>.</code><code>/downloaded</code> <code>/opt/</code><code>;</code> <code>printf</code> <code>-- </code><code>'Creating symlink to /opt/downloaded...'</code><code>;</code> <code>ln</code> <code>-s </code><code>/opt/downloaded</code> <code>/usr/bin/downloaded</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

**在必要时提供--silent选项**

有些脚本是为了将其输出传给其他脚本。虽说脚本都应该能够单独运行，不过有时候也有必要让它们把输出结果传给另一个脚本。可以利用stty -echo来实现--silent标记：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>#!/bin/sh</code> <code>if</code> <code>[ ${ </code><code>#@} -ne 0 ] &amp;&amp; [ "${@#"--silent"}" = "" ]; then</code> <code>&nbsp;</code><code>stty -</code><code>echo</code><code>;</code> <code>fi</code><code>;</code> <code># ...</code> <code># before point of intended output:</code> <code>stty +</code><code>echo</code> <code>&amp;&amp; </code><code>printf</code> <code>-- </code><code>'intended output\n'</code><code>;</code> <code># silence it again till end of script</code> <code>stty -</code><code>echo</code><code>;</code> <code># ...</code> <code>stty +</code><code>echo</code><code>;</code> <code>exit</code> <code>0;</code> </td> 
 </tr> 
 </tbody> 
</table>

**重新开启显示**

在使用stty -echo关闭脚本显示之后，如果发生致命错误，脚本将终止，而且不会恢复终端输出，这样对用户来说是没有意义的。可以使用trap来捕捉SIGINT和其他操作系统级别的信号，然后使用stty echo打开终端显示：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>#!/bin/sh</code> <code>error_handle() { </code> <code>&nbsp;</code><code>stty </code><code>echo</code><code>;</code> <code>}</code> <code>if</code> <code>[ ${ </code><code>#@} -ne 0 ] &amp;&amp; [ "${@#"--silent"}" = "" ]; then</code> <code>&nbsp;</code><code>stty -</code><code>echo</code><code>;</code> <code>&nbsp;</code><code>trap</code> <code>error_handle INT;</code> <code>&nbsp;</code><code>trap</code> <code>error_handle TERM;</code> <code>&nbsp;</code><code>trap</code> <code>error_handle KILL;</code> <code>&nbsp;</code><code>trap</code> <code>error_handle EXIT;</code> <code>fi</code><code>;</code> <code># ...</code> </td> 
 </tr> 
 </tbody> 
</table>

**用动画的方式显示进度**

有些命令需要运行很长时间，并非所有脚本都提供了进度条。在用户等待异步任务完成时，可以通过一些方式告诉他们脚本仍在运行。比如在while循环中打印一些信息：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 </td> 
 <td> <code>#!/bin/sh</code> <code>printf</code> <code>-- </code><code>'Performing asynchronous action..'</code><code>;</code> <code>.</code><code>/trigger-action</code><code>;</code> <code>DONE=0;</code> <code>while</code> <code>[ $DONE -</code><code>eq</code> <code>0 ]; </code><code>do</code> <code>&nbsp;</code><code>.</code><code>/async-checker</code><code>;</code> <code>&nbsp;</code><code>if</code> <code>[ </code><code>"$?"</code> <code>= </code><code>"0"</code> <code>]; </code><code>then</code> <code>DONE=1; </code><code>fi</code><code>;</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'.'</code><code>;</code> <code>&nbsp;</code><code>sleep</code> <code>1;</code> <code>done</code><code>;</code> <code>printf</code> <code>-- </code><code>' DONE!\n'</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

或者可以做一些更好玩的小玩意儿，比如 http://mywiki.wooledge.org/BashFAQ/034。

**用颜色编码输出**

在脚本中调用其他二进制文件或脚本时，对它们的输出进行颜色编码，这样就可以知道哪个输出来自哪个脚本或二进制文件。这样我们就不需要在满屏的黑白输出文本中查找想要的输出结果。

理想情况下，脚本应该输出白色（默认的，前台进程），子进程应该使用灰色（通常不需要，除非出现错误），使用绿色表示成功，红色表示失败，黄色表示警告。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>#!/bin/sh</code> <code>printf</code> <code>-- </code><code>'doing something... \n'</code><code>;</code> <code>printf</code> <code>-- </code><code>'\033[37m someone else'</code><code>s output \033[0m\n';</code> <code>printf</code> <code>-- </code><code>'\033[32m SUCCESS: yay \033[0m\n'</code><code>;</code> <code>printf</code> <code>-- </code><code>'\033[33m WARNING: hmm \033[0m\n'</code><code>;</code> <code>printf</code> <code>-- </code><code>'\033[31m ERROR: fubar \033[0m\n'</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

可以使用\\033\[Xm，其中X代表颜色代码。有些脚本使用\\e而不是\\033，但要注意\\e不适用于所有的 UNIX 系统。

![abfc37ab4bed471fd5b763449ebf98eb.png][]

正确示范

可在.sh 中使用的所有颜色和修饰符 https://misc.flogisoft.com/bash/tip\_colors\_and\_formatting。

**出现错误立即退出脚本**

set -e表示从当前位置开始，如果出现任何错误都将触发EXIT。相反，set +e表示不管出现任何错误继续执行脚本。

如果脚本是有状态的（每个后续步骤都依赖前一个步骤），那么请使用set -e，在脚本出现错误时立即退出脚本。如果要求所有命令都要执行完（很少会这样），那么就使用set +e。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>#!/bin/sh</code> <code>set</code> <code>+e;</code> <code>.</code><code>/script-1</code><code>;</code> <code>.</code><code>/script-2</code><code>; </code><code># does not depend on ./script-1</code> <code>.</code><code>/script-3</code><code>; </code><code># does not depend on ./script-2</code> <code>set</code> <code>-e;</code> <code>.</code><code>/script-4</code><code>;</code> <code>.</code><code>/script-5</code><code>; </code><code># depends on success of ./script-4</code> <code># ...</code> </td> 
 </tr> 
 </tbody> 
</table>

**自己执行清理工作**

大多数脚本在出现错误时不会执行清理工作，能够做好这方面工作的脚本实属罕见，但这样做其实很有用，还可以省下不少时间。前面已经给出过示例，让stty恢复正常，并借助trap命令来执行清理工作：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>#!/bin/sh</code> <code>handle_exit_code() { </code> <code>&nbsp;</code><code>ERROR_CODE=</code><code>"$?"</code><code>;</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>"an error occurred. cleaning up now... "</code><code>;</code> <code>&nbsp;</code><code># ... cleanup code ...</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>"DONE.\nExiting with error code ${ERROR_CODE}.\n"</code><code>;</code> <code>&nbsp;</code><code>exit</code> <code>${ERROR_CODE};</code> <code>}</code> <code>trap</code> <code>"handle_exit_code"</code> <code>EXIT;</code> <code># ... actual script...</code> </td> 
 </tr> 
 </tbody> 
</table>

**在退出时使用不同的错误码**

在绝大多数 shell 脚本中，exit 0 表示执行成功，exit 1 表示发生错误。对错误与错误码进行一对一的映射，这样有助于脚本调试。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 </td> 
 <td> <code>#!/bin/sh</code> <code># ...</code> <code>if</code> <code>[ </code><code>"$?"</code> <code>!= </code><code>"0"</code> <code>]; </code><code>then</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'X happened. Exiting with status code 1.\n'</code><code>;</code> <code>&nbsp;</code><code>exit</code> <code>1;</code> <code>fi</code><code>;</code> <code># ...</code> <code>if</code> <code>[ </code><code>"$?"</code> <code>!= </code><code>"0"</code> <code>]; </code><code>then</code> <code>&nbsp;</code><code>printf</code> <code>-- </code><code>'Y happened. Exiting with status code 2.\n'</code><code>;</code> <code>&nbsp;</code><code>exit</code> <code>2;</code> <code>fi</code><code>;</code> </td> 
 </tr> 
 </tbody> 
</table>

这样做有另一个额外的好处，就是其他脚本在调用你的脚本时，可以根据错误码来判断发生了什么错误。

**在结束时打印一个新行**

如果你有在遵循脚本的最佳实践，那么可能会使用printf代替echo（它在不同系统中的行为有所差别）。问题是printf在命令结束后不会自动添加一个新行，导致控制台看起来是这样的：

![dc96ed92eb399db15e5e30ba57f4e324.png][]

看起来是多么的平淡

这样一点也不酷，可以通过简单的方式打印一个新行：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>#!/bin/sh</code> <code># ... your awesome script ...</code> <code>printf</code> <code>-- </code><code>'\n'</code><code>;</code> <code>exit</code> <code>0;</code> </td> 
 </tr> 
 </tbody> 
</table>

这样就可以得到：

![74368361da9fe03c2f1a11becfcba4f3.png][]

好多了哈

别人会感谢你这么做的。

**总结**

这篇文章大致总结了一些简单易用的技巧，让 shell 脚本更易于调试和使用。

原文链接：https://codeburst.io/13-tips-tricks-for-writing-shell-scripts-with-awesome-ux-19a525ae05ae

好了，以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

[abfc37ab4bed471fd5b763449ebf98eb.png]: /images/20221120/9658d4bcd042427eb8eda65777a4598b.png
[dc96ed92eb399db15e5e30ba57f4e324.png]: /images/20221120/8fd23e686f2848d8b940b793f5edc022.png
[74368361da9fe03c2f1a11becfcba4f3.png]: /images/20221120/e323caae4997406cbcf1e17ac76dd566.png