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

解釋器

shell腳本一般選擇bash作為解釋器，腳本開(kāi)頭應(yīng)為

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

添加腳本版本和注釋功能

在腳本的開(kāi)頭加注釋?zhuān)f(shuō)明腳本作者、編寫(xiě)時(shí)間、腳本功能，最好可以加上腳本的版本號(hào)。shell中腳本注釋用#，注釋語(yǔ)句和#號(hào)之間有一個(gè)空格

#!/bin/bash

# 腳本版本
# 腳本作者
# 腳本時(shí)間
# 腳本功能

添加腳本調(diào)試

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

#!/bin/bash

# 腳本版本
# 腳本作者
# 腳本時(shí)間
# 腳本功能

set -e 
set -o pipfail

變量命名

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

全局變量和局部變量

全局變量可以采用前面時(shí)候的定義方式，如果是函數(shù)中的局部變量，建議使用local進(jìn)行變量聲明。這個(gè)防止全局變量和局部變量混淆，局部變量可以采用小寫(xiě)，用來(lái)區(qū)分局部變量和全局變量。

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

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

命名規(guī)范

函數(shù)命名

函數(shù)命名一般單詞的首字母大寫(xiě)，比如GetInformation，意思清晰。

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

腳本命名

腳本命名，根據(jù)腳本功能進(jìn)行命名，后綴為.sh，如果在腳本運(yùn)行過(guò)程中產(chǎn)生一些臨時(shí)文件，建議采用PID為后綴，如果腳本運(yùn)行完成，這個(gè)文件沒(méi)有用途，則自動(dòng)進(jìn)行刪除。

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

函數(shù)

• 函數(shù)定義，建議添加function關(guān)鍵字
• 函數(shù)中縮進(jìn)可以使用4個(gè)空格
• 函數(shù)中使用判斷或者循環(huán)語(yǔ)句，使用統(tǒng)一風(fēng)格，不要有的換行，有的不換行
• 多管道語(yǔ)句，建議可以進(jìn)行拆分，增加可讀性，可以將通用部分提取
• 使用 && 或 || 可以簡(jiǎn)化判斷語(yǔ)句，語(yǔ)義更加清晰

引用模塊或文件

引用腳本或者模塊文件時(shí)，添加注釋?zhuān)?jiǎn)要說(shuō)明模塊的主要功能和作用，使用.或者source

腳本日志

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

配置文件

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

其他

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

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

最新評(píng)論