經(jīng)驗(yàn)分享：PHP編程的5個(gè)良好習(xí)慣（一）
學(xué)習(xí)良好的編程習(xí)慣能夠提高代碼質(zhì)量和效率。像其他語(yǔ)言一樣，開(kāi)發(fā)人員可以用 PHP 編寫(xiě)出各種質(zhì)量級(jí)別的代碼。根據(jù)具體的情況，一般的開(kāi)發(fā)人員往往比優(yōu)秀的開(kāi)發(fā)人員的效率低 10%~20%。優(yōu)秀的開(kāi)發(fā)人員的效率更高，因?yàn)樗麄儞碛胸S富的經(jīng)驗(yàn)和良好的編程習(xí)慣。不良的編程習(xí)慣將會(huì)影響到效率。本文通過(guò)展示一些良好的編程習(xí)慣，幫助您成為更優(yōu)秀的程序員。
這些良好的編程習(xí)慣不僅能提高效率，還能讓您編寫(xiě)出在應(yīng)用程序的整個(gè)生命周期中易于維護(hù)的代碼。編寫(xiě)出來(lái)的代碼可能需要大量的維護(hù);應(yīng)用程序的維護(hù)是一筆很大的開(kāi)支。養(yǎng)成良好的編程習(xí)慣能夠提高設(shè)計(jì)質(zhì)量(比如模塊化)，從而使代碼更加容易理解，因此維護(hù)就更加容易，同時(shí)也降低維護(hù)成本。
不良的編程習(xí)慣會(huì)造成代碼缺陷，使其難以維護(hù)和修改，并且很可能在修改時(shí)又引入其他缺陷。以下是 5 個(gè)良好的編程習(xí)慣，能夠幫助 PHP 代碼避免這些缺陷：
1. 使用良好的命名
使用良好的命名是最重要的編程習(xí)慣，因?yàn)槊枋鲂詮?qiáng)的名稱(chēng)讓代碼更加容易閱讀和理解。代碼是否好理解取決于是否能在未來(lái)維護(hù)它。即便代碼不帶有注釋?zhuān)绻苋菀桌斫猓瑢⒋蟠蠓奖闳蘸蟮母摹＿@個(gè)習(xí)慣的目標(biāo)是讓您編寫(xiě)的代碼像書(shū)本一樣容易閱讀和理解。
不良習(xí)慣：含糊的或無(wú)意義的名稱(chēng)
清單 1 中的代碼包含過(guò)短的變量名、難以辨認(rèn)的縮寫(xiě)詞，并且方法名不能反映該方法的功能。如果方法名給人的感覺(jué)是它應(yīng)該做這件事情，而實(shí)際中它卻做另外的事情，這將帶來(lái)嚴(yán)重的問(wèn)題，因?yàn)樗鼤?huì)誤導(dǎo)人。
清單 1. 不良習(xí)慣：含糊的或無(wú)意義的名稱(chēng)
- <?php
- function getNBDay($d)
- {
- switch($d) {
- case 5:
- case 6:
- case 7:
- return 1;
- default:
- return ($d + 1);
- }
- }
- $day = 5;
- $nextDay = getNBDay($day);
- echo ("Next day is: " . $nextDay . "\n");
- ?>
復(fù)制代碼良好習(xí)慣：說(shuō)明性強(qiáng)并且簡(jiǎn)潔的名稱(chēng)
清單 2 中的代碼體現(xiàn)了良好的編程習(xí)慣。新的方法名具有很強(qiáng)的說(shuō)明性，反映了方法的用途。同樣，更改后的變量名也更具說(shuō)明性。惟一的保持最短的變量是 $i，在本清單中，它是一個(gè)循環(huán)變量。盡管很多人不贊同使用過(guò)短的名稱(chēng)，但在循環(huán)變量中使用還是可以接受的(甚至有好處)，因?yàn)樗鞔_表明了代碼的功能。
清單 2. 良好習(xí)慣：說(shuō)明性強(qiáng)并且簡(jiǎn)潔的名稱(chēng)
- <?php
- define ('MONDAY', 1);
- define ('TUESDAY', 2);
- define ('WEDNESDAY', 3);
- define ('THURSDAY', 4);
- define ('FRIDAY', 5);
- define ('SATURDAY', 6);
- define ('SUNDAY', 7);
- /*
- * @param $dayOfWeek
- * @return int Day of week, with 1 being Monday and so on.
- */
- function findNextBusinessDay($dayOfWeek)
- {
- $nextBusinessDay = $dayOfWeek;
- switch($dayOfWeek) {
- case FRIDAY:
- case SATURDAY:
- case SUNDAY:
- $nextBusinessDay = MONDAY;
- break;
- default:
- $nextBusinessDay += 1;
- break;
- }
- return $nextBusinessDay;
- }
- $day = FRIDAY;
- $nextBusDay = findNextBusinessDay($day);
- echo ("Next day is:" . $nextBusDay . "\n");
- ?>
復(fù)制代碼我們鼓勵(lì)您將大的條件拆分為一個(gè)方法，然后用能夠描述該條件的名字命名方法。這個(gè)技巧能夠提高代碼的可讀性，并且能夠?qū)l件具體化，使之能夠被提取甚至重用。如果條件發(fā)生變化，更新方法也很容易。因?yàn)榉椒〒碛幸粋€(gè)有意義的名字，所以它能反映代碼的用途，讓代碼更容易閱讀。
#p#
2. 分成更小的部分
專(zhuān)心解決一個(gè)問(wèn)題之后再繼續(xù)編程，這樣會(huì)讓您更輕松。在解決一個(gè)緊急的問(wèn)題時(shí)，如果繼續(xù)編程，會(huì)使函數(shù)越來(lái)越長(zhǎng)。從長(zhǎng)遠(yuǎn)來(lái)說(shuō)，這并不是一個(gè)問(wèn)題，但您要記得回過(guò)頭來(lái)將它重構(gòu)為更小的部分。
重構(gòu)是個(gè)不錯(cuò)的主意，但您應(yīng)該養(yǎng)成編寫(xiě)更短、功能更集中的代碼。短的方法能夠在一個(gè)窗口中一次看完，并且容易理解。如果方法過(guò)長(zhǎng)，不能在一個(gè)窗口中一次看完，那么它就變得不容易理解，因?yàn)槟荒芸焖俚貜念^到尾了解它的整個(gè)思路。
構(gòu)建方法時(shí)，您應(yīng)該養(yǎng)成這樣的習(xí)慣，讓每個(gè)方法只完成一件事情。這個(gè)習(xí)慣很好，因?yàn)椋菏紫龋绻椒ㄖ煌瓿梢患虑椋敲此透菀妆恢赜?其次，這樣的方法容易測(cè)試;第三，這樣的方法便于理解和更改。
不良習(xí)慣：過(guò)長(zhǎng)的方法(完成很多件事情)
清單 3 展示了一個(gè)很長(zhǎng)的函數(shù)，其中存在很多問(wèn)題。它完成很多件事情，因此不夠緊湊。它也不便于閱讀、調(diào)試和測(cè)試。它要做的事情包括遍歷一個(gè)文件、構(gòu)建一個(gè)列表、為每個(gè)對(duì)象賦值、執(zhí)行計(jì)算等等。
清單 3. 不良習(xí)慣：過(guò)長(zhǎng)的函數(shù)
- <?php
- function writeRssFeed($user)
- {
- // Get the DB connection information
- // look up the user's preferences...
- $link = mysql_connect('mysql_host', 'mysql_user', 'mysql_password')
- OR die(mysql_error());
- // Query
- $perfsQuery = sprintf("SELECT max_stories FROM user_perfs WHERE user= '%s'",
- mysql_real_escape_string($user));
- $result = mysql_query($query, $link);
- $max_stories = 25; // default it to 25;
- if ($row = mysql_fetch_assoc($result)) {
- $max_stories = $row['max_stories'];
- }
- // go get my data
- $perfsQuery = sprintf("SELECT * FROM stories WHERE post_date = '%s'",
- mysql_real_escape_string());
- $result = mysql_query($query, $link);
- $feed = "<rss version=\"2.0\">" .
- "<channel>" .
- "<title>My Great Feed</title>" .
- "<link>http://www.example.com/feed.xml</link>" .
- "<description>The best feed in the world</description>" .
- "<language>en-us</language>" .
- "<pubDate>Tue, 20 Oct 2008 10:00:00 GMT</pubDate>" .
- "<lastBuildDate>Tue, 20 Oct 2008 10:00:00 GMT</lastBuildDate>" .
- "<docs>http://www.example.com/rss</docs>" .
- "<generator>MyFeed Generator</generator>" .
- "<managingEditor>editor@example.com</managingEditor>""<webMaster>webmaster@example.com</webMaster>" .
- "<ttl>5</ttl>";
- // build the feed...
- while ($row = mysql_fetch_assoc($result)) {
- $title = $row['title'];
- $link = $row['link'];
- $description = $row['description'];
- $date = $row['date'];
- $guid = $row['guid'];
- $feed .= "<item>";
- $feed .= "<title>" . $title . "</title>";
- $feed .= "<link>" . $link . "</link>";
- $feed .= "<description> " . $description . "</description>";
- $feed .= "<pubDate>" . $date . "</pubDate>";
- $feed .= "<guid>" . $guid . "</guid>";
- $feed .= "</item>";
- }
- $feed .= "</rss";
- // write the feed out to the server...
- echo($feed);
- }
- ?>
復(fù)制代碼如果多編寫(xiě)幾個(gè)這樣的方法，維護(hù)就成了真正的難題了。
良好習(xí)慣：易管理、功能專(zhuān)一的方法
清單 4 將原來(lái)的方法改寫(xiě)為更加緊湊、易讀的方法。在這個(gè)示例中，將一個(gè)很長(zhǎng)的方法分解為幾個(gè)短方法，并且讓每個(gè)短方法負(fù)責(zé)一件事情。這樣的代碼對(duì)將來(lái)的重用和測(cè)試都是大有裨益的。
清單 4. 良好習(xí)慣：易管理、功能專(zhuān)一的方法
- <?php
- function createRssHeader()
- {
- return "<rss version=\"2.0\">" .
- "<channel>" .
- "<title>My Great Feed</title>" .
- "<link>http://www.example.com/feed.xml</link>" .
- "<description>The best feed in the world</description>" .
- "<language>en-us</language>" .
- "<pubDate>Tue, 20 Oct 2008 10:00:00 GMT</pubDate>" .
- "<lastBuildDate>Tue, 20 Oct 2008 10:00:00 GMT</lastBuildDate>" .
- "<docs>http://www.example.com/rss</docs>" .
- "<generator>MyFeed Generator</generator>" .
- "<managingEditor>editor@example.com</managingEditor>" .
- "<webMaster>webmaster@example.com</webMaster>" .
- "<ttl>5</ttl>";
- }
- function createRssFooter()
- {
- return "</channel></rss>";
- }
- function createRssItem($title, $link, $desc, $date, $guid)
- {
- $item .= "<item>";
- $item .= "<title>" . $title . "</title>";
- $item .= "<link>" . $link . "</link>";
- $item .= "<description> " . $description . "</description>";
- $item .= "<pubDate>" . $date . "</pubDate>";
- $item .= "<guid>" . $guid . "</guid>";
- $item .= "</item>";
- return $item;
- }
- function getUserMaxStories($db_link, $default)
- {
- $perfsQuery = sprintf("SELECT max_stories FROM user_perfs WHERE user= '%s'",
- mysql_real_escape_string($user));
- $result = mysql_query($perfsQuery, $db_link);
- $max_stories = $default;
- if ($row = mysql_fetch_assoc($result)) {
- $max_stories = $row['max_stories'];
- }
- return $max_stories;
- }
- function writeRssFeed($user)
- {
- // Get the DB connection information
- $settings = parse_ini_file("rss_server.ini");
- // look up the user's preferences...
- $link = mysql_connect($settings['db_host'], $settings['user'],
- $settings['password']) OR die(mysql_error());
- $max_stories = getUserMaxStories($link, 25);
- // go get my data
- $newsQuery = sprintf("SELECT * FROM stories WHERE post_date = '%s'",
- mysql_real_escape_string(time()));
- $result = mysql_query($newsQuery, $link);
- $feed = createRssHeader();
- $i = 0;
- // build the feed...
- while ($row = mysql_fetch_assoc($result)) {
- if ($i < $max_stories) {
- $title = $row['title'];
- $link = $row['link'];
- $description = $row['description'];
- $date = $row['date'];
- $guid = $row['guid'];
- $feed .= createRssItem($title, $link, $description, $date, $guid);
- $i++;
- } else {
- break;
- }
- }
- mysql_close($link);
- $feed .= createRssFooter();
- // write the feed out to the server...
- echo($feed);
- }
- ?>
復(fù)制代碼將長(zhǎng)方法拆分為短方法也是有限制的，過(guò)度拆分將適得其反。因此，不要濫用這個(gè)良好的習(xí)慣。將代碼分成大量的片段就像沒(méi)有拆分長(zhǎng)代碼一樣，都會(huì)造成閱讀困難。
由于本文過(guò)長(zhǎng)，請(qǐng)看下一篇，經(jīng)驗(yàn)分享：PHP編程的5個(gè)良好習(xí)慣（二）
【編輯推薦】
