shell编程最佳实践

1. 文件开头注明所用shell及文件头信息

#!/bin/bash
#------------------------------------------------------------------------------------------
# Copyright (C), 1996-2020, 6666 Tech. Co., Ltd.
# File name     : xxxx.sh
# Author        : triagen
# Version       : 1.00
# Date          : 2020/11/20
# Description   : xxxx
# Others        : NA
# Function List :
# History       :
#       1.  Date         : 2020-11-17
#           Author       : triagen
#           Modification : 1) new script
#------------------------------------------------------------------------------------------

2. 第一行代码

#判断文件路径里有没有目录，有则进入目录再执行，如果脚本文件通过相对路径引用其他文件，不进入脚本所在目录会导致引用出错
if [ `echo "$0" |grep -c "/"` -gt 0 ];then
    cd ${0%/*}
fi

字符串截取补充

格式	说明
${string: start :length}	从 string 字符串的左边第 start 个字符开始，向右截取 length 个字符。
${string: start}	从 string 字符串的左边第 start 个字符开始截取，直到最后。
${string: 0-start :length}	从 string 字符串的右边第 start 个字符开始，向右截取 length 个字符。
${string: 0-start}	从 string 字符串的右边第 start 个字符开始截取，直到最后。
${string#*chars}	从 string 字符串第一次出现 *chars 的位置开始，截取 *chars 右边的所有字符。
${string##*chars}	从 string 字符串最后一次出现 *chars 的位置开始，截取 *chars 右边的所有字符。
${string%*chars}	从 string 字符串第一次出现 *chars 的位置开始，截取 *chars 左边的所有字符。
${string%%*chars}	从 string 字符串最后一次出现 *chars 的位置开始，截取 *chars 左边的所有字符。

3. 函数

#------------------------------------------------------------------------------------------
# Function       : LOG
# Description    : 日志记录
# Calls          : ALL
# Data Updated   : NA
# Input          :
#                  @1 logfile 
#                  @2 log level
#                  @3 module name
#                  @4 line num
#                  @5 log info
# Return         : 0:success
#                  >0:fail
# Others         : NA
#------------------------------------------------------------------------------------------
LOG()
{
    echo `date "+%Y-%m-%d %H:%M:%S"` "$3:$4 : $2 : $5"
    echo `date "+%Y-%m-%d %H:%M:%S"` "$3:$4 : $2 : $5" >> $1
}

4. if语句

SCRIPT_NAME=$(basename $0)

SUFFIX_DATETIME=`date +'%Y%m%d%H%M%S'`
LOG_PATH="xxxx/log/"
LOG_FILENAME="xxxx_${SUFFIX_DATETIME}.log"
LOG_FILE=""

#------------------------------------------------------------------------------------------
# Function       : set_log_file
# Description    : 设置日志文件
# Calls          : NA
# Data Updated   : NA
# Input          : NA
# Return         : 0:success
#                  >0:Failed
# Others         : NA
#------------------------------------------------------------------------------------------
set_log_file()
{
    LOG_FILE="${LOG_PATH}/${LOG_FILENAME}"
    if [ ! -d ${LOG_PATH} ];then
        mkdir -p ${LOG_PATH}
        chmod -R 750 ${LOG_PATH}
        chown ${USER}: ${LOG_PATH}
    fi

    if [ ! -f ${LOG_FILE} ];then
        touch ${LOG_FILE}
        chown ${USER}: ${LOG_FILE}
        chmod 640 ${LOG_FILE}
    fi

    LOG "${LOG_FILE}" "Info" "${SCRIPT_NAME}" "${LINENO}" "Log file is ${LOG_FILE}."

}

if补充

运算符	描述	示例
-d path	如果 path 存在且为目录，则为真	[ -d /tmp/test ]
-e path	如果 path存在，则为真	[ -d /tmp/test ] [ -f /usr/bin/grep ]
-f path	如果 path存在且为常规文件，则为真	[ -f /usr/bin/grep ]
-z string	如果string为空或者为空白字符串，则为真	[ -z "${myvar}" ]
string1 = string2	如果字符串相等，则为真	[ "X${myvar}" = "Xtest" ]
string1 != string2	如果字符串不相等，则为真	[ "X${myvar}" != "Xtest" ]
num1 -eq num2	等于	[ 3 -eq $mynum ]
num1 -ne num2	不等于	[ 3 -ne $mynum ]
num1 -lt num2	小于	[ 3 -lt $mynum ]
num1 -le num2	小于或等于	[ 3 -le $mynum ]
num1 -gt num2	大于	[ 3 -gt $mynum ]
num1 -ge num2	大于或等于	[ 3 -ge $mynum ]

最佳实践：字符串变量参与判断时，一定要用 "" 引起来，否则如果字符串变量带有空格，可能会出现 binary operator expected 这种错误，导致判断未能按预期执行

5.命令行与管道参数获取

#------------------------------------------------------------------------------------------
# Function       : parse_parameter
# Description    : 解析命令行参数
# Calls          : NA
# Data Updated   : NA
# Input          : NA
# Return         : 0:success
#                  >0:Failed
# Others         : NA
#------------------------------------------------------------------------------------------
parse_parameter()
{
    LOG "${LOG_FILE}" "Info" "${SCRIPT_NAME}" "${LINENO}" "Parse parameter begin..."
    LOG "${LOG_FILE}" "Info" "${SCRIPT_NAME}" "${LINENO}" "Parameter is $*"

    GETOPT_ARGS=`getopt -o '' --long name:,cmd: -- "$@"`
    eval set -- "$GETOPT_ARGS"

    while [ -n "$1" ]
    do
        case "$1" in
            --name) name=$2;shift 2;;
            --cmd) cmd=$2;shift 2;;
            --) break ;;
        esac
    done
}

#------------------------------------------------------------------------------------------
# Function       : parse_pipe_info
# Description    : 解析管道参数格式
# Calls          : NA
# Data Updated   : NA
# Input          : NA
# Return         : 0:success
#                  >0:Failed
# Others         : NA
#------------------------------------------------------------------------------------------
parse_pipe_info()
{
    LOG "${LOG_FILE}" "Info" "${SCRIPT_NAME}" "${LINENO}" "Parse pipe info begin..."

    read -t 3 pipeInfo
}

# 调用方式
echo "testPipe" | sh xxxx.sh --name testCmd --cmd test