詳解shell腳本的編寫規(guī)范
編寫shell腳本的一些規(guī)范
解釋器
shell腳本一般選擇bash作為解釋器,腳本開頭應(yīng)為
#!/bin/bash 或 #!/bin/sh
添加腳本版本和注釋功能
在腳本的開頭加注釋,說明腳本作者、編寫時間、腳本功能,最好可以加上腳本的版本號。shell中腳本注釋用#
,注釋語句和#
號之間有一個空格
#!/bin/bash # 腳本版本 # 腳本作者 # 腳本時間 # 腳本功能
添加腳本調(diào)試
通過set
命令添加腳本調(diào)試,如果報錯,腳本直接退出,不繼續(xù)執(zhí)行,對于管道錯誤也可以直接退出
#!/bin/bash # 腳本版本 # 腳本作者 # 腳本時間 # 腳本功能 set -e set -o pipfail
變量命名
變量命名要統(tǒng)一規(guī)范,shell變量建議使用全部大寫,意思清晰明了,如果是多個字符,可以采用下劃線進行切割,如APACHE_LOG_PATH
,對于變量的引用可以直接使用$
,如果有下劃線分區(qū)的變量,建議使用${APACHE_LOG_PATH}
。
全局變量和局部變量
全局變量可以采用前面時候的定義方式,如果是函數(shù)中的局部變量,建議使用local
進行變量聲明。這個防止全局變量和局部變量混淆,局部變量可以采用小寫,用來區(qū)分局部變量和全局變量。
function TestFunc(){ local name='xiaolangjun' echo ${name} }
如果存在變量合并的情況,比如目錄和文件名合并,這樣可以重新賦值成一個新的變量,這樣方便以后調(diào)用。
命名規(guī)范
函數(shù)命名
函數(shù)命名一般單詞的首字母大寫,比如GetInformation
,意思清晰。
- 獲取最大值或最小值時后綴使用
Max
、Min
- 獲取信息或者返回值的函數(shù)可以使用
Get
作為前綴 - 判斷函數(shù)可以使用
Is
作為前綴
腳本命名
腳本命名,根據(jù)腳本功能進行命名,后綴為.sh
,如果在腳本運行過程中產(chǎn)生一些臨時文件,建議采用PID為后綴,如果腳本運行完成,這個文件沒有用途,則自動進行刪除。
PID=$$ TMP_FILE="ip_list".${PID}
函數(shù)
- 函數(shù)定義,建議添加
function
關(guān)鍵字 - 函數(shù)中縮進可以使用4個空格
- 函數(shù)中使用判斷或者循環(huán)語句,使用統(tǒng)一風(fēng)格,不要有的換行,有的不換行
- 多管道語句,建議可以進行拆分,增加可讀性,可以將通用部分提取
- 使用
&&
或||
可以簡化判斷語句,語義更加清晰
引用模塊或文件
引用腳本或者模塊文件時,添加注釋,簡要說明模塊的主要功能和作用,使用.
或者source
腳本日志
腳本中建議添加日志函數(shù),這樣方便腳本調(diào)試,腳本運行中各函數(shù)的輸出和狀態(tài),日志文件中包括時間-日志級別-函數(shù),日志創(chuàng)建log目錄,有常規(guī)的log和錯誤log。
配置文件
在工程目錄下創(chuàng)建conf目錄,配置文件以.conf為后綴,配置字段要風(fēng)格統(tǒng)一,每個配置提供相關(guān)配置注釋
其他
- 腳本中路徑變量,建議使用絕對路徑,最后面不要使用/結(jié)尾,例如:
LOG_DIR="/var/log"
- 如果腳本中有重要文件拷貝,建議使用md5進行一致性檢查,尤其是遠程拷貝
到此這篇關(guān)于編寫shell腳本的規(guī)范的文章就介紹到這了,更多相關(guān)shell腳本編寫規(guī)范內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Linux 在Bash腳本中怎么關(guān)閉文件描述符的實例
這篇文章主要介紹了Linux 在Bash腳本中怎么關(guān)閉文件描述符的實例的相關(guān)資料,希望通過本文能幫助到大家實現(xiàn)這樣的功能,需要的朋友可以參考下2017-09-09Shell腳本實現(xiàn)硬盤空間和表空間的使用情況統(tǒng)計并郵件通知
這篇文章主要介紹了Shell腳本實現(xiàn)硬盤空間和表空間的使用情況統(tǒng)計并郵件通知,其中表空間是指oracle數(shù)據(jù)庫里的表空間,需要的朋友可以參考下2014-12-12shell實現(xiàn)自動備份mysql、整站數(shù)據(jù)的兩個腳本分享
這篇文章主要介紹了shell實現(xiàn)自動備份mysql、整站數(shù)據(jù)的兩個腳本分享,使用了cron實現(xiàn)實現(xiàn)定時備份,并會自動刪除N天前的備份,以及自動FTP上傳到別的服務(wù)器,需要的朋友可以參考下2014-06-06Linux bash刪除文件中含“指定內(nèi)容”的行功能示例
這篇文章主要介紹了Linux bash刪除文件中含“指定內(nèi)容”的行功能,結(jié)合具體實例形式分析了Linux bash刪除文件指定內(nèi)容的實現(xiàn)原理與相關(guān)操作技巧,需要的朋友可以參考下2017-06-06