當前位置:編程學習大全網 - 編程語言 - Linux Shell 腳本編程最佳實踐

Linux Shell 腳本編程最佳實踐

IT路邊社

前言

與其它的編碼規範壹樣,這裏所討論的不僅僅是編碼格式美不美觀的問題, 同時也討論壹些約定及編碼標準。這份文檔主要側重於我們所普遍遵循的規則,對於那些不是明確強制要求的,我們盡量避免提供意見。

編碼規範對於程序員而言尤為重要,有以下幾個原因:

本文檔中的準則致力於最大限度達到以下原則:

盡管本文檔涵蓋了許多基礎知識,但應註意的是,沒有編碼規範可以為我們回答所有問題,開發人員始終需要再編寫完代碼後,對上述原則做出正確的判斷。

:未明確指明的則默認為必須(Mandatory)

主要參考如下文檔:

僅建議Shell用作相對簡單的實用工具或者包裝腳本。因此單個shell腳本內容不宜太過復雜。

在選擇何時使用shell腳本時時應遵循以下原則:

可執行文件不建議有擴展名,庫文件必須使用 .sh 作為擴展名,且應是不可執行的。

執行壹個程序時,無需知道其編寫語言,且shell腳本並不要求具有擴展名,所以更傾向可執行文件沒有擴展名。

而庫文件知道其編寫語言十分重要,使用 .sh 作為特定語言後綴的擴展名,可以和其他語言編寫的庫文件加以區分。

文件名要求全部小寫, 可以包含下劃線 _ 或連字符 - , 建議可執行文件使用連字符,庫文件使用下劃線。

正例:

反例:

源文件編碼格式為UTF-8。避免不同操作系統對文件換行處理的方式不同,壹律使用 LF 。

每行最多不超過120個字符。每行代碼最大長度限制的根本原因是過長的行會導致閱讀障礙,使得縮進失效。

除了以下兩種情況例外:

如出現長度必須超過120個字符的字符串,應盡量使用here document或者嵌入的換行符等合適的方法使其變短。

示例:

除了在行結束使用換行符,空格是源文件中唯壹允許出現的空白字符。

對從來沒有用到的或者被註釋的方法、變量等要堅決從代碼中清理出去,避免過多垃圾造成幹擾。

Bash 是唯壹被允許使用的可執行腳本shell。

可執行文件必須以 #!/bin/bash 開始。請使用 set 來設置shell的選項,使得用 bash echo "Process $: Done making $$$."

# 示例7:命令參數及路徑不需要引號 grep -li Hugo /dev/ "$1"

# 示例8:常規變量用雙引號,ccs可能為空的特殊情況可不用引號 git send-email --to "${reviewers}" ${ccs:+"--cc" "${ccs}"}

# 示例9:正則用單引號,$1可能為空的特殊情況可不用引號 grep -cP '([Ss]pecial||?characters*) ${1:+"$1"}

# 示例10:位置參數傳遞推薦帶引號的"$@",所有參數作為單字符串傳遞用帶引號的"$*" # content of t.sh func_t { echo num: $# echo args: 1:$1 2:$2 3:$3 }

func_t "$@" func_t "$*" # 當執行 ./t.sh a b c 時輸出如下: num: 3 args: 1:a 2:b 3:c num: 1 args: 1:a b c 2: 3:

使用 $(command) 而不是反引號。

因反引號如果要嵌套則要求用反斜杠轉義內部的反引號。而 $(command) 形式的嵌套無需轉義,且可讀性更高。

正例:

反例:

條件測試

使用 [[ ... ]] ,而不是 [ , test , 和 /usr/bin/[ 。

因為在 [[ 和 ]] 之間不會出現路徑擴展或單詞切分,所以使用 [[ ... ]] 能夠減少犯錯。且 [[ ... ]] 支持正則表達式匹配,而 [ ... ] 不支持。參考以下示例:

盡可能使用變量引用,而非字符串過濾。

Bash可以很好的處理空字符串測試,請使用空/非空字符串測試方法,而不是過濾字符,讓代碼具有更高的可讀性。正例:

反例:

正例:

反例:

正例:

反例:

文件名擴展

當進行文件名的通配符擴展時,請指定明確的路徑。

當目錄中有特殊文件名如以 - 開頭的文件時,使用帶路徑的擴展通配符 ./* 比不帶路徑的 * 要安全很多。

應該避免使用eval。

Eval在用於分配變量時會修改輸入內容,但設置變量的同時並不能檢查這些變量是什麽。反例:

請使用進程替換或者for循環,而不是通過管道連接while循環。

這是因為在管道之後的while循環中,命令是在壹個子shell中運行的,因此對變量的修改是不能傳遞給父shell的。

這種管道連接while循環中的隱式子shell使得bug定位非常困難。反例:

如果妳確定輸入中不包含空格或者其他特殊符號(通常不是來自用戶輸入),則可以用for循環代替。例如:

使用進程替換可實現重定向輸出,但是請將命令放入顯式子 shell,而非 while 循環創建的隱式子 shell。例如:

總是檢查返回值,且提供有用的返回值。

對於非管道命令,使用 $? 或直接通過 if 語句來檢查以保持其簡潔。

例如:

當內建命令可以完成相同的任務時,在shell內建命令和調用外部命令之間,應盡量選擇內建命令。

因內建命令相比外部命令而言會產生更少的依賴,且多數情況調用內建命令比調用外部命令可以獲得更好的性能(通常外部命令會產生額外的進程開銷)。

正例:

反例:

加載外部庫文件不建議用使用.,建議使用source,已提升可閱讀性。正例:

反例:

除非必要情況,盡量使用單個命令及其參數組合來完成壹項任務,而非多個命令加上管道的不必要組合。常見的不建議的用法例如:cat和grep連用過濾字符串; cat和wc連用統計行數; grep和wc連用統計行數等。

正例:

除特殊情況外,幾乎所有函數都不應該使用exit直接退出腳本,而應該使用return進行返回,以便後續邏輯中可以對錯誤進行處理。正例:

反例:

推薦以下工具幫助我們進行代碼的規範:

原文鏈接:http://itxx00.github.io/blog/2020/01/03/shell-standards/

獲取更多的面試題、腳本等運維資料點擊: 運維知識社區 獲取

腳本之---短信轟炸機

腳本之---QQ微信轟炸機

ansible---壹鍵搭建redis5.0.5集群

elk7.9真集群docker部署文檔

全球最全loki部署及配置文檔

最強安全加固腳本2.0

壹鍵設置iptbales腳本

  • 上一篇:Problem Analysis Diagram是什麽意思
  • 下一篇:廈門職業免費培訓的地址怎麽樣?

    1.請問有誰知道廈門哪裏可以培訓人力資源職業資格證書?

    廈門廣韻電腦培訓-就業技能班(半年):室內設計師班(壹年/半年)、室內平面設計師班、網頁設計師班、高級商務應用班、廣告設計班。

    其他短期班:高級辦公室文秘、企業人力資源管理、財務會計、平面設計(Photoshop、CorelDraw、AI)、3DSMAX、Lightscape\VR、

  • copyright 2024編程學習大全網