Bash脚本15分钟进阶教程

本文分享了一系列提高Bash脚本质量的技术技巧,包括确保脚本安全、利用脚本函数增强可读性、变量注解的最佳实践、使用$()及[[]]替代旧语法、正则表达式和Globbing的运用、字符串操作建议、避免临时文件的方法、内置变量的使用、调试技巧以及何时不宜使用Bash脚本。


这里的技术技巧最初是来自谷歌的“Testing on the Toilet” (TOTT)。这里是一个修订和扩增版本。

脚本安全

我的所有bash脚本都以下面几句为开场白:

    #!/bin/bash
    set -o nounset
    set -o errexit

这样做会避免两种常见的问题:

  1. 引用未定义的变量(缺省值为“”)
  2. 执行失败的命令被忽略

需要注意的是,有些Linux命令的某些参数可以强制忽略发生的错误,例如“mkdir -p” 和 “rm -f”。

还要注意的是,在“errexit”模式下,虽然能有效的捕捉错误,但并不能捕捉全部失败的命令,在某些情况下,一些失败的命令是无法检测到的。(更多细节请参考这个帖子。)

脚本函数

在bash里你可以定义函数,它们就跟其它命令一样,可以随意的使用;它们能让你的脚本更具可读性:

    ExtractBashComments() {
        egrep "^#"
    } 

    cat myscript.sh | ExtractBashComments | wc 

    comments=$(ExtractBashComments < myscript.sh)

还有一些例子:

    SumLines() {  # iterating over stdin - similar to awk      
        local sum=0
        local line=””
        while read line ; do
            sum=$((${sum} + ${line}))
        done
        echo ${sum}
    } 

    SumLines < data_one_number_per_line.txt 

    log() {  # classic logger
       local prefix="[$(date +%Y/%m/%d\ %H:%M:%S)]: "
       echo "${prefix} $@" >&2
    } 

    log "INFO" "a message"

尽可能的把你的bash代码移入到函数里,仅把全局变量、常量和对“main”调用的语句放在最外层。

变量注解

Bash里可以对变量进行有限的注解。最重要的两个注解是:

  1. local(函数内部变量)
  2. readonly(只读变量)
    # a useful idiom: DEFAULT_VAL can be overwritten
    #       with an environment variable of the same name
    readonly DEFAULT_VAL=${DEFAULT_VAL:-7} 

    myfunc() {
       # initialize a local variable with the global default
       local some_var=${DEFAULT_VAL}
       ...
    }

这样,你可以将一个以前不是只读变量的变量声明成只读变量:

x=5
x=6
readonly x
x=7   # failure

尽量对你bash脚本里的所有变量使用localreadonly进行注解。

$()代替反单引号(`)

反单引号很难看,在有些字体里跟正单引号很相似。$()能够内嵌使用,而且避免了转义符的麻烦。

# both commands below print out: A-B-C-D
echo "A-`echo B-\`echo C-\\\`echo D\\\`\``"
echo "A-$(echo B-$(echo C-$(echo D)))"

[[]](双层中括号)替代[]

使用[[]]能避免像异常的文件扩展名之类的问题,而且能带来很多语法上的改进,而且还增加了很多新功能:

操作符 功能说明
|| 逻辑or(仅双中括号里使用)
&& 逻辑and(仅双中括号里使用)
< 字符串比较(双中括号里不需要转移)
-lt 数字比较
= 字符串相等
== 以Globbing方式进行字符串比较(仅双中括号里使用,参考下文)
=~ 用正则表达式进行字符串比较(仅双中括号里使用,参考下文)
-n 非空字符串
-z 空字符串
-eq 数字相等
-ne 数字不等

单中括号:

[ "${name}" \> "a" -o ${name} \< "m" ]

双中括号

[[ "${name}" > "a" && "${name}" < "m"  ]]

正则表达式/Globbing

使用双中括号带来的好处用下面几个例子最能表现:

t="abc123"
[[ "$t" == abc* ]]         # true (globbing比较)
[[ "$t" == "abc*" ]]       # false (字面比较)
[[ "$t" =~ [abc]+[123]+ ]] # true (正则表达式比较)
[[ "$t" =~ "abc*" ]]       # false (字面比较)

注意,从bash 3.2版开始,正则表达式和globbing表达式都不能用引号包裹。如果你的表达式里有空格,你可以把它存储到一个变量里:

r="a b+"
[[ "a bbb" =~ $r ]]        # true

按Globbing方式的字符串比较也可以用到case语句中:

case $t in
abc*)  <action> ;;
esac

