经验分享:PHP编程的5个良好习惯(一)

学习良好的编程习惯能够提高代码质量和效率。像其他语言一样,开发人员可以用 PHP编写出各种质量级别的代码。根据具体的情况,一般的开发人员往往比优秀的开发人员的效率低 10%~20%。优秀的开发人员的效率更高,因为他们拥有丰富的经验和良好的编程习惯。不良的编程习惯将会影响到效率。本文通过展示一些良好的编程习惯,帮助您成为更优秀的程序员。

额尔古纳网站制作公司哪家好,找创新互联!从网页设计、网站建设、微信开发、APP开发、响应式网站设计等网站项目制作,到程序开发,运营维护。创新互联于2013年创立到现在10年的时间,我们拥有了丰富的建站经验和运维经验,来保证我们的工作的顺利进行。专注于网站建设就选创新互联

这些良好的编程习惯不仅能提高效率,还能让您编写出在应用程序的整个生命周期中易于维护的代码。编写出来的代码可能需要大量的维护;应用程序的维护是一笔很大的开支。养成良好的编程习惯能够提高设计质量(比如模块化),从而使代码更加容易理解,因此维护就更加容易,同时也降低维护成本。

不良的编程习惯会造成代码缺陷,使其难以维护和修改,并且很可能在修改时又引入其他缺陷。以下是 5 个良好的编程习惯,能够帮助 PHP 代码避免这些缺陷:

1. 使用良好的命名

使用良好的命名是最重要的编程习惯,因为描述性强的名称让代码更加容易阅读和理解。代码是否好理解取决于是否能在未来维护它。即便代码不带有注释,如果它很容易理解,将大大方便日后的更改。这个习惯的目标是让您编写的代码像书本一样容易阅读和理解。

不良习惯:含糊的或无意义的名称

清单 1 中的代码包含过短的变量名、难以辨认的缩写词,并且方法名不能反映该方法的功能。如果方法名给人的感觉是它应该做这件事情,而实际中它却做另外的事情,这将带来严重的问题,因为它会误导人。

清单 1. 不良习惯:含糊的或无意义的名称

 
 
 
  1. function getNBDay($d)  
  2. {  
  3. switch($d) {  
  4. case 5:  
  5. case 6:  
  6. case 7:  
  7. return 1;  
  8. default:  
  9. return ($d + 1);  
  10. }  
  11. }  
  12. $day = 5;  
  13. $nextDay = getNBDay($day);  
  14. echo ("Next day is: " . $nextDay . "\n");  
  15. ?> 

复制代码良好习惯:说明性强并且简洁的名称

清单 2 中的代码体现了良好的编程习惯。新的方法名具有很强的说明性,反映了方法的用途。同样,更改后的变量名也更具说明性。惟一的保持最短的变量是 $i,在本清单中,它是一个循环变量。尽管很多人不赞同使用过短的名称,但在循环变量中使用还是可以接受的(甚至有好处),因为它明确表明了代码的功能。

清单 2. 良好习惯:说明性强并且简洁的名称

 
 
 
  1. define ('MONDAY', 1);  
  2. define ('TUESDAY', 2);  
  3. define ('WEDNESDAY', 3);  
  4. define ('THURSDAY', 4);  
  5. define ('FRIDAY', 5);  
  6. define ('SATURDAY', 6);  
  7. define ('SUNDAY', 7);  
  8. /*  
  9. * @param $dayOfWeek  
  10. * @return int Day of week, with 1 being Monday and so on.  
  11. */ 
  12. function findNextBusinessDay($dayOfWeek)  
  13. {  
  14. $nextBusinessDay = $dayOfWeek;  
  15. switch($dayOfWeek) {  
  16. case FRIDAY:  
  17. case SATURDAY:  
  18. case SUNDAY:  
  19. $nextBusinessDay = MONDAY;  
  20. break;  
  21. default:  
  22. $nextBusinessDay += 1;  
  23. break;  
  24. }  
  25. return $nextBusinessDay;  
  26. }  
  27. $day = FRIDAY;  
  28. $nextBusDay = findNextBusinessDay($day);  
  29. echo ("Next day is:" . $nextBusDay . "\n");  
  30. ?> 

