Shell高效编程-脚本维护优化

我们在平常工作中，你是否感觉shell脚本只是命令的堆砌；很多时候只是为了实现功能而没有好的组织结构；自己的脚本都不想再看一遍；此让你的shell脚本有python一样的美感并且极易维护，真的是shell脚本写到停不下来。

现以nginx控制脚本为例，看一下脚本的优化过程：

#!/bin/bash
# set命令的奇妙用途留在文章末尾
set -eu
# nginx重载配置文件
nginx -c /etc/nginx/nginx.conf -t
kill -HUP `ps auxf | grep -E "nginx:[[:space:]]+master"| awk '{print $2}'`

变量抽离

在脚本中，需要依赖外部的配置，比如配置文件位置，监听端口之类的可变参数，编程时，需要将其抽离为变量，为了更好的引用与维护，省去了外部配置变化时，一个个修改带来的麻烦。

#!/bin/bash
# set命令的奇妙用途留在文章末尾set -eu
# nginx配置文件在不同环境中，位置可能不同，所以需要将其抽离成可配置变量，脚本来引用NGINX_CONFIG_FILE=/etc/nginx/nginx.conf
# nginx重载配置文件
nginx -c $NGINX_CONFIG_FILE -tkill -HUP `ps auxf | grep -E "nginx:[[:space:]]+master"| awk '{print $2}'`

模块化

运维毕竟不是专业程序员，写脚本时是怎么舒服怎么来，简单讲就是从上到下依次执行，这就导致复用性差，不易维护，解决这问题的关键在于函数化、模块化思想，shell虽然是一种比较简单的语言，但语言基本的逻辑控制、函数功能都有，这就让我们编写高质量shell脚本带了无限可能。接下来就看一下具体例子来感受一下：

# 由于nginx配置文件检查是执行其他操作的第一步，所以我们将其独立成一个单独函数
#!/bin/bash# set命令的奇妙用途留在文章末尾
set -eu
# nginx配置文件在不同环境中，位置可能不同，所以需要将其抽离成可配置变量，脚本来引用NGINX_CONFIG_FILE=/etc/nginx/nginx.conf
# 抽离配置文件检查为单独的函数
config_test() {
    nginx -c $NGINX_CONFIG_FILE -t
}
get_nginx_master_pid(){
    echo `ps auxf | grep -E "nginx:[[:space:]]+master"| awk '{print $2}'`
}
# 抽离配置重载为独立函数
reload() {
    kill -HUP `get_nginx_master_pid`
}
# nginx重载配置文件
config_test
reload

main函数

脚本的可维护性在于脚本的结构的好坏，为了拥有更好的结构，通常需要在脚本中定义入口函数，即main函数，让我在维护脚本时，可以更好的把握脚本的组织架构，找到切入点：

# 由于nginx配置文件检查是执行其他操作的第一步，所以我们将其独立成一个单独函数
#!/bin/bash
# set命令的奇妙用途留在文章末尾
set -eu
# nginx配置文件在不同环境中，位置可能不同，所以需要将其抽离成可配置变量，脚本来引用NGINX_CONFIG_FILE=/etc/nginx/nginx.conf
# 抽离配置文件为单独的函数
config_test() {
    nginx -c $NGINX_CONFIG_FILE -t
}
get_nginx_master_pid(){
    echo `ps auxf | grep -E "nginx:[[:space:]]+master"| awk '{print $2}'`
}
# 抽离配置重载为独立函数
reload() {
    kill -HUP `get_nginx_master_pid`
}
# 入口函数
main() {    
      config_test    
      reload
}
# main在此需要获取脚本本身的参数， 故将$@传递给main函数
main $@

函数返回值

在其他编程语言，可以通过return获得函数的返回值，但是return语句在shell中含义不同，return命令会使一个函数返回,会返回一个单一的数字参数,而这个数字参数在调用这个函数的脚本是可见的,如果没有指定返回参数,return在默认情况下会返回上一次命令的返回代码。那如何实现类似其他编程语言的return效果呢？可以使用echo命令:

#!/bin/bash
set -eu
NGINX_CONFIG_FILE=/etc/nginx/nginx.conf

config_test() {    
         nginx -c $NGINX_CONFIG_FILE -t
}
# 在此处直接把nginx的master pid可以通过反引号来获取echo后的值
get_nginx_master_pid(){    
        echo `ps auxf | grep -E "nginx:[[:space:]]+master"| awk '{print $2}'`
}
reload() {    
# `get_nginx_master_pid` 获得nginx master pid    
         kill -HUP `get_nginx_master_pid`
}


# 入口函数
main() {
    config_test    
    reload}
# main在此需要获取脚本本身的参数， 故将$@传递给main函数
main $@

set命令

bash内置的set命令，可以改变我们脚本的执行行为，让我对脚本的把握和调试更有力，下面说几种常用的set指令，相信你都会喜欢的：

set -e: bash脚本遇到错误立即退出
set -n: 检查脚本语法但不执行
set -u: 遇到未设置的变量立即退出
set -o pipefail: 控制在管道符执行过程中有错误立即退出
set -x: 分步调试命令

在写脚本时，我们可以直接在脚本开头简写为如下格式:

#!/bin/bashset -euxo pipefail

检查bash脚本的语法时，可以这样写:

bash -n main.sh