提高php代码质量 36计

1.不要使用相对路径
常常会看到:
复制代码

1. require_once("../../lib/some_class.php");

该方法有很多缺点:
它首先查找指定的php包含路径, 然后查找当前目录.
因此会检查过多路径.
如果该脚本被另一目录的脚本包含, 它的基本目录变成了另一脚本所在的目录.
另一问题, 当定时任务运行该脚本, 它的上级目录可能就不是工作目录了.
因此最佳选择是使用绝对路径:
复制代码

1. define("ROOT" , "/var/www/project/");
2. require_once(ROOT . "../../lib/some_class.php");
3. //rest of the code

我们定义了一个绝对路径, 值被写死了. 我们还可以改进它. 路径 /var/www/project 也可能会改变, 那么我们每次都要改变它吗? 不是的, 我们可以使用__FILE__常量, 如:
复制代码

1. //suppose your script is /var/www/project/index.php
2. //Then __FILE__ will always have that full path.
3. define("ROOT" , pathinfo(__FILE__, PATHINFO_DIRNAME));
4. require_once(ROOT . "../../lib/some_class.php");
5. //rest of the code

现在, 无论你移到哪个目录, 如移到一个外网的服务器上, 代码无须更改便可正确运行.

2. 不要直接使用 require, include, include_once, required_once


可以在脚本头部引入多个文件, 像类库, 工具文件和助手函数等, 如: 复制代码

1. require_once("lib/Database.php");
2. require_once("lib/Mail.php");[backcolor=#ffffff][color=#008ef1]   [/color][/backcolor]
3. require_once("helpers/utitlity_functio n s.php");

这种用法相当原始. 应该更灵活点. 应编写个助手函数包含文件. 例如:
复制代码

1. function load_class($class_name)
2. {
3.     //path to the class file
4.     $path = ROOT . "/lib/" . $class_name . ".php");
5.     require_once( $path );
6. }
7. load_class("Database");
8. load_class("Mail");

有什么不一样吗? 该代码更具可读性.
將来你可以按需扩展该函数, 如:

还可做得更多:
为同样文件查找多个目录
能很容易的改变放置类文件的目录, 无须在代码各处一一修改
可使用类似的函数加载文件, 如html内容.

3. 为应用保留调试代码


在开发环境中, 我们打印数据库查询语句, 转存有问题的变量值, 而一旦问题解决, 我们注释或删除它们. 然而更好的做法是保留调试代码.
在开发环境中, 你可以: 复制代码

