代碼重構(Code refactoring)有時是很枯燥的,字符串替換之類的操作不僅乏味,而且還容易出錯,好在有一些工具可用,以PHP為例,如:Rephactor,Scisr等等,不過現成的工具往往意味著不夠靈活,所以今天我要說說Shell在代碼重構中的應用。
先來個簡單的,假設我們要把PHP文件中的foo_bar全都替換成fooBar,那麼可以如下:
方法一,使用Sed:
shell> find /path -name "*.php" | xargs sed s/foo_bar/fooBar/g
方法二,使用AWK:
shell> find /path -name "*.php" | xargs awk { gsub(/foo_bar/, "fooBar"); print; }
注:為了簡單,我把結果直接打印到終端屏幕了,至於如何保存,稍後會說明。
接著說個復雜的:假設某個PHP項目,以前使用類之前必須調用一個名為“includeClass”的方法,現在改用類自動加載的方式,所以要刪除硬編碼的includeClass調用,出於美觀的考慮,如果includeClass下面一行是空行的話,也一起刪除,同時考慮大小寫不敏感的因素。
重構前的代碼示例:
01 <?php
02 includeClass(...);
03 echo a;
04
05 echo b;
06 includeClass(...);
07 includeClass(...);
08
09
10 echo c;
11
12 echo d;
13 includeClass(...);
14
15
16 echo e;
17 ?>
重構後的代碼示例:
01 <?php
02 echo a;
03
04 echo b;
05
06 echo c;
07
08 echo d;
09
10 echo e;
11 ?>
在動手前,我們需要先摸摸底,了解一下大概的情況:
shell> grep -I -ri includeClass /path | more
其中,grep命令的參數乍一看不好記,不過只要按照我說的方法記,就永遠不會忘:前面的參數看做英文,後面的參數看做拼音。至於參數的具體含義,請參閱man文檔。
方法一,使用Sed編寫腳本script.sh:
#!/bin/sh
for PHP in $@; do
/bin/sed -i
/includeClass/I {
h
d
}
/^$/ {
x
/includeClass/Id
x
}
h
$PHP
done
注:篇幅所限,我把正則寫的比較簡單
Sed的缺點是代碼可讀性比較差,優點是代碼較短。另外內置的“-i”選項可以直接完成保存,這是我喜歡Sed的原因之一。
方法二,使用AWK編寫腳本script.sh:
#!/bin/sh
for PHP in $@; do
TMP=$(mktemp)
/bin/awk
BEGIN {
IGNORECASE = 1
}
/includeClass/ {
previous = $0
next
}
/^$/ {
if (previous ~ /includeClass/) {
previous = $0
next
}
}
{
previous = $0
print
}
$PHP > $TMP
/bin/cp -f $TMP $PHP
/bin/rm -f $TMP
done
注:篇幅所限,我把正則寫的比較簡單
AWK的缺點是代碼比較長,優點是代碼可讀性較好。另外程序中是通過生成一個唯一的臨時文件來完成保存的。
提醒:直接覆蓋原始文件有時候並不合適,畢竟可能有沒考慮周詳的地方,使用SVN的話就不會有這樣的顧慮了,因為即便覆蓋了原始文件,也可以在提交前通過“svn diff”命令來檢查對錯,就算是提交了,也可以恢復到以前的版本。
如果調用script.sh腳本呢?這裡給個最一般的例子:
shell> find /path -name "*.php" | xargs /path/to/script.sh
簡單的任務用Sed寫很合適,復雜的任務則最好用AWK寫,實戰是學習的最好方法,具體可以參考Sed One Line和AWK One Line等資料。
說明:本文用到的Sed和AWK均指GNU版本。