复制代码我们鼓励您将大的条件拆分为一个方法,然后用能够描述该条件的名字命名方法。这个技巧能够提高代码的可读性,并且能够将条件具体化,使之能够被提取甚至重用。如果条件发生变化,更新方法也很容易。因为方法拥有一个有意义的名字,所以它能反映代码的用途,让代码更容易阅读。

#p#

2. 分成更小的部分

专心解决一个问题之后再继续编程,这样会让您更轻松。在解决一个紧急的问题时,如果继续编程,会使函数越来越长。从长远来说,这并不是一个问题,但您要记得回过头来将它重构为更小的部分。

重构是个不错的主意,但您应该养成编写更短、功能更集中的代码。短的方法能够在一个窗口中一次看完,并且容易理解。如果方法过长,不能在一个窗口中一次看完,那么它就变得不容易理解,因为您不能快速地从头到尾了解它的整个思路。

构建方法时,您应该养成这样的习惯,让每个方法只完成一件事情。这个习惯很好,因为:首先,如果方法只完成一件事情,那么它就更容易被重用;其次,这样的方法容易测试;第三,这样的方法便于理解和更改。

不良习惯:过长的方法(完成很多件事情)

清单 3 展示了一个很长的函数,其中存在很多问题。它完成很多件事情,因此不够紧凑。它也不便于阅读、调试和测试。它要做的事情包括遍历一个文件、构建一个列表、为每个对象赋值、执行计算等等。

清单 3. 不良习惯:过长的函数

 
 
 
  1. function writeRssFeed($user)  
  2. {  
  3. // Get the DB connection information  
  4. // look up the user's preferences...  
  5. $link = mysql_connect('mysql_host', 'mysql_user', 'mysql_password')  
  6. OR die(mysql_error());  
  7. // Query  
  8. $perfsQuery = sprintf("SELECT max_stories FROM user_perfs WHERE user= '%s'",  
  9. mysql_real_escape_string($user));  
  10. $result = mysql_query($query, $link);  
  11. $max_stories = 25; // default it to 25;  
  12. if ($row = mysql_fetch_assoc($result)) {  
  13. $max_stories = $row['max_stories'];  
  14. }  
  15. // go get my data  
  16. $perfsQuery = sprintf("SELECT * FROM stories WHERE post_date = '%s'",  
  17. mysql_real_escape_string());  
  18. $result = mysql_query($query, $link);  
  19. $feed = "" .  
  20. "" .  
  21. "My Great Feed" .  
  22. "http://www.example.com/feed.xml" .  
  23. "The best feed in the world" .  
  24. "en-us" .  
  25. "Tue, 20 Oct 2008 10:00:00 GMT" .  
  26. "Tue, 20 Oct 2008 10:00:00 GMT" .  
  27. "http://www.example.com/rss" .  
  28. "MyFeed Generator" .  
  29. "editor@example.com""webmaster@example.com" .  
  30. "5";  
  31. // build the feed...  
  32. while ($row = mysql_fetch_assoc($result)) {  
  33. $title = $row['title'];  
  34. $link = $row['link'];  
  35. $description = $row['description'];  
  36. $date = $row['date'];  
  37. $guid = $row['guid'];  
  38. $feed .= "";  
  39. $feed .= "" . $title . "";  
  40. $feed .= "" . $link . "";  
  41. $feed .= " " . $description . "";  
  42. $feed .= "" . $date . "";  
  43. $feed .= "" . $guid . "";  
  44. $feed .= "";  
  45. }  
  46. $feed .= "
  47. // write the feed out to the server...  
  48. echo($feed);  
  49. }  
  50. ?> 

复制代码如果多编写几个这样的方法,维护就成了真正的难题了。

良好习惯:易管理、功能专一的方法

