編寫shell腳本的一些規(guī)范

解釋器

shell腳本一般選擇bash作為解釋器，腳本開頭應為

#!/bin/bash
或
#!/bin/sh

添加腳本版本和注釋功能

在腳本的開頭加注釋，說明腳本作者、編寫時間、腳本功能，最好可以加上腳本的版本號。shell中腳本注釋用#，注釋語句和#號之間有一個空格

#!/bin/bash

# 腳本版本
# 腳本作者
# 腳本時間
# 腳本功能

添加腳本調試

通過set命令添加腳本調試，如果報錯，腳本直接退出，不繼續(xù)執(zhí)行，對于管道錯誤也可以直接退出

#!/bin/bash

# 腳本版本
# 腳本作者
# 腳本時間
# 腳本功能

set -e 
set -o pipfail

變量命名

變量命名要統一規(guī)范，shell變量建議使用全部大寫，意思清晰明了，如果是多個字符，可以采用下劃線進行切割，如APACHE_LOG_PATH，對于變量的引用可以直接使用$，如果有下劃線分區(qū)的變量，建議使用${APACHE_LOG_PATH}。

全局變量和局部變量

全局變量可以采用前面時候的定義方式，如果是函數中的局部變量，建議使用local進行變量聲明。這個防止全局變量和局部變量混淆，局部變量可以采用小寫，用來區(qū)分局部變量和全局變量。

function TestFunc(){
	local name='xiaolangjun'
	echo ${name}
}

如果存在變量合并的情況，比如目錄和文件名合并，這樣可以重新賦值成一個新的變量，這樣方便以后調用。

命名規(guī)范

函數命名

函數命名一般單詞的首字母大寫，比如GetInformation，意思清晰。

• 獲取最大值或最小值時后綴使用Max、Min
• 獲取信息或者返回值的函數可以使用Get作為前綴
• 判斷函數可以使用Is作為前綴

腳本命名

腳本命名，根據腳本功能進行命名，后綴為.sh，如果在腳本運行過程中產生一些臨時文件，建議采用PID為后綴，如果腳本運行完成，這個文件沒有用途，則自動進行刪除。

PID=$$
TMP_FILE="ip_list".${PID}

函數

• 函數定義，建議添加function關鍵字
• 函數中縮進可以使用4個空格
• 函數中使用判斷或者循環(huán)語句，使用統一風格，不要有的換行，有的不換行
• 多管道語句，建議可以進行拆分，增加可讀性，可以將通用部分提取
• 使用 && 或 || 可以簡化判斷語句，語義更加清晰

引用模塊或文件

引用腳本或者模塊文件時，添加注釋，簡要說明模塊的主要功能和作用，使用.或者source

腳本日志

腳本中建議添加日志函數，這樣方便腳本調試，腳本運行中各函數的輸出和狀態(tài)，日志文件中包括時間-日志級別-函數，日志創(chuàng)建log目錄，有常規(guī)的log和錯誤log。

配置文件

在工程目錄下創(chuàng)建conf目錄，配置文件以.conf為后綴，配置字段要風格統一，每個配置提供相關配置注釋

其他

• 腳本中路徑變量，建議使用絕對路徑，最后面不要使用/結尾，例如：LOG_DIR="/var/log"
• 如果腳本中有重要文件拷貝，建議使用md5進行一致性檢查，尤其是遠程拷貝

到此這篇關于編寫shell腳本的規(guī)范的文章就介紹到這了,更多相關shell腳本編寫規(guī)范內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論