這篇文章主要介紹“有哪些讓代碼整潔、過(guò)程清晰的BASH Shell編程技巧”,在日常操作中,相信很多人在有哪些讓代碼整潔、過(guò)程清晰的BASH Shell編程技巧問(wèn)題上存在疑惑,小編查閱了各式資料,整理出簡(jiǎn)單好用的操作方法,希望對(duì)大家解答”有哪些讓代碼整潔、過(guò)程清晰的BASH Shell編程技巧”的疑惑有所幫助!接下來(lái),請(qǐng)跟著小編一起來(lái)學(xué)習(xí)吧!
一、不可改變的全局變量
1.盡量少用全局變量
2.以大寫命名
3.只讀聲明
4.用全局變量來(lái)代替隱晦的$0,$1等
在我的程序中常使用的全局變量:
代碼如下:
readonly PROGNAME=$(basename $0)
readonly PROGDIR=$(readlink -m $(dirname $0))
readonly ARGS="$@"
二、一切皆是局部的
所有變量都應(yīng)為局部的。
代碼如下:
change_owner_of_file() {
local filename=$1
local user=$2
local group=$3
chown $user:$group $filename
}
change_owner_of_files() {
local user=$1; shift
local group=$1; shift
local files=$@
local i
for i in $files
do
chown $user:$group $i
done
}
1.自注釋(self documenting)的參數(shù)
2.通常作為循環(huán)用的變量i,把它聲明為局部變量是很重要的。
3.局部變量不作用于全局域。
代碼如下:
kfir@goofy ~ $ local a
bash: local: can only be used in a function
三、main()
1.有助于保持所有變量的局部性
2.直觀的函數(shù)式編程
3.代碼中的全局命令是:main
代碼如下:
main() {
local files="/tmp/a /tmp/b"
local i
for i in $files
do
change_owner_of_file kfir users $i
done
}
main
四、一切皆是函數(shù)
全局性運(yùn)行的代碼是:
- 不可變的全局變量聲明
- main()函數(shù)
1.保持代碼整潔
2.過(guò)程變得清晰
代碼如下:
main() {
local files=$(ls /tmp | grep pid | grep -v daemon)
}
代碼如下:
temporary_files() {
local dir=$1
ls $dir \
| grep pid \
| grep -v daemon
}
main() {
local files=$(temporary_files /tmp)
}
1.第二個(gè)例子好得多。查找文件是temporary_files()的問(wèn)題而非main()的。這段代碼用temporary_files()的單元測(cè)試也是可測(cè)試的。
2.如果你一定要嘗試第一個(gè)例子,你會(huì)得到查找臨時(shí)文件以和main算法的大雜燴。
代碼如下:
test_temporary_files() {
local dir=/tmp
touch $dir/a-pid1232.tmp
touch $dir/a-pid1232-daemon.tmp
returns "$dir/a-pid1232.tmp" temporary_files $dir
touch $dir/b-pid1534.tmp
returns "$dir/a-pid1232.tmp $dir/b-pid1534.tmp" temporary_files $dir
}
如你所見(jiàn),這個(gè)測(cè)試不關(guān)心main()。
五、調(diào)試函數(shù)
帶-x標(biāo)志運(yùn)行程序:
代碼如下:
bash -x my_prog.sh
只調(diào)試一小段代碼,使用set-x和set+x,會(huì)只對(duì)被set -x和set +x包含的當(dāng)前代碼打印調(diào)試信息。
代碼如下:
temporary_files() {
local dir=$1
set -x
ls $dir \
| grep pid \
| grep -v daemon
set +x
}
打印函數(shù)名和它的參數(shù):
代碼如下:
temporary_files() {
echo $FUNCNAME $@
local dir=$1
ls $dir \
| grep pid \
| grep -v daemon
}
調(diào)用函數(shù):
代碼如下:
temporary_files /tmp
會(huì)打印到標(biāo)準(zhǔn)輸出:
代碼如下:
temporary_files /tmp
六、代碼的清晰度
這段代碼做了什么?
代碼如下:
main() {
local dir=/tmp
[[ -z $dir ]] \
&& do_something...
[[ -n $dir ]] \
&& do_something...
[[ -f $dir ]] \
&& do_something...
[[ -d $dir ]] \
&& do_something...
}
main
讓你的代碼說(shuō)話:
代碼如下:
is_empty() {
local var=$1
[[ -z $var ]]
}
is_not_empty() {
local var=$1
[[ -n $var ]]
}
is_file() {
local file=$1
[[ -f $file ]]
}
is_dir() {
local dir=$1
[[ -d $dir ]]
}
main() {
local dir=/tmp
is_empty $dir \
&& do_something...
is_not_empty $dir \
&& do_something...
is_file $dir \
&& do_something...
is_dir $dir \
&& do_something...
}
main
七、每一行只做一件事
用反斜杠\來(lái)作分隔符。例如:
代碼如下:
temporary_files() {
local dir=$1
ls $dir | grep pid | grep -v daemon
}
可以寫得簡(jiǎn)潔得多:
代碼如下:
temporary_files() {
local dir=$1
ls $dir \
| grep pid \
| grep -v daemon
}
符號(hào)在縮進(jìn)行的開(kāi)始
符號(hào)在行末的壞例子:(譯注:原文在此例中用了temporary_files()代碼段,疑似是貼錯(cuò)了。結(jié)合上下文,應(yīng)為print_dir_if_not_empty())
代碼如下:
print_dir_if_not_empty() {
local dir=$1
is_empty $dir && \
echo "dir is empty" || \
echo "dir=$dir"
}
好的例子:我們可以清晰看到行和連接符號(hào)之間的聯(lián)系。
代碼如下:
print_dir_if_not_empty() {
local dir=$1
is_empty $dir \
&& echo "dir is empty" \
|| echo "dir=$dir"
}
八、打印用法
不要這樣做:
代碼如下:
echo "this prog does:..."
echo "flags:"
echo "-h print help"
它應(yīng)該是個(gè)函數(shù):
代碼如下:
usage() {
echo "this prog does:..."
echo "flags:"
echo "-h print help"
}
echo在每一行重復(fù)。因此我們得到了這個(gè)文檔:
代碼如下:
usage() {
cat <<- EOF
usage: $PROGNAME options
Program deletes files from filesystems to release space.
It gets config file that define fileystem paths to work on, and whitelist rules to
keep certain files.
OPTIONS:
-c --config configuration file containing the rules. use --help-config to see the syntax.
-n --pretend do not really delete, just how what you are going to do.
-t --test run unit test to check the program
-v --verbose Verbose. You can specify more then one -v to have more verbose
-x --debug debug
-h --help show this help
--help-config configuration help
Examples:
Run all tests:
$PROGNAME --test all
Run specific test:
$PROGNAME --test test_string.sh
Run:
$PROGNAME --config /path/to/config/$PROGNAME.conf
Just show what you are going to do:
$PROGNAME -vn -c /path/to/config/$PROGNAME.conf
EOF
}
注意在每一行的行首應(yīng)該有一個(gè)真正的制表符‘\t'。
在vim里,如果你的tab是4個(gè)空格,你可以用這個(gè)替換命令:
代碼如下:
:s/^ /\t/
九、命令行參數(shù)
這里是一個(gè)例子,完成了上面usage函數(shù)的用法。我從http://kirk.webfinish.com/2009/10/bash-shell-script-to-use-getopts-with-gnu-style-long-positional-parameters/ 得到這段代碼
代碼如下:
cmdline() {
# got this idea from here:
# http://kirk.webfinish.com/2009/10/bash-shell-script-to-use-getopts-with-gnu-style-long-positional-parameters/
local arg=
for arg
do
local delim=""
case "$arg" in
#translate --gnu-long-options to -g (short options)
--config) args="${args}-c ";;
--pretend) args="${args}-n ";;
--test) args="${args}-t ";;
--help-config) usage_config && exit 0;;
--help) args="${args}-h ";;
--verbose) args="${args}-v ";;
--debug) args="${args}-x ";;
#pass through anything else
*) [[ "${arg:0:1}" == "-" ]] || delim="\""
args="${args}${delim}${arg}${delim} ";;
esac
done
#Reset the positional parameters to the short options
eval set -- $args
while getopts "nvhxt:c:" OPTION
do
case $OPTION in
v)
readonly VERBOSE=1
;;
h)
usage
exit 0
;;
x)
readonly DEBUG='-x'
set -x
;;
t)
RUN_TESTS=$OPTARG
verbose VINFO "Running tests"
;;
c)
readonly CONFIG_FILE=$OPTARG
;;
n)
readonly PRETEND=1
;;
esac
done
if [[ $recursive_testing || -z $RUN_TESTS ]]; then
[[ ! -f $CONFIG_FILE ]] \
&& eexit "You must provide --config file"
fi
return 0
}
你像這樣,使用我們?cè)陬^上定義的不可變的ARGS變量:
代碼如下:
main() {
cmdline $ARGS
}
main
十、單元測(cè)試
1.在更高級(jí)的語(yǔ)言中很重要。
2.使用shunit2做單元測(cè)試
代碼如下:
test_config_line_paths() {
local s='partition cpm-all, 80-90,'
returns "/a" "config_line_paths '$s /a, '"
returns "/a /b/c" "config_line_paths '$s /a:/b/c, '"
returns "/a /b /c" "config_line_paths '$s /a : /b : /c, '"
}
config_line_paths() {
local partition_line="$@"
echo $partition_line \
| csv_column 3 \
| delete_spaces \
| column 1 \
| colons_to_spaces
}
source /usr/bin/shunit2
這里是另一個(gè)使用df命令的例子:
代碼如下:
DF=df
mock_df_with_eols() {
cat <<- EOF
Filesystem 1K-blocks Used Available Use% Mounted on
/very/long/device/path
124628916 23063572 100299192 19% /
EOF
}
test_disk_size() {
returns 1000 "disk_size /dev/sda1"
DF=mock_df_with_eols
returns 124628916 "disk_size /very/long/device/path"
}
df_column() {
local disk_device=$1
local column=$2
$DF $disk_device \
| grep -v 'Use%' \
| tr '\n' ' ' \
| awk "{print \$$column}"
}
disk_size() {
local disk_device=$1
df_column $disk_device 2
}
到此,關(guān)于“有哪些讓代碼整潔、過(guò)程清晰的BASH Shell編程技巧”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí),請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)?lái)更多實(shí)用的文章!
分享名稱:有哪些讓代碼整潔、過(guò)程清晰的BASHShell編程技巧-創(chuàng)新互聯(lián)
網(wǎng)站地址:http://chinadenli.net/article0/dgphio.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供小程序開(kāi)發(fā)、網(wǎng)站改版、微信公眾號(hào)、網(wǎng)站設(shè)計(jì)、用戶體驗(yàn)、營(yíng)銷型網(wǎng)站建設(shè)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容