給PHP開(kāi)發(fā)者的編程指南 第一部分降低復(fù)雜程度
PHP 是一門(mén)自由度很高的編程語(yǔ)言。它是動(dòng)態(tài)語(yǔ)言,對(duì)程序員有很大的寬容度。作為 PHP 程序員,要想讓你的代碼更有效,需要了解不少的規(guī)范。很多年來(lái),我讀過(guò)很多編程方面的書(shū)籍,與很多資深程序員也討論過(guò)代碼風(fēng)格的問(wèn)題。具體哪條規(guī)則來(lái)自哪本書(shū)或者哪個(gè)人,我肯定不會(huì)都記得,但是本文(以及接下來(lái)的另一篇文章) 表達(dá)了我對(duì)于如何寫(xiě)出更好的代碼的觀點(diǎn):能經(jīng)得起考驗(yàn)的代碼,通常是非常易讀和易懂的。這樣的代碼,別人可以更輕松的查找問(wèn)題,也可以更簡(jiǎn)單的復(fù)用代碼。
降低函數(shù)體的復(fù)雜度
在方法或者函數(shù)體里,盡可能的降低復(fù)雜性。相對(duì)低一些的復(fù)雜性,可以便于別人閱讀代碼。另外,這樣做也可以減少代碼出問(wèn)題的可能性,更易修改,有問(wèn)題也更易修復(fù)。
在函數(shù)里減少括號(hào)數(shù)量
盡可能少的使用 if, elseif, else 和 switch 這些語(yǔ)句。它們會(huì)增加更多的括號(hào)。這會(huì)讓代碼更難懂、更難測(cè)試一些(因?yàn)槊總€(gè)括號(hào)都需要有測(cè)試用例覆蓋到)??偸怯修k法來(lái)避免這個(gè)問(wèn)題的。
代理決策 ("命令,不用去查詢(xún)(Tell, don't ask)")
有的時(shí)候 if 語(yǔ)句可以移到另一個(gè)對(duì)象里,這樣會(huì)更清晰些。例如:
if($a->somethingIsTrue()) {
$a->doSomething();
}
可以改成:
$a->doSomething();
這里,具體的判斷由 $a 對(duì)象的 doSomething() 方法去做了。我們不需要再為此做更多的考慮,只需要安全的調(diào)用 doSomething() 即可。這種方式優(yōu)雅的遵循了命令,不要去查詢(xún)?cè)瓌t。我建議你深入了解一下這個(gè)原則,當(dāng)你向一個(gè)對(duì)象查詢(xún)信息并且根據(jù)這些信息做判斷的時(shí)候都可以適用這條原則。
使用map
有時(shí)可以用 map 語(yǔ)句減少 if, elseif 或 else 的使用,例如:
if($type==='json') {
return $jsonDecoder->decode($body);
}elseif($type==='xml') {
return $xmlDecoder->decode($body);
}else{
throw new \LogicException(
'Type "'.$type.'" is not supported'
);
}
可以精簡(jiǎn)為:
$decoders= ...;// a map of type (string) to corresponding Decoder objects
if(!isset($decoders[$type])) {
thrownew\LogicException(
'Type "'.$type.'" is not supported'
);
}
這樣使用 map 的方式也讓你的代碼遵循擴(kuò)展開(kāi)放,關(guān)閉修改的原則。
強(qiáng)制類(lèi)型
很多 if 語(yǔ)句可以通過(guò)更嚴(yán)格的使用類(lèi)型來(lái)避免,例如:
if($a instanceof A) {
// happy path
return $a->someInformation();
}elseif($a=== null) {
// alternative path
return 'default information';
}
可以通過(guò)強(qiáng)制 $a 使用 A 類(lèi)型來(lái)簡(jiǎn)化:
return $a->someInformation();
當(dāng)然,我們可以通過(guò)其他方式來(lái)支持 "null" 的情況。這個(gè)在后面的文章會(huì)提到。
Return early
很多時(shí)候,函數(shù)里的一個(gè)分支并非真正的分支,而是前置或者后置的一些條件,就像這樣:// 前置條件
if(!$a instanceof A) {
throw new \InvalidArgumentException(...);
}
// happy path
return $a->someInformation();
這里 if 語(yǔ)句并不是函數(shù)執(zhí)行的一個(gè)分支,它只是對(duì)一個(gè)前置條件的檢查。有時(shí)我們可以讓 PHP 自身來(lái)完成前置條件的檢查(例如使用恰當(dāng)?shù)念?lèi)型提示)。不過(guò),PHP 也沒(méi)法完成所有前置條件的檢查,所以還是需要在代碼里保留一些。為了降低復(fù)雜度,我們需要在提前知道代碼會(huì)出錯(cuò)時(shí)、輸入錯(cuò)誤時(shí)、已經(jīng)知道結(jié)果時(shí)盡早返回。
盡早返回的效果就是后面的代碼沒(méi)必要像之前那樣縮進(jìn)了:
// check precondition
if(...) {
thrownew...();
}
// return early
if(...) {
return...;
}
// happy path
...
return...;
像上面這個(gè)模板這樣,代碼會(huì)變動(dòng)更易讀和易懂。
創(chuàng)建小的邏輯單元
如果函數(shù)體過(guò)長(zhǎng),就很難理解這個(gè)函數(shù)到底在干什么。跟蹤變量的使用、變量類(lèi)型、變量聲明周期、調(diào)用的輔助函數(shù)等等,這些都會(huì)消耗很多腦細(xì)胞。如果函數(shù)比較小,對(duì)于理解函數(shù)功能很有幫助(例如,函數(shù)只是接受一些輸入,做一些處理,再返回結(jié)果)。
使用輔助函數(shù)
在使用之前的原則減少括號(hào)之后,你還可以通過(guò)把函數(shù)拆分成更小的邏輯單元做到讓函數(shù)更清晰。你可以把實(shí)現(xiàn)一個(gè)子任務(wù)的代碼行看做一組代碼,這些代碼組直接用空行來(lái)分隔。然后考慮如何把它們拆分成輔助方法(即重構(gòu)中的提煉方法)。
輔助方法一般是 private 的方法,只會(huì)被所屬的特定類(lèi)的對(duì)象調(diào)用。通常它們不需要訪問(wèn)實(shí)例的變量,這種情況需要定義為 static 的方法。在我的經(jīng)驗(yàn)中,private (static)的輔助方法通常會(huì)匯總到分離的類(lèi)中,并且定義成 public (static 或 instance)的方法,至少在測(cè)試驅(qū)動(dòng)開(kāi)發(fā)的時(shí)候使用一個(gè)協(xié)作類(lèi)就是這種情形。
減少臨時(shí)變量
長(zhǎng)的函數(shù)通常需要一些變量來(lái)保存中間結(jié)果。這些臨時(shí)變量跟蹤起來(lái)比較麻煩:你需要記住它們是否已經(jīng)初始化了,是否還有用,現(xiàn)在的值又是多少等等。
上節(jié)提到的輔助函數(shù)有助于減少臨時(shí)變量:
public function capitalizeAndReverse(array $names) {
$capitalized = array_map('ucfirst', $names);
$capitalizedAndReversed = array_map('strrev', $capitalized);
return $capitalizedAndReversed;
}
使用輔助方法,我們可以不用臨時(shí)變量了:
public function capitalizeAndReverse(array $names) {
return self::reverse(
self::capitalize($names)
);
}
private static function reverse(array $names) {
return array_map('strrev', $names);
}
private static function capitalize(array $names) {
return array_map('ucfirst', $names);
}
正如你所見(jiàn),我們把函數(shù)變成新函數(shù)的組合,這樣變得更易懂,也更容易修改。某種方式上,代碼還有點(diǎn)符合“擴(kuò)展開(kāi)放/修改關(guān)閉”,因?yàn)槲覀兓旧喜恍枰傩薷妮o助函數(shù)。
由于很多算法需要遍歷容器,從而得到新的容器或者計(jì)算出一個(gè)結(jié)果,此時(shí)把容器本身當(dāng)做一個(gè)“一等公民”并且附加上相關(guān)的行為,這樣做是很有意義的:
classNames
{
private $names;
public function __construct(array $names)
{
$this->names = $names;
}
public function reverse()
{
return new self(
array_map('strrev', $names)
);
}
public function capitalize()
{
return new self(
array_map('ucfirst', $names)
);
}
}
$result = (newNames([...]))->capitalize()->reverse();
這樣做可以簡(jiǎn)化函數(shù)的組合。
雖然減少臨時(shí)變量通常會(huì)帶來(lái)好的設(shè)計(jì),不過(guò)上面的例子中也沒(méi)必要干掉所有的臨時(shí)變量。有時(shí)候臨時(shí)變量的用處是很清晰的,作用也是一目了然的,就沒(méi)必要精簡(jiǎn)。
使用簡(jiǎn)單的類(lèi)型
追蹤變量的當(dāng)前取值總是很麻煩的,當(dāng)不清楚變量的類(lèi)型時(shí)尤其如此。而如果一個(gè)變量的類(lèi)型不是固定的,那簡(jiǎn)直就是噩夢(mèng)。
數(shù)組只包含同一種類(lèi)型的值
使用數(shù)組作為可遍歷的容器時(shí),不管什么情況都要確保只使用同一種類(lèi)型的值。這可以降低遍歷數(shù)組讀取數(shù)據(jù)的循環(huán)的復(fù)雜度:
foreach($collection as $value) {
// 如果指定$value的類(lèi)型,就不需要做類(lèi)型檢查
}
你的代碼編輯器也會(huì)為你提供數(shù)組值的類(lèi)型提示:
/**
* @param DateTime[] $collection
*/
public function doSomething(array $collection) {
foreach($collection as $value) {
// $value是DateTime類(lèi)型
}
}
而如果你不能確定 $value 是 DateTime 類(lèi)型的話,你就不得不在函數(shù)里添加前置判斷來(lái)檢查其類(lèi)型。beberlei/assert庫(kù)可以讓這個(gè)事情簡(jiǎn)單一些:
useAssert\Assertion
public function doSomething(array $collection) {
Assertion::allIsInstanceOf($collection, \DateTime::class);
...
}
如果容器里有內(nèi)容不是 DateTime 類(lèi)型,這會(huì)拋出一個(gè) InvalidArgumentException 異常。除了強(qiáng)制輸入相同類(lèi)型的值之外,使用斷言(assert)也是降低代碼復(fù)雜度的一種手段,因?yàn)槟憧梢圆辉诤瘮?shù)的頭部去做類(lèi)型的檢查。
簡(jiǎn)單的返回值類(lèi)型
只要函數(shù)的返回值可能有不同的類(lèi)型,就會(huì)極大的增加調(diào)用端代碼的復(fù)雜度:
$result= someFunction();
if($result=== false) {
...
}else if(is_int($result)) {
...
}
PHP 并不能阻止你返回不同類(lèi)型的值(或者使用不同類(lèi)型的參數(shù))。但是這樣做只會(huì)造成大量的混亂,你的程序里也會(huì)到處都充斥著 if 語(yǔ)句。
下面是一個(gè)經(jīng)常遇到的返回混合類(lèi)型的例子:
/**
* @param int $id
* @return User|null
*/
public function findById($id)
{
...
}
這個(gè)函數(shù)會(huì)返回 User 對(duì)象或者 null,這種做法是有問(wèn)題的,如果不檢查返回值是否合法的 User 對(duì)象,我們是不能去調(diào)用返回值的方法的。在 PHP 7之前,這樣做會(huì)造成"Fatal error",然后程序崩潰。
下一篇文章我們會(huì)考慮 null,告訴你如何去處理它們。
可讀的表達(dá)式
我們已經(jīng)討論過(guò)不少降低函數(shù)的整體復(fù)雜度的方法。在更細(xì)粒度上我們也可以做一些事情來(lái)減少代碼的復(fù)雜度。
隱藏復(fù)雜的邏輯
通??梢园褟?fù)雜的表達(dá)式變成輔助函數(shù)。看看下面的代碼:
if(($a||$b) &&$c) {
...
}
可以變得更簡(jiǎn)單一些,像這樣:
if(somethingIsTheCase($a,$b,$c)) {
...
}
閱讀代碼時(shí)可以清楚的知道這個(gè)判斷依賴(lài) $a, $b 和 $c 三個(gè)變量,而函數(shù)名也可以很好的表達(dá)判斷條件的內(nèi)容。
使用布爾表達(dá)式
if 表達(dá)式的內(nèi)容可以轉(zhuǎn)換成布爾表達(dá)式。不過(guò) PHP 也沒(méi)有強(qiáng)制你必須提供 boolean 值:
$a=new\DateTime();
...
if($a) {
...
}
$a 會(huì)自動(dòng)轉(zhuǎn)換成 boolean 類(lèi)型。強(qiáng)制類(lèi)型轉(zhuǎn)換是 bug 的主要來(lái)源之一,不過(guò)還有一個(gè)問(wèn)題是會(huì)對(duì)代碼的理解帶來(lái)復(fù)雜性,因?yàn)檫@里的類(lèi)型轉(zhuǎn)換是隱式的。PHP 的隱式轉(zhuǎn)換的替代方案是顯式的進(jìn)行類(lèi)型轉(zhuǎn)換,例如:
if($a instanceof DateTime) {
...
}
如果你知道比較的是 bool 類(lèi)型,就可以簡(jiǎn)化成這樣:
if($b=== false) {
...
}
使用 ! 操作符則還可以簡(jiǎn)化:
if(!$b) {
...
}
不要 Yoda 風(fēng)格的表達(dá)式
Yoda 風(fēng)格的表達(dá)式就像這樣:
if('hello'===$result) {
...
}
這種表達(dá)式主要是為了避免下面的錯(cuò)誤:
if($result='hello') {
...
}
這里 'hello' 會(huì)賦值給 $result,然后成為整個(gè)表達(dá)式的值。'hello' 會(huì)自動(dòng)轉(zhuǎn)換成 bool 類(lèi)型,這里會(huì)轉(zhuǎn)換成 true。于是 if 分支里的代碼在這里會(huì)總是被執(zhí)行。
使用 Yoda 風(fēng)格的表達(dá)式可以幫你避免這類(lèi)問(wèn)題:
if('hello'=$result) {
...
}
我覺(jué)得實(shí)際情況下不太會(huì)有人出現(xiàn)這種錯(cuò)誤,除非他還在學(xué)習(xí) PHP 的基本語(yǔ)法。而且,Yoda 風(fēng)格的代碼也有不小的代價(jià):可讀性。這樣的表達(dá)式不太易讀,也不太容易懂,因?yàn)檫@不符合自然語(yǔ)言的習(xí)慣。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助。
相關(guān)文章
PHP創(chuàng)建單例后臺(tái)進(jìn)程的方法示例
這篇文章主要介紹了PHP創(chuàng)建單例后臺(tái)進(jìn)程的方法,涉及php針對(duì)進(jìn)程的啟動(dòng)、創(chuàng)建、判斷、停止等相關(guān)操作技巧,需要的朋友可以參考下2017-05-05
php mysql實(shí)現(xiàn)mysql_select_db選擇數(shù)據(jù)庫(kù)
在PHP中,與MySQL服務(wù)器建立連接后,需要確定所要連接的數(shù)據(jù)庫(kù),此時(shí)我們可以使用mysql_select_db函數(shù),該函數(shù)用于選擇需要操作的數(shù)據(jù)庫(kù),需要的朋友可以參考下2016-12-12
php 判斷服務(wù)器操作系統(tǒng)的類(lèi)型
本篇文章主要是對(duì)php判斷服務(wù)器的操作系統(tǒng)類(lèi)型方法進(jìn)行了介紹,需要的朋友可以過(guò)來(lái)參考下,希望對(duì)大家有所幫助2014-02-02
php連接mysql之mysql_connect()與mysqli_connect()的區(qū)別
本擴(kuò)展自 PHP 5.5.0 起已廢棄,并在將來(lái)會(huì)被移除。應(yīng)使用 MySQLi 或 PDO_MySQL 擴(kuò)展來(lái)替換之,這里就為大家分享一下mysql_connect()與mysqli_connect()的區(qū)別,需要的朋友可以參考下2020-07-07
php使用fgetcsv讀取csv文件出現(xiàn)亂碼的解決方法
這篇文章主要介紹了php使用fgetcsv讀取csv文件出現(xiàn)亂碼的解決方法,實(shí)例分析了造成亂碼的原因與對(duì)應(yīng)的解決方法,并給出了Linux平臺(tái)下的亂碼解決方法,需要的朋友可以參考下2014-11-11
PHP中使用file_get_contents抓取網(wǎng)頁(yè)中文亂碼問(wèn)題解決方法
這篇文章主要介紹了PHP中使用file_get_contents抓取網(wǎng)頁(yè)中文亂碼問(wèn)題解決方法,可以通過(guò)使用curl配置gzip選項(xiàng)來(lái)解決,具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2014-12-12
PHP簡(jiǎn)單獲取隨機(jī)數(shù)的常用方法小結(jié)
這篇文章主要介紹了PHP簡(jiǎn)單獲取隨機(jī)數(shù)的常用方法,結(jié)合實(shí)例形式分析了php實(shí)現(xiàn)指定范圍隨機(jī)數(shù)與指定字符序列隨機(jī)數(shù)的簡(jiǎn)單實(shí)現(xiàn)技巧,需要的朋友可以參考下2017-06-06

