Shell编程-12-Shell脚本规范及调试

目录

  • Shell脚本规范
  • Shell脚本调试

Shell脚本规范

? ? 良好的代码规范不仅方便阅读,也利于维护和提升开发效率。因此建议大家在编写Shell脚本时养成良好的代码习惯。今天就和大家探讨一下在Shell脚本中的一些规范,详细如下所示:

  • 1、在Shell脚本中,第一行指定脚本解释器,如下所示:
#!/bin/bash
或
#!/bin/sh
  • 2、在Shell脚本中填写代码作者、日期、版权等信息,便于协同开发
  • 3、Shell脚本中的注释,尽量采用英文注释,避免中文注释,可避免本机或切换系统环境后出现乱码,如果必须采用中文,建议按在脚本中添加以下环境变量
export LANG="zh_CN.UTF-8"
  • 4、脚本命名需要简洁明了且以.sh作为扩展名
  • 5、脚本尽量存放在固定的路径中,便于查找、调用和维护
  • 6、代码编写技巧如下所示:
> a):成对的符号尽量一次书写完整,而后再向里面添加内容,这样可以避免遗漏符号。
     如 {} [] ‘‘ " " ``
> b):[ ]和[[ ]] 两端至少要留有一个空格
> c):对于if/for/while/select/case 等应一次将格式写完,而后再添加对应的处理语句
> d):代码中应注意缩进,便于阅读,可使用TAB或空格,一般建议采用空格键进行缩进
> e):字符串赋值给变量应加双引号("")并且等号前后不能有空格
    如 str="Test"
> f):脚本中的书写必须为英文状态下的符号、字母等。
  • 7、全局变量(环境变量)的定义需要全部大写,其名称需要一看便知其意,定义需要使用export
  • 8、局部变量(普通变量)命名需要遵循一定的命名规则,如驼峰语法;风格要统一
  • 9、Shell函数中的变量可以使用local方式进行定义,使之仅在该函数体内有效,从而避免与外部程序的变量相同,造成程序异常
[[email protected] Test]# cat local.sh
#!/bin/bash
function Test () {
 local i # 定义本地变量,仅在函数体内有效
for((i=0;i<5;i++))
 do
   echo "in function i is:" ${i}
 done
}
Test
i=100
echo "not in function i is:"${i}
[[email protected] Test]# bash local.sh
in function i is: 0
in function i is: 1
in function i is: 2
in function i is: 3
in function i is: 4
not in function i is:100
  • 10、在引用变量时,若变量前后都有字符,则需要使用${variable}进行引用,避免产生歧义;当变量为字符串时,需要使用"${variable}"进行引用;当变量为整数时,则可以直接使用$variable进行引用。
  • 11、对于一些经常变化的信息,建议采用变量或位置参数等进行定义和使用。
  • 12、脚本中要检查配置项是否为空,是否可执行等,增加脚本的健壮性。

Shell脚本调试

? ? 相比于其他编程语言,Shell脚本没有专门的IDE去进行各类细致的调试。但我们可以通过运行Shell脚本的错误提示和打印信息来进行排错和纠错。

常见错误示例

  • 1、if语句缺少结尾关键字
[[email protected] Test]# cat -n testif.sh
     1  #!/bin/bash
     2  if [ -f /root/Test/a.sh ]
     3    then
     4     echo "/root/Test/a.sh exist"
     5  else
     6    echo "/root/Test/a.sh no exist" # 缺少fi
[[email protected] Test]# bash testif.sh
testif.sh:行7: 语法错误: 未预期的文件结尾

在上面提示中,显示第7行存在错误,依据该提示,我们可以仔细观察错误提示的前后,应该不难找出错误。

在运行Shell脚本出现错误后,不能单看提示的错误行,需要结合提示行前后进行排错。Shell不会对脚本错误进行精确定位,这个也是区别于其他语言的地方。
  • 2、循环语句中缺少关键字或关键字拼写不正确
[[email protected] Test]# cat -n testif.sh
     1  #!/bin/bash
     2  while
     3   do
     4  if [ -f /root/Test/a.sh ]
     5    then
     6     echo "/root/Test/a.sh exist"
     7  else
     8    echo "/root/Test/a.sh no exist" # 结尾少了done
[[email protected] Test]# bash testif.sh
testif.sh:行3: 未预期的符号 `do‘ 附近有语法错误
testif.sh:行3: ` do‘
  • 3、成对的符号落了单