1. define("ENVIRONMENT" , "development");
2.   
3. if(! $db->query( $query )
4. {
5.     if(ENVIRONMENT == "development")
6.     {
7.         echo "$query failed";
8.     }
9.     else
10.     {
11.         echo "Database error. Please contact administrator";
12.     }
13. }

在服务器中, 你可以:
复制代码

1. define("ENVIRONMENT" , "production");
2.   
3. if(! $db->query( $query )
4. {
5.     if(ENVIRONMENT == "development")
6.     {
7.         echo "$query failed";
8.     }
9.     else
10.     {
11.         echo "Database error. Please contact administrator";
12.     }
13. }

4. 使用可跨平台的函数执行命令


system, exec, passthru, shell_exec 这4个函数可用于执行系统命令. 每个的行为都有细微差别. 问题在于, 当在共享主机中, 某些函数可能被选择性的禁用. 大多数新手趋于每次首先检查哪个函数可用, 然而再使用它.
更好的方案是封成函数一个可跨平台的函数. 复制代码

1. /**
2.     Method to execute a command in the terminal
3.     Uses :
4.   
5.     1. system
6.     2. passthru
7.     3. exec
8.     4. shell_exec
9.   
10. */
11. function terminal($command)
12. {
13.     //system
14.     if(function_exists("system"))
15.     {
16.         ob_start();
17.         system($command , $return_var);
18.         $output = ob_get_contents();
19.         ob_end_clean();
20.     }
21.     //passthru
22.     else if(function_exists("passthru"))
23.     {
24.         ob_start();
25.         passthru($command , $return_var);
26.         $output = ob_get_contents();
27.         ob_end_clean();
28.     }
29.   
30.     //exec
31.     else if(function_exists("exec"))
32.     {
33.         exec($command , $output , $return_var);
34.         $output = implode(" " , $output);
35.     }
36.   
37.     //shell_exec
38.     else if(function_exists("shell_exec"))
39.     {
40.         $output = shell_exec($command) ;
41.     }
42.   
43.     else
44.     {
45.         $output = "Command execution not possible on this system";
46.         $return_var = 1;
47.     }
48.   
49.     return array("output" => $output , "status" => $return_var);
50. }
51.   
52. terminal("ls");

上面的函数將运行shell命令, 只要有一个系统函数可用, 这保持了代码的一致性.

5. 灵活编写函数

复制代码

1. function add_to_cart($item_id , $qty)
2. {
3.     $_SESSION["cart"]["item_id"] = $qty;
4. }
5.   
6. add_to_cart( "IPHONE3" , 2 );

使用上面的函数添加单个项目. 而当添加项列表的时候,你要创建另一个函数吗? 不用, 只要稍加留意不同类型的参数, 就会更灵活. 如:
复制代码

1. function add_to_cart($item_id , $qty)
2. {
3.     if(!is_array($item_id))
4.     {
5.         $_SESSION["cart"]["item_id"] = $qty;
6.     }
7.   
8.     else
9.     {
10.         foreach($item_id as $i_id => $qty)
11.         {
12.             $_SESSION["cart"]["i_id"] = $qty;
13.         }
14.     }
15. }
16.   
17. add_to_cart( "IPHONE3" , 2 );
18. add_to_cart( array("IPHONE3" => 2 , "IPAD" => 5) );

现在, 同个函数可以处理不同类型的输入参数了. 可以参照上面的例子重构你的多处代码, 使其更智能.
6. 有意忽略php关闭标签
我很想知道为什么这么多关于php建议的博客文章都没提到这点. 复制代码

1. <?php
2. echo "Hello";[backcolor=#ffffff][color=#008ef1]   [/color][/backcolor]
3. //Now dont close this tag

这將节约你很多时间. 我们举个例子:
一个 super_class.php 文件 复制代码

1. <?php
2. class super_class
3. {
4.     function super_function()
5.     {
6.         //super code
7.     }
8. }
9. ?>
10. //super extra character after the closing tag

index.php
复制代码

1. require_once("super_class.php");
2.   
3. //echo an image or pdf , or set the cookies or session data

这样, 你將会得到一个 Headers already send error. 为什么? 因为 "super extra character" 已经被输出了. 现在你得开始调试啦. 这会花费大量时间寻找 super extra 的位置.
因此, 养成省略关闭符的习惯: 复制代码

1. <?php
2. class super_class
3. {
4.     function super_function()
5.     {
6.         //super code
7.     }
8. }
9.   
10. //No closing tag

这会更好.

7. 在某地方收集所有输入, 一次输出给浏览器


这称为输出缓冲, 假如说你已在不同的函数输出内容: 复制代码

1. function print_header()
2. {
3.     echo "<div id="header">Site Log and Login links</div>";
4. }
5.   
6. function print_footer()
7. {
8.     echo "<div id="footer">Site was made by me</div>";
9. }
10.   
11. print_header();
12. for($i = 0 ; $i < 100; $i++)
13. {
14.     echo "I is : $i
15. ";
16. }
17. print_footer();

替代方案, 在某地方集中收集输出. 你可以存储在函数的局部变量中, 也可以使用ob_start和ob_end_clean. 如下:
复制代码

1. function print_header()
2. {
3.     $o = "<div id="header">Site Log and Login links</div>";
4.     return $o;
5. }
6.   
7. function print_footer()
8. {
9.     $o = "<div id="footer">Site was made by me</div>";
10.     return $o;
11. }
12.   
13. echo print_header();
14. for($i = 0 ; $i < 100; $i++)
15. {
16.     echo "I is : $i
17. ";
18. }
19. echo print_footer();

为什么需要输出缓冲:
>>可以在发送给浏览器前更改输出. 如 str_replaces 函数或可能是 preg_replaces 或添加些监控/调试的html内容.
>>输出给浏览器的同时又做php的处理很糟糕. 你应该看到过有些站点的侧边栏或中间出现错误信息. 知道为什么会发生吗? 因为处理和输出混合了.

8. 发送正确的mime类型头信息, 如果输出非html内容的话.


输出一些xml. 复制代码

1. $xml = "<?xml version="1.0" encoding="utf-8" standalone="yes"?>";
2. $xml = "<respo n se>
3.   <code>0</code>
4. </respo n se>";
5.   
6. //Send xml data
7. echo $xml;

工作得不错. 但需要一些改进.
复制代码

1. $xml = "<?xml version="1.0" encoding="utf-8" standalone="yes"?>";
2. $xml = "<respo n se>
3.   <code>0</code>
4. </respo n se>";
5.   
6. //Send xml data
7. header("content-type: text/xml");
8. echo $xml;

注意header行. 该行告知浏览器发送的是xml类型的内容. 所以浏览器能正确的处理. 很多的javascript库也依赖头信息.
类似的有 javascript , css, jpg image, png image:
JavaScript 复制代码

1. header("content-type: application/x-javascript");
2. echo "var a = 10";

CSS
复制代码

1. header("content-type: text/css");
2. echo "#div id { background:#000; }";

9. 为mysql连接设置正确的字符编码


曾经遇到过在mysql表中设置了unicode/utf-8编码, phpadmin也能正确显示, 但当你获取内容并在页面输出的时候,会出现乱码. 这里的问题出在mysql连接的字符编码. 复制代码

1. //Attempt to connect to database
2. $c = mysqli_connect($this->host , $this->username, $this->password);
3.   
4. //Check connection validity
5. if (!$c)
6. {
7.     die ("Could not connect to the database host:
8. ". mysqli_connect_error());
9. }
10.   
11. //Set the character set of the connection
12. if(!mysqli_set_charset ( $c , "UTF8" ))
13. {
14.     die("mysqli_set_charset() failed");
15. }

一旦连接数据库, 最好设置连接的 characterset. 你的应用如果要支持多语言, 这么做是必须的.

10. 使用 htmlentities 设置正确的编码选项


php5.4前, 字符的默认编码是ISO-8859-1, 不能直接输出如à a等. 复制代码

1. $value = htmlentities($this->value , ENT_QUOTES , CHARSET);

php5.4以后, 默认编码为UTF-8, 这將解决很多问题. 但如果你的应用是多语言的, 仍然要留意编码问题,.

11. 不要在应用中使用gzip压缩输出, 让apache处理


考虑过使用 ob_gzhandler 吗? 不要那样做. 毫无意义. php只应用来编写应用. 不应操心服务器和浏览器的数据传输优化问题.
使用apache的mod_gzip/mod_deflate 模块压缩内容.

12. 使用json_encode输出动态javascript内容


时常会用php输出动态javascript内容: 复制代码

1. $images = array(
2. "myself.png" , "friends.png" , "colleagues.png"
3. );
4. 声明：该文观点仅代表作者本人，牛骨文系教育信息发布平台，牛骨文仅提供信息存储空间服务。
   • 上一篇： mysql 按年度、季度、月度、周、日SQL统计查询
   • 下一篇： MYSQL-统计查询