譯者注:這是一篇很棒文章,使用有趣的敘述方式匈仗,從反面講解了作為一個(gè)優(yōu)秀的 PHP 工程師瓢剿,有哪些事情是你不能做的。請(qǐng)注意哦悠轩,此篇文章羅列的行為间狂,都是你要盡量避免的。
隨著失業(yè)率越來越高哗蜈,很多人意識(shí)到保全自己的工作是多么的重要前标。那么坠韩,什么是保住自己工作,并讓自己無可替代的好方法呢炼列?一個(gè)很簡(jiǎn)單的事實(shí)是只要你的代碼沒有人能夠維護(hù)只搁,那么你就成功保住了工作。編寫不可維護(hù)的代碼是一個(gè)特殊的技能俭尖,但奇怪的是氢惋,似乎對(duì)某些開發(fā)者來說是很自然的。不過對(duì)于剩下的開發(fā)者來說稽犁,這里有一些技巧和提示來讓你開始寫不可維護(hù)的代碼焰望。
首先要做的事情
第一步,從找工作開始已亥。你應(yīng)該尋找合適的公司熊赖,在那里你可以盡情發(fā)揮并實(shí)現(xiàn)你那不可維護(hù)的潛力。 你不一定需要成為公司的 PHP 大牛如果是那更好虑椎。找工作時(shí)震鹉,如果工作描述提到需要從其它的遷移到 PHP (所以你知道你會(huì)做主),或者也可以搜索那種需要10年 PHP5 工作經(jīng)驗(yàn)的誤導(dǎo)性工作捆姜,再加上熟練使用 FrontPage 和 Netscape Composer 传趾。
一旦你獲得這種千載難逢的機(jī)會(huì),從第一天開始就要采取措施泥技。在會(huì)議上發(fā)言浆兰,讓你的意見被聽到。大膽談?wù)撁嫦驅(qū)ο蟮募軜?gòu)設(shè)計(jì)珊豹,企業(yè)簸呈,改革方案,怎樣讓夠好變得更好店茶,當(dāng)然你也得做出相應(yīng)的承諾蝶棋。確保每個(gè)人在重要的編碼環(huán)節(jié)都咨詢你的意見。
不可維護(hù)的核心
靈感來源于優(yōu)秀的文章 “Writing unmaintainable code” (想要保住工作的人一定會(huì)看的), 以下是你需要掌握和精通的兩個(gè)重要概念:
-
你應(yīng)該讓別人無法輕易地修改任何東西忽妒,除非他破壞另外一些東西。
維護(hù)人員沒有時(shí)間去理解你的代碼兼贸。 可維護(hù)的代碼意味著能夠在堆積如山的代碼中快速定位到特定的部分段直,能夠快速明白它是如何工作的并且在不破壞一些東西的情況下進(jìn)行修改。你不能這樣做溶诞。 不能讓別人能輕易地搜索到某些東西或者在他們期待的地方找到鸯檬。
-
你的代碼不能“看起來”不可維護(hù)(因?yàn)閯e人會(huì)懷疑的), 它必須“是”不可維護(hù)。
代碼在維護(hù)人員看起來應(yīng)該是正常的螺垢,但要在他們最意想不到的時(shí)候給他們一個(gè)驚喜喧务。
最佳實(shí)踐
禁止代碼約定赖歌。 關(guān)于編碼和命名約定的對(duì)罵無窮無盡。這樣的情況絕不能在你優(yōu)秀的組織中出現(xiàn)功茴。你有牛逼的項(xiàng)目要做庐冯,你不可能花上無數(shù)的時(shí)間來討論用 tab 還是還是空格。再說了坎穿,約定就是限制展父。如果一個(gè)新人入職,并且他不習(xí)慣你的約定玲昧,他會(huì)很痛苦栖茉。不快樂的程序員是沒有效率的程序員。誰問你你就向他們解釋孵延。讓每個(gè)人都用他們自己喜歡的風(fēng)格寫代碼吕漂。至于你自己的代碼 - 變換你的約定。周一用
camelCase
小駝峰命名尘应,周二用all_lowercase
全小寫命名惶凝,周五混合著用,在每個(gè) 2 月 29 日 使用匈牙利命名法菩收。-
不寫注釋梨睁。 你的代碼很優(yōu)美,它不需要注釋娜饵。如果有人不理解你的代碼坡贺,那么很有可能他們不是那么好的程序員。如果箱舞,有這個(gè)可能的話遍坟,你被強(qiáng)迫要求寫注釋,那么直接夸張的寫晴股。詳細(xì)描述最明顯和最不重要的代碼愿伴,跳過其它的。
// 下面這一塊代碼 // 我們?cè)黾觾蓚€(gè)變量: // 命名為變量 a 和變量 b // 兩個(gè)都是整數(shù) // 聲明變量 a // 并給它賦值整數(shù) 1 $a = 1; // 聲明變量 b $b = 2; // 給變量 a 和 b 求和 // 聲明和初始化見上面 // 并且將結(jié)果賦值給 // 一個(gè)新的變量 c $c = $a + $b;
- 使用記事本編碼电湘。 或者使用其他沒有代碼縮進(jìn)展示的編輯器隔节。使得其他人忍受痛苦最終離開團(tuán)隊(duì)。這樣你就不用總是聽他們的抱怨了寂呛。如果有人問你為什么使用記事本怎诫,準(zhǔn)備好解釋:因?yàn)樗鼇碜杂?Windows (當(dāng)今唯一一個(gè),為富有創(chuàng)造性的程序員準(zhǔn)備的操作系統(tǒng))贷痪,無需任何必要的培訓(xùn)幻妓,也不需要花費(fèi)任何代價(jià)。我相信你能在網(wǎng)上找到你可以使用任何程序的參考文獻(xiàn)劫拢,甚至包括 Word肉津,來編寫你的網(wǎng)頁代碼强胰,但是只有記事本才是真正的權(quán)威,畢竟妹沙,你們公司雇傭的人只有你才是權(quán)威偶洋。
- 拒絕單元測(cè)試。 向任何質(zhì)疑你的人解釋初烘,你是被雇傭過來編寫高質(zhì)量并且沒有漏洞的代碼的(因此涡真,無需測(cè)試)。為什么會(huì)有頭腦正常的人會(huì)花時(shí)間來寫無關(guān)緊要的測(cè)試來證實(shí)代碼能否正常運(yùn)行肾筐?有些事情在生活中就像-天空是藍(lán)色的哆料,太陽從東方升起,你的代碼是能夠正常運(yùn)行的吗铐,因此非常感謝东亦。繼續(xù)(就像評(píng)論一樣,如果被迫接受測(cè)試唬渗,那么準(zhǔn)備好測(cè)試那些顯而易見的內(nèi)容然后跳過其他的部分)
-
不使用模板引擎典阵。 模板引擎能夠幫助你區(qū)分業(yè)務(wù)邏輯層與展示層。它可以保證代碼的可維護(hù)性所以你不能遵守這個(gè)規(guī)定镊逝。PHP 之父 Rasmus Lerdorf 說過:“PHP 就是模板引擎”壮啊。即使你迫不得已使用模板引擎,也要找到對(duì)應(yīng)的方法濫用它撑蒜,例如放一些業(yè)務(wù)代碼在模板中歹啼,或者是小心的將HTML(和 CSS 和 JavaScript)代碼混合在數(shù)據(jù)庫(kù)訪問層中。
一般來說座菠,盡可能在同一行代碼中的將你的 PHP狸眼,HTML,CSS 和 JavaScript 代碼理直氣壯地混合在一起浴滴。在 PHP 代碼中創(chuàng)建 JavaScript 和帶內(nèi)聯(lián)樣式的 HTML 代碼拓萌。如果別人問到,告訴他們這種模式叫做“封裝”升略,你會(huì)對(duì)你的代碼負(fù)全部責(zé)任微王。
- 版本控制。 雖然這很難避免品嚣,但是使自己擺脫任何形式或版本控制很值得嘗試骂远。你可以在討論的時(shí)候向大家證明這樣做提高了團(tuán)隊(duì)成員之間的溝通,而不是去依賴?yán)溲陌姹究刂栖浖H绻銢]有說服任何人,請(qǐng)不要絕望拓型。 你提交的時(shí)候可以不 commit all 额嘿。 在本地保留一些自己的代碼瘸恼。這樣如果你以外的人試圖構(gòu)建和部署的話,這些小而致命的代碼片段將會(huì)破壞這個(gè)項(xiàng)目册养。 如果被抓了东帅,就辯解說這些代碼還不適合展示,畢竟球拦,你提交了能夠教育初級(jí)團(tuán)隊(duì)的高質(zhì)量的代碼和優(yōu)秀的解決方案靠闭。這些小男孩和小女孩將會(huì)仰望著你并充滿期待!
- 構(gòu)建一個(gè)框架坎炼。 然后你不可避免地成為架構(gòu)師愧膀,你的權(quán)威毋庸置疑。這樣你就可以添加一些秘密約定(當(dāng)然其中大多數(shù)有時(shí)是自相矛盾的)谣光,即使是最有經(jīng)驗(yàn)的維護(hù)人員也察覺不出檩淋。 你的框架將負(fù)責(zé)所有的事情,不需要任何人費(fèi)心地去理解它萄金,大家會(huì)很開心因?yàn)槟阋粋€(gè)人讓開發(fā)變得更容易而且提高了整個(gè)公司的產(chǎn)能蟀悦。不要以開源的方式發(fā)布你的框架,因?yàn)?a) 這個(gè)框架是公司的資產(chǎn)而且公司投入了人大量的資金氧敢, b) 開源社區(qū)會(huì)嘲笑你日戈,而且這將成為你虛張聲勢(shì)的結(jié)局。
命名相關(guān)
你的變量名應(yīng)該起的神秘一些孙乖,最好只有一個(gè)字母浙炼。 這樣誰都無法通過簡(jiǎn)單的搜索找到需要的內(nèi)容。
類名和方法最好也使用一個(gè)字母來定義的圆。如果你確實(shí)想定義一個(gè)正常點(diǎn)的名字鼓拧,那就一直使用它吧 —— 記住,隱藏信息的最好方法就是頻繁的使用它越妈。 當(dāng)重復(fù)使用相同名稱(稱為“面向?qū)ο蟮木幊獭保r(shí)季俩,如果將圓括號(hào)和花括號(hào)放在新的一行,這將有助于提高代碼的可讀性梅掠,并且讓隊(duì)友在你的代碼中尋找任何東西時(shí)酌住,都得重溫一下正則表達(dá)式⊙质悖考慮一下吧:
$noodles = 1;
class
noodles
{
var $noodles = 2;
function
noodles
()
{
$noodles['noodles'] = 'noodles';
}
}
function
noodles() {
return new noodles;
}
$noodles = noodles();
var_dump($noodles);
你也可以使用奇特的字符集來命名變量酪我。西里爾字母就非常合適,因?yàn)橛行┳帜缚雌饋砀_馬字母一樣且叁, 但其實(shí)不是(所有這些:xopekacMEBCTAKXOPH)都哭。那么下面的輸出是:
$alert = 1;
$аlert = 2;
echo $alert;
2?如果第二個(gè) alert
以西里爾字母"a"開頭,則不可以欺矫!
引用相關(guān)
即使你非常正常的定義來一些東西纱新,但并不意味著你不能以有趣的方式來使用它。主要的武器有:
eval()
- 可變變量
- 可變類穆趴,比如
$strudels = "noodles"; $noo = new $strudels;
call_user_func()
基本上任何將代碼視為字符串的語言結(jié)構(gòu)都是你的好朋友脸爱。
// calling abc();
$z = 'A';
call_user_func($z .'bC');
大寫
字母例子,函數(shù)方法名不區(qū)分大小寫未妹,濫用這個(gè)特點(diǎn)簿废。
function abc(){
echo "abc";
}
AbC();
另一方面,數(shù)組的铰缢(key) 對(duì)大小寫敏感族檬,也濫用這個(gè)特點(diǎn)。
$a['UseConvetionsOnlyTobreakThem'] = 1;
if (isset($a['UseConvetionsOnlyToBreakThem'])) {
// ?? 大寫 B !!1!
}
重寫
在不期望的情況下重寫全局變量酪耕,尤其是超全局變量导梆。盡早重寫$_GET
數(shù)組中的屬性,多次重寫迂烁,$_POST
亦是如此看尼。在$_REQUEST
上做一些不起眼的重寫作為點(diǎn)綴。如果是在WTF-ed上盟步,你可以解釋是在防止用戶輸入的 XSS 攻擊藏斩、注入攻擊以及其他的病毒攻擊。
控制結(jié)構(gòu)
使用却盘、混合狰域、匹配所有備選的if
,while
黄橘,for
兆览,foreach
,switch
語法塞关。如果被問起來抬探,所有的這些,請(qǐng)解釋說你正在培訓(xùn)新員工學(xué)習(xí)真正的語言帆赢。
if ($a > 5):
if ($a > 4) {
while ($a > 0):
echo --$a;
endwhile;
}
endif;
嵌套三元運(yùn)算符小压,沒有比這個(gè)更好、更簡(jiǎn)潔的代碼了椰于。
// 猜猜這里輸出什么
echo true ? 'true' : false ? 't' : 'f';
在for
的循環(huán)體內(nèi)怠益,再次增加$i
以保持所有人的注意●觯或者蜻牢,通過不使用$i
來實(shí)現(xiàn)循環(huán)增量的驚喜烤咧。從不。
嵌套循環(huán)孩饼、深入髓削,然后突然跳出它們(循環(huán))。像 break 2
和 break 3
這樣的代碼存粹是為了娛樂镀娶,尤其是當(dāng)混合了奇怪的縮進(jìn)代碼時(shí)。
這是一個(gè)開始揪罕!
這就是今天的全部梯码。我希望你相信你自己也能做到,你也可以編寫不可維護(hù)的代碼『脝現(xiàn)在你的未來就在你的手中轩娶!當(dāng)然,你也可以編寫可讀性比較高的代碼框往,但是冒著被替代的風(fēng)險(xiǎn)鳄抒。
更多現(xiàn)代化 PHP 知識(shí),請(qǐng)前往 Laravel / PHP 知識(shí)社區(qū)