[[email protected] Test]# cat -n testif.sh
     1  #!/bin/bash
     2  #while
     3   #do
     4  if [ -f /root/Test/a.sh # 缺少 ]
     5    then
     6     echo "/root/Test/a.sh exist"
     7  else
     8    echo "/root/Test/a.sh no exist"
     9  fi
[[email protected] Test]# bash testif.sh
testif.sh: 第 4 行:[: 缺少 `]‘
/root/Test/a.sh no exist
  • 4、[]和[[]]两端缺少空格
[[email protected] Test]# cat testif.sh
#!/bin/bash
#while
 #do
if [-f /root/Test/a.sh] # [] 两端没有空格
  then
   echo "/root/Test/a.sh exist"
else
  echo "/root/Test/a.sh no exist"
fi
[[email protected] Test]# bash testif.sh
testif.sh:行4: [-f: 未找到命令

Shell调试技巧

  • 1、Windows中编写脚本明明语法什么均正确,在Linux中跟却提示各种语法错误,这种情况建议优先在Linux写脚本。因为Windows中和格式与Linux格式还是有很多差异的。
  • 2、在代码关键地方打印日志,如使用echo
  • 3、使用bash命令参数调试,常用调试参数如下所示:
> -n : 不执行脚本仅检查脚本语法是否存在错误
> -v : 先将脚本内容显示到屏幕再执行执行脚本
> -x : 将执行脚本的内容及输出全部显示到屏幕上

以上参数示例如下,所示:

-n参数示例:

[[email protected] Test]# cat -n testif.sh
     1  #!/bin/bash
     2  #while
     3   #do
     4  if [ -f /root/Test/a.sh ]
     5    then
     6     echo "/root/Test/a.sh exist"
     7  else
     8    echo "/root/Test/a.sh no exist"
     9                                    # 缺少结束标志 fi
[[email protected] Test]# bash -n testif.sh
testif.sh:行10: 语法错误: 未预期的文件结尾

-v参数示例:

[[email protected] Test]# bash -v testif.sh # 显示脚本内容并执行脚本
#!/bin/bash
#while
 #do
if [ -f /root/Test/a.sh ]
  then
   echo "/root/Test/a.sh exist"
else
  echo "/root/Test/a.sh no exist"
fi
/root/Test/a.sh no exist  # 脚本执行结果

-x参数示例:

[[email protected] Test]# cat -n sum.sh
     1  #!/bin/bash
     2  function Sum () {
     3   for((i=1;i<=$1;i++))
     4   do
     5    ((sum=sum+i))
     6    echo "{1..$1} sum is :" ${sum}
     7   done
     8  }
     9
    10  Sum $1
    11  if [ $? == "0" ]
    12   then
    13    echo "Completed"
    14  else
    15    echo "Error"
    16  fi
[[email protected] Test]# bash -x sum.sh 5
+ Sum 5
+ (( i=1 ))
+ (( i<=5 ))
+ (( sum=sum+i ))
+ echo ‘{1..5} sum is :‘ 1
{1..5} sum is : 1
+ (( i++ ))
+ (( i<=5 ))
+ (( sum=sum+i ))
+ echo ‘{1..5} sum is :‘ 3
{1..5} sum is : 3
+ (( i++ ))
+ (( i<=5 ))
+ (( sum=sum+i ))
+ echo ‘{1..5} sum is :‘ 6
{1..5} sum is : 6
+ (( i++ ))
+ (( i<=5 ))
+ (( sum=sum+i ))
+ echo ‘{1..5} sum is :‘ 10
{1..5} sum is : 10
+ (( i++ ))
+ (( i<=5 ))
+ (( sum=sum+i ))
+ echo ‘{1..5} sum is :‘ 15
{1..5} sum is : 15
+ (( i++ ))
+ (( i<=5 ))
+ ‘[‘ 0 == 0 ‘]‘
+ echo Completed
Completed

前面带有"+"表示执行的过程语句,没有带"+"则表示输出的结果,通过-x参数可以查看整个执行的过程中每一步

Shell调试总结

  • 1、如果在Windows中编写的脚本在Linux中无法运行时,可使用工具dos2unix或Notepad++转换为Linux格式
  • 2、Shell脚本运行中的报错并不像其他高级语言一样详细,在排错时需要结合前后代码段进行排查纠错
  • 3、在调试中可使用bash自带的参数进行调试定位问题点
  • 4、平时养成良好的代码习惯和规范,可以规避部分常识性的错误

? ? Shell编程基础篇到此已经介绍完毕。本系列也仅仅入门系统,如果还要继续深入学习,还需要多看看别人优秀的代码,做到多看多练,方能更进一步。

本文同步在微信订阅号上发布,如各位小伙伴们喜欢我的文章,也可以关注我的微信订阅号:woaitest,或扫描下面的二维码添加关注:

原文地址:https://www.cnblogs.com/surpassme/p/10041382.html

时间: 2024-10-10 14:52:28

Shell编程-12-Shell脚本规范及调试的相关文章

shell编程之服务脚本编写,文件锁以及信号捕获

shell脚本编程是linux运维工程师必备的技能,也是非常重要的一个技能,所以把shell编程学好,只有好处.基础语法我也就不讲了,学过C语言这些语言的,稍微看一下就能明白shell编程的基础,所以我们直接切入正题. 开班第20天: 今天的课程大纲: shell编程中的函数 编写一个自动挂载的脚本 利用autofs怎么实现自动挂载 文件锁和信号捕获trap sed流文件编辑器 详细讲解: shell编程中的函数 shell中,我们定义函数的方法有两种: 下面调用的时候,直接调用函数名就可以了

Shell编程—构建基本脚本

1. 使用多个命令 如果要两个命令或者多个命令一起运行,可以把它们放在同一行中,彼此间用分号隔开. 2. 创建 shell 脚本文件 在创建shell脚本文件时,必须在文件的第一行指定要使用的shell.其格式为: #!/bin/bash 在通常的shell脚本中,井号(#)用作注释行.shell并不会处理shell脚本中的注释行.然而,shell脚本文件的第一行是个例外,#后面的惊叹号会告诉shell用哪个shell来运行脚本(是的,你可以使用bash shell,同时还可以使用另一个shel

shell编程01—shell基础

01.学习shell编程需要的知识储备 1.vi.vim编辑器的命令,vimrc设置 2.命令基础,100多个命令 3.基础.高端的网络服务,nfs,rsync,inotify,lanmp,sersync,sshkey批量分发管理 02.shell脚本概念 1.什么是shell shell是一个命令解释器,在操作系统的最外层,负责直接与用户对话,将用户的输入解释给操作系统,并输出操作系统各种各样的处理结果,输出到屏幕返回给用户.这种对话方式可与是交互式的(键盘输入命令,可以立即得到shell的回

Shell编程之三 —— shell script 脚本(未完待续)

1.脚本的语法构成: shell script 是利用 shell 的功能所写的一个『程序(program)』,这个程序是使用纯文本文件(文件后缀名最好为sh文件,方便我们管理),将一些 shell 的语法与指令(含外部指令)写在里面, 搭通配符.配正规表示法.管线命令与数据流重定向.条件判断.循环逻辑等功能,以达到我们所想要的处理目的. 构成(常见):shell语法和外部指令   通配符     [a-z]  [A-Z]     ?    *          正规表达式      管线命令

linux基础之shell编程(3)-给脚本设置参数

bash的变量类型 本地变量(局部变量) 环境变量 位置变量:$1,$2,$3, ... 特殊变量:$?,$#,$*,[email protected] 那让脚本拥有获取外界参数的能力就要用的位置变量,$1代表第一个参数,$2代表第二个参数,依次类推 例: vartest.sh #!/bin/bash # ONEVAR=$1 TWOVAR=$2 THREEVAR=$3 echo "第一个参数是:${ONEVAR}" echo "第二个参数是:${TWOVAR}" e

Shell 学习12 - Shell 数组

Shell在编程方面比Windows批处理强大很多,无论是在循环.运算. bash支持一维数组(不支持多维数组),并且没有限定数组的大小.类似与C语言,数组元素的下标由0开始编号.获取数组中的元素要利用下标,下标可以是整数或算术表达式,其值应大于或等于0. 定义数组 在Shell中,用括号来表示数组,数组元素用"空格"符号分割开.定义数组的一般形式为: array_name=(value1 ... valuen) 例如: array_name=(value0 value1 value2

Linux Shell编程实战---Shell中的文本切片技术

Shell中的文本切片技术 在shell中竟然也是有字符串切片这个东西存在的,一直在python中运用切片,下面记录一下shell中切片的用法. (1).替换变量内容中的部分文本 $var="This is a line of text" $ echo${var/line/REPLACED} This is aREPLACED of text" line被替换成REPLACED. (2).指定字符串的起始位置和长度来生成子串 语法如下: ${variable_name:sta

shell编程基础-shell分库备份

分库备份企业实战题7:如何实现对MySQL数据库进行分库备份,请用脚本实现 #!/bin/bash MysqlUser=root PassWord=root Port=3306 Socket="/usr/include/mysql/mysql.sock" MysqlCmd="mysql -u$MysqlUser -p$PassWord -S $Socket" Database=`$MysqlCmd -e "show databases;"|egr

Linux Shell编程实战---shell实现图片下载神器

$ cat dowonload_image.sh  #!/bin/bash ######################################### #图片下载器                              # #script_name: dowonload_image.sh         # #author:weixiaoxin write by 2017-09-20   #      #########################################