【RT-Thread学习笔记】结合案例学习调试shell脚本

描述

1 问题回顾

在之前的文章 【shell编程扫盲系列】结合真实案例分析“bash shell -e”到底是啥意思? 中,我提到了我遇到一个bash shell-e引发的问题,不瞒大家说,当时我是用echo大法找到出问题的地方,加以修改才解决的。 那么,我们有没有更加优雅的调试方法,解决这类型的问题呢? 本篇文章将会给出答案。

2 shell脚本如何调试

2.1 特别说明

本文中提及的shell脚本,无特殊说明的情况下,指的是bash shell。这里做这个强调的主要原因是,不同的shell的一些基础语法可能有微小的差异,导致在bash shell中可以跑的脚本,但在别的shell上就跑不了。 这种案例可以参见:【Linux Shell】你知道bash shell和dash shell的区别吗?

2.2 shell脚本如何被启动的?

初次看shell脚本的朋友,一定有所疑问为何大部分shell脚本都是#!/bin/bash开头啊? 这里帮你解除疑问: 因为shell脚本说白了就是一系列命令行组成的一个文本文件,由于各式各样的脚本非常多,那么该用哪种脚本的语法去解析这个脚本文件呢? 这里就有2种方式:

  • 通过脚本文件的首行,使用#!/bin/bash指定,像这样就表示它是一个bash shell语法的脚本,应该用/bin/bash去解析;
  • 通过启动的时候,直接用/bin/bash xxx.sh来启动,这样就是手动指定脚本的解析器。

注意:使用方式1的时候,运行脚本只需要./xxx.sh就可以了,但是方式2却不行。

2.3 shell脚本的三个调试选项

从之前的文章中,我们了解了-e选项,其实它还有其他几个跟调试相关的选项,如下所示:

  • -v (verbose 的简称) - 告诉 Shell 读取脚本时显示所有行,激活详细模式。
  • -n (noexec 或 no ecxecution 简称) - 指示 Shell 读取所有命令然而不执行它们,这个选项激活语法检查模式。
  • -x (xtrace 或 execution trace 简称) - 告诉 Shell 在终端显示所有执行的命令和它们的参数。 这个选项是启用 Shell 跟踪模式。

2.4 shell脚本的三种调试方式

2.4.1 在shell脚本的首行加选项

这个就跟-e的方式是一样的,注意加选项的时候,是连着-e起来,比如-evx,而不能这样-e-v-x。 这里的选项是可以加多个调试选项。 选项不对报错:

  1. bash_shell_e$ ./test_shell_e.sh 
  2. /bin/bash: - : invalid option

正常示例如下:

  1. #!/bin/shell -evx 的执行结果
  2.  
  3. /bash_shell_e$ ./test_shell_e.sh 
  4. # ~/.bashrc: executed by bash(1) for non-login shells.
  5. # see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
  6. # for examples
  7.  
  8. # If not running interactively, don't do anything
  9. case $- in
  10.     *i*) ;;
  11.       *) return;;
  12. esac
  13. + case $- in
  14. + return
  15. #! /bin/bash -evx
  16.  
  17. function get_os()
  18. {
  19.         echo "begin to get OS ..."
  20.  
  21.         os=`uname -a | grep Darwin`
  22.         if [ "$os" != "" ]]; then
  23.                 host_os_name=OSX
  24.         else
  25.                 os=`uname -a | grep x86_64`
  26.                 if [ "$os" != "" ]; then
  27.                         host_os_name=Linux64
  28.                 else
  29.                         host_os_name=Linux32
  30.                 fi
  31.         fi
  32.  
  33.         echo "get OS name: $host_os_name"
  34. }
  35.  
  36. function do_other_things()
  37. {
  38.         echo "do other things ..."
  39. }
  40.  
  41. get_os
  42. + get_os
  43. + echo 'begin to get OS ...'
  44. begin to get OS ...
  45. ++ uname -a
  46. ++ grep Darwin
  47. + os=

从这里结果,我们就可以知道,在执行完os=xxx赋值这条语句就退出了,这跟我们使用echo大法得出的结论是一致的。

