【RT-Thread学习笔记】bash shell -e参数

1 前言

1.1 项目背景

这段时间博主在写一些编译构建的脚本，考虑到知识的储备性，之前对bash shell解除最多，而且我们的编译环境是在Linux下进行，所以我优选了bash shell脚本。

1.2 功能描述

期间我写了一个脚本，大致的功能就是获取当前操作系统是MacOS还是Linux，如果是Linux的话，还需要知道是Linux32还是Linux64。

2 场景分析

2.1 脚本实现

我们都知道Linux系统下有个uname命令可以输出当前系统的详细信息，而MacOS上由于它是Unix系统演变来的，所以它也是支持这个命令的。 经过一番研究，我就决定使用uname-a来获取输出信息，然后从输出信息里面检索关键字，进而判断是什么系统。 脚本实现代码如下：

1. #! /bin/bash -e
2.  
3. function get_os()
4. {
5.     echo "begin to get OS ..."
6.  
7.      os=`uname -a | grep Darwin`
8.     if [ "$os" != "" ]; then
9.         host_os_name=OSX
10.     else
11.         os=`uname -a | grep x86_64`
12.         if [ "$os" != "" ]; then
13.             host_os_name=Linux64
14.         else
15.             host_os_name=Linux32
16.         fi
17.     fi
18.  
19.     echo "get OS name: $host_os_name"
20. }
21.  
22. function do_other_things()
23. {    
24.     echo "do other things ..."
25. }
26.  
27. get_os
28.  
29. do_other_things
30.  
31. exit 0

2.2 问题复现

从功能逻辑上分析，没有任何问题，结果我在Linux-x64上面一跑，出乎意料了：

1. bash_shell_e$ ./test_shell_e.sh 
2. begin to get OS ...

感觉脚本压根就没跑完啊？怎么回事？

2.3 问题分析

调试代码，先从逻辑上分析没有问题，再使用万能的print大法，不过再bash shell里面就要用echo了。 通过一行行echo添加log，最终定位到是：

1. os=`uname -a | grep Darwin`

执行完这句之后，后面的if语句就没跑进去！ 但是uname-a|grepDarwin在我的机器上是可以执行的，并不会报错：

1. bash_shell_e$ uname -a | grep Darwin
2. bash_shell_e$ 

虽然是啥也没输出。 我们都知道在bash shell里面是通过echo $?来判断上一条命令执行是否成功的：

1. bash_shell_e$ echo $?
2. 1
3. bash_shell_e$ 
4. bash_shell_e$ ls
5. test_shell_e.sh
6. bash_shell_e$ 
7. bash_shell_e$ echo $?
8. 0

嗯哼？返回1，这个引起了我的注意，证明这条命令执行的返回是失败的。 回头再看看脚本的开始，我习惯上是写

1. #! /bin/bash -e

至于为啥带上-e，以前压根就没去考虑过，反正看到linux下的好多系统脚本就是这样写的，咱这样是像标准看齐，没想到还搞出问题了。

2.4 -e究竟是什么含义？

通过查了一些资料，发现这个-e不简单，它可以对每一条执行的shell脚本，自动判断其是否执行成功，如果执行失败，就立即退出整个脚本的执行。 用代码来体现就是，如果不加-e，你需要对一个命令的执行结果判断，就应该这样：

1. excute_shell_cmd
2. if [ $? != 0 ]; then
3.     exit 1
4. fi

而有了-e，就只有这样：

1. excute_shell_cmd

看，是不是大大简洁了脚本，而不会出现满屏的if-fi。 但是这个带来的最大问题就是，你可能不知道哪条语句就退出了，应该这里退出脚本执行的时候，没有任何输出提示，就好像我的案例场景一样。

2.4 解决办法1

既然知道是-e选项引起的，我去掉试试看：

1. #! /bin/bash 
2.  
3. function get_os()
4. {
5.     echo "begin to get OS ..."
6.  
7.      os=`uname -a | grep Darwin`
8.     if [ "$os" != "" ]; then
9.         host_os_name=OSX
10.     else
11.         os=`uname -a | grep x86_64`
12.         if [ "$os" != "" ]; then
13.             host_os_name=Linux64
14.         else
15.             host_os_name=Linux32
16.         fi
17.     fi
18.  
19.     echo "get OS name: $host_os_name"
20. }
21.  
22. function do_other_things()
23. {    
24.     echo "do other things ..."
25. }
26.  
27. get_os
28.  
29. do_other_things
30.  
31. exit 0

执行一下：

1. bash_shell_e$ ./test_shell.sh 
2. begin to get OS ...
3. get OS name: Linux64
4. do other things ...

得到了正确的结果，在其他平台上，也得到了正确的结果。

2.5 解决办法2

但是，如果我不想去掉-e呢，有没有什么办法？ 经过一番调试，我发现这样是可以的：

1. #! /bin/bash -e
2.  
3. function get_os()
4. {
5.     echo "begin to get OS ..."
6.  
7.     osx_name=Darwin
8.     linux64_name=x86_64
9.     if [ "`uname -a | grep $osx_name`" != "" ]; then
10.         host_os_name=OSX
11.     elif [ "`uname -a | grep $linux64_name`" != "" ]; then
12.         host_os_name=Linux64
13.     else
14.         host_os_name=Linux32        
15.     fi
16.  
17.     echo "get OS name: $host_os_name"
18. }
19.  
20. function do_other_things()
21. {
22.     echo "do other things ..."
23. }
24.  
25. get_os
26.  
27. do_other_things
28.  
29. exit 0

输出结果如下：

1. bash_shell_e$ ./test_shell_ok.sh 
2. begin to get OS ...
3. get OS name: Linux64
4. do other things ...

这里的区别在于，直接把uname-a|grepDarwin的执行结果参与if判断，而不是用一个变量去接收返回；这样居然就通过了。

2.6 扩展延伸

有没有更好的方法调试shell脚本呢？而不是满屏的echo？ 这个，下次我再发文介绍些高阶手段吧，敬请期待。

3 更多分享

架构师李肯

一个专注于嵌入式IoT领域的架构师。有着近10年的嵌入式一线开发经验，深耕IoT领域多年，熟知IoT领域的业务发展，深度掌握IoT领域的相关技术栈，包括但不限于主流RTOS内核的实现及其移植、硬件驱动移植开发、网络通讯协议开发、编译构建原理及其实现、底层汇编及编译原理、编译优化及代码重构、主流IoT云平台的对接、嵌入式IoT系统的架构设计等等。拥有多项IoT领域的发明专利，热衷于技术分享，有多年撰写技术博客的经验积累，连续多月获得RT-Thread官方技术社区原创技术博文优秀奖，荣获CSDN博客专家、CSDN物联网领域优质创作者、2021年度CSDN&RT-Thread技术社区之星、RT-Thread官方嵌入式开源社区认证专家、RT-Thread 2021年度论坛之星TOP4、华为云云享专家（嵌入式物联网架构设计师）等荣誉。坚信【知识改变命运，技术改变世界】！

本项目的所有测试代码和编译脚本，均可以在我的github仓库01workstation中找到。

欢迎关注我的github仓库01workstation，日常分享一些开发笔记和项目实战，欢迎指正问题。

同时也非常欢迎关注我的专栏，有问题的话，可以跟我讨论，知无不答，谢谢大家。