Shell 脚本 Debug 方法

      可能有的程序员在对程序调试的时候用printf或者echo将信息挨条打印出来，但是这比较麻烦，因为在交付的时候还要将这些语句一条条删除，下面对shell debug的方法稍微做一个总结：

      1、使用trap命令

       trap命令用于捕获指定的信号并执行预定义的命令。

        其基本的语法是:

        trap 'command' signal

        其中signal是要捕获的信号，command是捕获到指定的信号之后，所要执行的命令。可以用kill –l命令看到系统中全部可用的信号名，捕获信号后所执行的命令可以是任何一条或多条合法的shell语句，也可以是一个函数名。

        shell脚本在执行时，会产生三个所谓的“伪信号”，(之所以称之为“伪信号”是因为这三个信号是由shell产生的，而其它的信号是由操作系统产生的)，通过使用trap命令捕获这三个“伪信号”并输出相关信息对调试非常有帮助。

表 1. shell伪信号

信号名 何时产生

EXIT 从一个函数中退出或整个脚本执行完毕

ERR 当一条命令返回非零状态时(代表命令执行不成功)

DEBUG 脚本中每一条命令执行之前

        通过捕获EXIT信号,我们可以在shell脚本中止执行或从函数中退出时，输出某些想要跟踪的变量的值，并由此来判断脚本的执行状态以及出错原因,其使用方法是：

trap 'command' EXIT　或　trap 'command' 0

    通过捕获ERR信号,我们可以方便的追踪执行不成功的命令或函数，并输出相关的调试信息，以下是一个捕获ERR信号的示例程序，其中的$LINENO是一个shell的内置变量，代表shell脚本的当前行号。

$ cat -n exp1.sh

     1  ERRTRAP()

     2  {

     3    echo "[LINE:$1] Error: Command or function exited with status $?"

     4  }

     5  foo()

     6  {

     7    return 1;

     8  }

     9  trap 'ERRTRAP $LINENO' ERR

    10  abc

    11  foo

       

        其输出结果如下：

$ sh exp1.sh

exp1.sh: line 10: abc: command not found

[LINE:10] Error: Command or function exited with status 127

[LINE:11] Error: Command or function exited with status 1

       

        在调试过程中，为了跟踪某些变量的值，我们常常需要在shell脚本的许多地方插入相同的echo语句来打印相关变量的值，这种做法显得烦琐而笨拙。而通过捕获DEBUG信号，我们只需要一条trap语句就可以完成对相关变量的全程跟踪。

        以下是一个通过捕获DEBUG信号来跟踪变量的示例程序:

$ cat –n exp2.sh

     1  #!/bin/bash

     2  trap 'echo “before execute line:$LINENO, a=$a,b=$b,c=$c”' DEBUG

     3  a=1

     4  if [ "$a" -eq 1 ]

     5  then

     6     b=2

     7  else

     8     b=1

     9  fi

    10  c=3

    11  echo "end"

 

        其输出结果如下：

$ sh exp2.sh

before execute line:3, a=,b=,c=

before execute line:4, a=1,b=,c=

before execute line:6, a=1,b=,c=

before execute line:10, a=1,b=2,c=

before execute line:11, a=1,b=2,c=3

end

 

        从运行结果中可以清晰的看到每执行一条命令之后，相关变量的值的变化。同时，从运行结果中打印出来的行号来分析，可以看到整个脚本的执行轨迹，能够判断出哪些条件分支执行了，哪些条件分支没有执行。

2、使用调试钩子

if [ “$DEBUG” = “true” ]; then

echo “debugging”  #此处可以输出调试信息

fi

 

        这样的代码块通常称之为“调试钩子”或“调试块”。在调试钩子内部可以输出任何您想输出的调试信息，使用调试钩子的好处是它是可以通过DEBUG变量来控制的，在脚本的开发调试阶段，可以先执行export DEBUG=true命令打开调试钩子，使其输出调试信息，而在把脚本交付使用时，也无需再费事把脚本中的调试语句一一删除。

        如果在每一处需要输出调试信息的地方均使用if语句来判断DEBUG变量的值，还是显得比较繁琐，通过定义一个DEBUG函数可以使植入调试钩子的过程更简洁方便。 使用调试钩子.调试钩子实质上是自己定义的一个变量,如果这个变量为真,就会把调试信息作为参数传给某个定义的函数，然后在这个函数中执行此调试信息 。也可将该语句写成一个函数，在想要调试的地方调用。

  1  DEBUG()

     2  {

     3  if [ "$DEBUG" == "true" ]; then

     4      $@　　#此处执行传递给DEBUG的参数，在该程序中就是echo "a=$a"等

     5  fi

     6  }

     7  a=1

     8  DEBUG echo "a=$a"

     9  if [ "$a" -eq 1 ]

    10  then

    11       b=2

    12  else

    13       b=1

    14  fi

    15  DEBUG echo "b=$b"

    16  c=3

    17  DEBUG echo "c=$c"

DEBUG中的语句还可简写为：[  "$DEBUG" == "true"  ] && $@ || :  # :代表什么也不做。

除此之外还可以用 set -x 和set +x 来打开和关上调试信息，以及用tree或者如下方法

sh-n 只读取shell脚本，但不实际执行

sh-x 进入跟踪方式，显示所执行的每一条命令

sh-c "string" 从strings中读取命令 

还有一种方法就是：把#!/bin/bash改为#!/bin/bash -xv，这样不用任何其他选项就可以启动调试功能了。