2.4.2 手动显示shell脚本时加选项

即类似这样: /bin/bash -evx 启动脚本

  1. bash_shell_e$ /bin/bash -vxe test_shell_e.sh 
  2. # ~/.bashrc: executed by bash(1) for non-login shells.
  3. # see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
  4. # for examples
  5.  
  6. # If not running interactively, don't do anything
  7. case $- in
  8.     *i*) ;;
  9.       *) return;;
  10. esac
  11. + case $- in
  12. + return
  13. #! /bin/bash -e
  14.  
  15. function get_os()
  16. {
  17.         echo "begin to get OS ..."
  18.  
  19.         os=`uname -a | grep Darwin`
  20.         if [ "$os" != "" ]; then
  21.                 host_os_name=OSX
  22.         else
  23.                 os=`uname -a | grep x86_64`
  24.                 if [ "$os" != "" ]; then
  25.                         host_os_name=Linux64
  26.                 else
  27.                         host_os_name=Linux32
  28.                 fi
  29.         fi
  30.  
  31.         echo "get OS name: $host_os_name"
  32. }
  33.  
  34. function do_other_things()
  35. {
  36.         echo "do other things ..."
  37. }
  38.  
  39. get_os
  40. + get_os
  41. + echo 'begin to get OS ...'
  42. begin to get OS ...
  43. ++ uname -a
  44. ++ grep Darwin
  45. + os=

注意:当使用命令行传递输入选项后,脚本文件首行的选项就不生效了,这也是我实践过程中才发现的。 如下所示: 我的脚本首行是指定了-e的,但是它依然跑成功了,因为我使用-x启动,没有带-e

  1. bash_shell_e$ /bin/bash -x test_shell_e.sh    
  2. + case $- in
  3. + return
  4. + get_os
  5. + echo 'begin to get OS ...'
  6. begin to get OS ...
  7. ++ uname -a
  8. ++ grep Darwin
  9. + os=
  10. + '[' '' '!=' '' ']'
  11. ++ uname -a
  12. ++ grep x86_64
  13. + os='Linux ubuntu 5.4.0-65-generic #73-Ubuntu SMP Mon Jan 18 17:25:17 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux'
  14. + '[' 'Linux ubuntu 5.4.0-65-generic #73-Ubuntu SMP Mon Jan 18 17:25:17 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux' '!=' '' ']'
  15. + host_os_name=Linux64
  16. + echo 'get OS name: Linux64'
  17. get OS name: Linux64
  18. + do_other_things
  19. + echo 'do other things ...'
  20. do other things ...
  21. + exit 0

2.4.3 通过set命令设置调试选项

使用方法如下,它可以在脚本中调试任意一个函数,用法非常灵活

  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. # open debug option
  28. set -xv
  29.  
  30. get_os
  31.  
  32. # close debug option
  33. set +xv
  34.  
  35. # re-open debug option
  36. set -xv
  37.  
  38. do_other_things
  39.  
  40. # close debug option
  41. set +xv
  42.  
  43. exit 0

增加这些调试之后,运行结果如下:

  1. bash_shell_e$ ./test_shell_e_debug.sh 
  2.  
  3. get_os
  4. + get_os
  5. + echo 'begin to get OS ...'
  6. begin to get OS ...
  7. ++ uname -a
  8. ++ grep Darwin
  9. + os=

从这个输出,我们也可以看到在执行完ox=xxx赋值之后,脚本就停止运行,退出了,这跟我们之前的分析是一致的。 这个方法对于调试shell的函数非常有用,值得注意的是,set-xxx需要加在执行部分,而不是声明部分。

3 经验总结

  • 调试shell脚本有3个选项,-x -n -v 用法各异,灵活使用;
  • 调试shell脚本的方式也有3种,选用自己熟悉且方便的一种即可,高效排查问题。

4 更多分享

架构师李肯

一个专注于嵌入式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,日常分享一些开发笔记和项目实战,欢迎指正问题。

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

打开APP阅读更多精彩内容
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

×
20
完善资料,
赚取积分