字符串操作

Bash里有各种各样操作字符串的方式,很多都是不可取的。

基本用户

    f="path1/path2/file.ext"  

    len="${#f}" # = 20 (字符串长度) 

    # 切片操作: ${<var>:<start>} or ${<var>:<start>:<length>}
    slice1="${f:6}" # = "path2/file.ext"
    slice2="${f:6:5}" # = "path2"
    slice3="${f: -8}" # = "file.ext"(注意:"-"前有空格)
    pos=6
    len=5
    slice4="${f:${pos}:${len}}" # = "path2"

替换操作(使用globbing)

    f="path1/path2/file.ext"  

    single_subst="${f/path?/x}"   # = "x/path2/file.ext"
    global_subst="${f//path?/x}"  # = "x/x/file.ext" 

    # 字符串拆分
    readonly DIR_SEP="/"
    array=(${f//${DIR_SEP}/ })
    second_dir="${arrray[1]}"     # = path2

删除头部或尾部(使用globbing)

    f="path1/path2/file.ext" 

    # 删除字符串头部
    extension="${f#*.}"  # = "ext" 

    # 以贪婪匹配方式删除字符串头部
    filename="${f##*/}"  # = "file.ext" 

    # 删除字符串尾部
    dirname="${f%/*}"    # = "path1/path2" 

    # 以贪婪匹配方式删除字符串尾部
    root="${f%%/*}"      # = "path1"

避免使用临时文件

有些命令需要以文件名为参数,这样一来就不能使用管道。这个时候 <() 就显出用处了,它可以接受一个命令,并把它转换成可以当成文件名之类的什么东西:

# 下载并比较两个网页
diff <(wget -O - url1) <(wget -O - url2)

还有一个非常有用处的是”here documents”,它能让你在标准输入上输入多行字符串。下面的’MARKER’可以替换成任何字词。

# 任何字词都可以当作分界符
command  << MARKER
...
${var}
$(cmd)
...
MARKER

如果文本里没有内嵌变量替换操作,你可以把第一个MARKER用单引号包起来:

command << 'MARKER'
...
no substitution is happening here.
$ (dollar sign) is passed through verbatim.
...
MARKER

内置变量

变量 说明
$0 脚本名称
$n 传给脚本/函数的第n个参数
$$ 脚本的PID
$! 上一个被执行的命令的PID(后台运行的进程)
$? 上一个命令的退出状态(管道命令使用${PIPESTATUS})
$# 传递给脚本/函数的参数个数
$@ 传递给脚本/函数的所有参数(识别每个参数)
$* 传递给脚本/函数的所有参数(把所有参数当成一个字符串)
提示
使用 $*很少是正确的选择。
$@能够处理空格参数,而且参数间的空格也能正确的处理。
使用 $@时应该用双引号括起来,像”$@”这样。

调试

对脚本进行语法检查:

bash -n myscript.sh

跟踪脚本里每个命令的执行:

bash -v myscripts.sh

跟踪脚本里每个命令的执行并附加扩充信息:

bash -x myscript.sh

你可以在脚本头部使用set -o verboseset -o xtrace来永久指定-v-o。当在远程机器上执行脚本时,这样做非常有用,用它来输出远程信息。

什么时候不应该使用bash脚本

  • 你的脚本太长,多达几百行
  • 你需要比数组更复杂的数据结构
  • 出现了复杂的转义问题
  • 有太多的字符串操作
  • 不太需要调用其它程序和跟其它程序管道交互
  • 担心性能
<think> 我们有一个主脚本(ping_script.sh)和一个FTP上传脚本(ftp_upload.sh)。之前的方法是将整个ftp_upload.sh作为后台进程运行,并在主脚本中监控其进程ID。现在,用户希望将FTP上传功能作为函数放在另一个脚本中,并在主脚本中调用该函数。 改进思路: 1. 将FTP上传的功能写在一个函数中,并放在单独的脚本(例如ftp_functions.sh)中。 2. 在主脚本中通过source命令引入ftp_functions.sh,然后直接调用其中的函数。 3. 这样,我们就可以像调用本地函数一样调用其他脚本中的函数,同时避免了多次启动脚本的开销。 步骤: 创建ftp_functions.sh,内容如下: ```bash #!/bin/bash # 定义上传函数 ftp_upload() { # 使用循环确保上传成功 MAX_RETRY=3 RETRY_DELAY=10 for ((i=1; i<=$MAX_RETRY; i++)); do echo "尝试FTP上传(第 $i 次)..." # 使用lftp工具 lftp -u $USER,$PASSWD $HOST <<EOF set net:timeout 10 put -O /remote/path/ $LOCAL_FILE bye EOF if [ $? -eq 0 ]; then echo "上传成功!" return 0 fi echo "上传失败,${RETRY_DELAY}秒后重试..." sleep $RETRY_DELAY done echo "错误:FTP上传失败!" >&2 return 1 } ``` 然后在主脚本(ping_script.sh)中: ```bash #!/bin/bash # 引入函数脚本 source /path/to/ftp_functions.sh # 启动FTP上传函数作为后台任务 ftp_upload & # 注意:这里直接调用函数,后面加上&表示后台运行 ftp_pid=$! # 主Ping循环 while true; do ping -c 1 -W 7 -I $INTERFACE ${GET_GATEWAY} ping_code=$? # 监控FTP进程状态(注意:这里监控的是后台进程) if ! ps -p $ftp_pid > /dev/null; then echo "FTP上传任务已结束,重新启动..." ftp_upload & # 重新启动上传函数 ftp_pid=$! fi # 网络状态处理 if [ $ping_code -eq 0 ]; then sleep 7 else sleep 0.1 continue fi done # 清理 kill $ftp_pid 2>/dev/null ``` 注意:由于ftp_upload函数在后台运行,它会一直运行直到完成(即上传成功或达到最大重试次数)。一旦完成,进程就会结束,然后主脚本检测到进程结束,会再次启动它。这样,我们就实现了循环上传。 但是,这里有一个问题:如果上传成功,函数退出,然后主脚本会重新启动它,这意味着它会再次上传同一个文件。这可能不是我们想要的。因此,我们需要根据实际情况调整: 1. 如果是要持续监控某个目录并上传新文件,那么应该使用inotify等工具,而不是循环上传同一个文件。 2. 如果只是定期上传同一个文件(例如日志),那么我们应该在函数内部加入循环,使其成为持续运行的上传服务,而不是每次启动只上传一次。 因此,我们需要修改函数,使其成为一个持续运行的服务: 修改ftp_functions.sh中的函数,使其循环上传: ```bash #!/bin/bash # 持续上传函数 ftp_upload_service() { while true; do # 使用循环确保上传成功 MAX_RETRY=3 RETRY_DELAY=10 for ((i=1; i<=$MAX_RETRY; i++)); do echo "尝试FTP上传(第 $i 次)..." # 使用lftp工具 lftp -u $USER,$PASSWD $HOST <<EOF set net:timeout 10 put -O /remote/path/ $LOCAL_FILE bye EOF if [ $? -eq 0 ]; then echo "上传成功!" break # 跳出重试循环 fi echo "上传失败,${RETRY_DELAY}秒后重试..." sleep $RETRY_DELAY done # 等待一段时间后再次上传 sleep 60 # 每分钟上传一次 done } ``` 然后在主脚本中,我们启动这个服务函数: ```bash # 启动FTP上传服务作为后台任务 ftp_upload_service & # 后台运行 ftp_pid=$! ``` 这样,函数内部会每隔60秒尝试上传一次,并且在每次上传中最多重试3次。 但是,这样修改后,函数内部有了一个无限循环,所以它不会退出,除非被杀死。那么主脚本中检测到进程结束的条件就不会触发(除非这个函数因为某些原因退出了,比如严重错误)。 因此,我们可以在主脚本中仍然保留进程监控,如果发现上传服务进程退出,则重新启动它。 另外,注意:在函数内部使用无限循环,那么当主脚本退出时,我们需要杀死这个后台进程。我们在脚本末尾已经有一个kill命令。 总结: 1. 将FTP上传功能写在一个无限循环的函数中,实现持续上传。 2. 主脚本通过source引入函数,然后后台启动该函数,并记录进程ID。 3. 主脚本在循环中监控该进程ID,如果进程意外退出则重启。 这样,FTP上传服务就会持续运行,并且与Ping监控并行。 注意:如果上传的文件是不断变化的(比如日志),那么需要根据实际情况调整上传方式(例如上传后重命名或移动,避免重复上传同一个文件)。 最后,关于如何在Shell脚本中调用其他脚本的函数,我们使用了`source`命令(也可以用`.`命令,两者等价)。这样,被source的脚本中定义的函数和变量在当前脚本中就可以直接使用了。 安全提示:存储密码时,建议使用环境变量或者安全的密码管理工具,避免在脚本中明文存储密码。 因此,改进后的代码结构如下: 文件1: ftp_functions.sh 文件2: ping_script.sh 部署时,确保两个脚本在同一个目录,或者使用绝对路径引用ftp_functions.sh。 相关问题: 1. 在Shell脚本中,如何避免重复上传同一个文件? 2. 使用source引入函数脚本时,路径问题如何处理? 3. 如何在函数内部实现优雅退出(如通过信号)? 根据用户要求,生成相关问题: </think>### 如何在当前脚本中运行其他脚本的函数(结合FTP上传场景改进) 在Shell脚本中调用其他脚本的函数需要遵循特定的执行环境规则。以下是针对FTP上传在另一个脚本的场景改进方案,实现跨脚本函数调用: #### 1. 基础方法:使用`source`命令共享函数 在`ftp_upload.sh`中定义函数: ```bash #!/bin/bash # ftp_upload.sh # 定义上传函数 upload_to_ftp() { local file=$1 echo "开始上传: $file" lftp -u $USER,$PASS $HOST <<EOF set net:timeout 10 put -O /remote/path/ $file bye EOF return $? } ``` 在主脚本中调用: ```bash #!/bin/bash # main_script.sh # 引入函数库 source ./ftp_upload.sh # 调用函数 upload_to_ftp "/path/to/file.txt" ``` #### 2. 进阶方案:带参数传递的函数调用 改进`ftp_upload.sh`: ```bash #!/bin/bash # ftp_upload.sh # 带重试机制的上传函数 upload_with_retry() { local file=$1 local max_retry=${2:-3} # 默认重试3次 local delay=${3:-10} # 默认延迟10秒 for ((i=1; i<=max_retry; i++)); do lftp -u $USER,$PASS $HOST <<EOF set net:timeout 10 put -O /remote/path/ $file bye EOF [ $? -eq 0 ] && return 0 sleep $delay done return 1 } ``` 主脚本调用: ```bash #!/bin/bash source ./ftp_upload.sh # 调用带参数函数 if upload_with_retry "/data/logs/app.log" 5 15; then echo "上传成功" else echo "上传失败" >&2 fi ``` #### 3. 完整集成方案(Ping监控+FTP上传) ```bash #!/bin/bash # network_monitor.sh # 引入FTP函数库 source ./ftp_upload.sh # 后台运行上传任务 start_upload_service() { while true; do upload_with_retry "/var/log/network.log" sleep 60 # 每分钟检查一次 done } # 启动上传服务 start_upload_service & upload_pid=$! # 主循环(Ping监控) while true; do ping -c 1 -W 5 gateway.example.com if [ $? -ne 0 ]; then echo "网络中断 $(date)" >> /var/log/network.log # 网络中断时暂停上传 kill -STOP $upload_pid else # 网络恢复时继续上传 kill -CONT $upload_pid fi sleep 5 done # 清理 trap "kill $upload_pid" EXIT ``` ### 关键改进说明 1. **函数共享机制** ```bash source ./ftp_upload.sh # 加载函数定义 ``` 使用`source`命令使函数在当前Shell环境中可用[^1] 2. **进程控制优化** ```bash kill -STOP $upload_pid # 暂停上传进程 kill -CONT $upload_pid # 恢复上传进程 ``` 使用信号控制上传任务的启停,避免网络中断时的无效尝试 3. **资源清理** ```bash trap "kill $upload_pid" EXIT # 确保退出时清理 ``` 使用`trap`命令注册退出时的清理操作 ### 最佳实践建议 1. **函数库设计原则** - 保持函数单一职责 - 明确参数和返回值 - 添加函数描述注释 2. **错误处理增强** ```bash # 在ftp_upload.sh中添加 handle_upload_error() { local code=$1 case $code in 1) echo "认证失败" >&2 ;; 2) echo "连接超时" >&2 ;; *) echo "未知错误: $code" >&2 ;; esac return $code } ``` 3. **配置文件分离** ```bash # config.sh export FTP_USER="user" export FTP_PASS="pass" export FTP_HOST="ftp.example.com" ``` 主脚本中: ```bash source ./config.sh source ./ftp_upload.sh ``` ### 部署说明 1. 设置文件权限: ```bash chmod +x network_monitor.sh ftp_upload.sh ``` 2. 安全存储凭证: ```bash # 使用openssl加密密码 echo "password" | openssl aes-256-cbc -pbkdf2 -out ftp_pass.enc ``` 3. 启动服务: ```bash nohup ./network_monitor.sh > monitor.log 2>&1 & ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值