清单 4 将原来的方法改写为更加紧凑、易读的方法。在这个示例中,将一个很长的方法分解为几个短方法,并且让每个短方法负责一件事情。这样的代码对将来的重用和测试都是大有裨益的。

清单 4. 良好习惯:易管理、功能专一的方法

 
 
 
  1. function createRssHeader()  
  2. {  
  3. return "" .  
  4. "" .  
  5. "My Great Feed" .  
  6. "http://www.example.com/feed.xml" .  
  7. "The best feed in the world" .  
  8. "en-us" .  
  9. "Tue, 20 Oct 2008 10:00:00 GMT" .  
  10. "Tue, 20 Oct 2008 10:00:00 GMT" .  
  11. "http://www.example.com/rss" .  
  12. "MyFeed Generator" .  
  13. "editor@example.com" .
  14. "webmaster@example.com" .  
  15. "5";  
  16. }  
  17. function createRssFooter()  
  18. {  
  19. return "";  
  20. }  
  21. function createRssItem($title, $link, $desc, $date, $guid)  
  22. {  
  23. $item .= "";  
  24. $item .= "" . $title . "";  
  25. $item .= "" . $link . "";  
  26. $item .= " " . $description . "";  
  27. $item .= "" . $date . "";  
  28. $item .= "" . $guid . "";  
  29. $item .= "";  
  30. return $item;  
  31. }  
  32. function getUserMaxStories($db_link, $default)  
  33. {  
  34. $perfsQuery = sprintf("SELECT max_stories FROM user_perfs WHERE user= '%s'",  
  35. mysql_real_escape_string($user));  
  36. $result = mysql_query($perfsQuery, $db_link);  
  37. $max_stories = $default;  
  38. if ($row = mysql_fetch_assoc($result)) {  
  39. $max_stories = $row['max_stories'];  
  40. }  
  41. return $max_stories;  
  42. }  
  43. function writeRssFeed($user)  
  44. {  
  45. // Get the DB connection information  
  46. $settings = parse_ini_file("rss_server.ini");  
  47. // look up the user's preferences...  
  48. $link = mysql_connect($settings['db_host'], $settings['user'],  
  49. $settings['password']) OR die(mysql_error());  
  50. $max_stories = getUserMaxStories($link, 25);  
  51. // go get my data  
  52. $newsQuery = sprintf("SELECT * FROM stories WHERE post_date = '%s'",  
  53. mysql_real_escape_string(time()));  
  54. $result = mysql_query($newsQuery, $link);  
  55. $feed = createRssHeader();  
  56. $i = 0;  
  57. // build the feed...  
  58. while ($row = mysql_fetch_assoc($result)) {  
  59. if ($i < $max_stories) {  
  60. $title = $row['title'];  
  61. $link = $row['link'];  
  62. $description = $row['description'];  
  63. $date = $row['date'];  
  64. $guid = $row['guid'];  
  65. $feed .= createRssItem($title, $link, $description, $date, $guid);  
  66. $i++;  
  67. } else {  
  68. break;  
  69. }  
  70. }  
  71. mysql_close($link);  
  72. $feed .= createRssFooter();  
  73. // write the feed out to the server...  
  74. echo($feed);  
  75. }  
  76. ?> 

复制代码将长方法拆分为短方法也是有限制的,过度拆分将适得其反。因此,不要滥用这个良好的习惯。将代码分成大量的片段就像没有拆分长代码一样,都会造成阅读困难。

由于本文过长,请看下一篇,经验分享:PHP编程的5个良好习惯(二)

【编辑推荐】

  1. 详细介绍使用PHP框架的原因
  2. PHP框架之如何学习新的PHP框架
  3. PHP新手之如何学习PHP的讲解
  4. 介绍使用PHP框架的十大理由
  5. PHP新手之学习数组声明

当前文章:经验分享:PHP编程的5个良好习惯(一)
网址分享:http://www.shufengxianlan.com/qtweb/news0/121700.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联