36计教您如何提高PHP代码质量

阅读:300 2019-03-19 14:41:12 来源:新网

1.不要使用相对路径

常常会看到:

require_once('../../lib/some_class.php');

该方法有很多缺点:

它首先查找指定的php包含路径,然后查找当前目录.

因此会检查过多路径.

如果该脚本被另一目录的脚本包含,它的基本目录变成了另一脚本所在的目录.

另一问题,当定时任务运行该脚本,它的上级目录可能就不是工作目录了.

因此最佳选择是使用绝对路径:

define('root','/var/www/project/');require_once(root.'../../lib/some_class.php');//restofthecode

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

//supposeyourscriptis/var/www/project/index.php//then__file__willalwayshavethatfullpath.define('root',pathinfo(__file__,pathinfo_dirname));require_once(root.'../../lib/some_class.php');//restofthecode

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

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

require_once('lib/database.php');require_once('lib/mail.php');require_once('helpers/utitlity_functions.php');

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

functionload_class($class_name){//pathtotheclassfile$path=root.'/lib/'.$class_name.'.php');require_once($path);}load_class('database');load_class('mail');

有什么不一样吗?该代码更具可读性.

將来你可以按需扩展该函数,如:

functionload_class($class_name){//pathtotheclassfile$path=root.'/lib/'.$class_name.'.php');if(file_exists($path)){require_once($path);}}

还可做得更多:

为同样文件查找多个目录

能很容易的改变放置类文件的目录,无须在代码各处一一修改

可使用类似的函数加载文件,如html内容.

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

在开发环境中,你可以:

define('environment','development');if(!$db->query($query){if(environment=='development'){echo"$queryfailed";}else{echo"databaseerror.pleasecontactadministrator";}}

在服务器中,你可以:

define('environment','production');if(!$db->query($query){if(environment=='development'){echo"$queryfailed";}else{echo"databaseerror.pleasecontactadministrator";}}

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

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

更好的方案是封成函数一个可跨平台的函数。

01/**02methodtoexecuteacommandintheterminal03uses:04051.system062.passthru073.exec084.shell_exec0910*/11functionterminal($command)12{13//system14if(function_exists('system'))15{16ob_start();17system($command,$return_var);18$output=ob_get_contents();19ob_end_clean();20}21//passthru22elseif(function_exists('passthru'))23{24ob_start();25passthru($command,$return_var);26$output=ob_get_contents();27ob_end_clean();28}2930//exec31elseif(function_exists('exec'))32{33exec($command,$output,$return_var);34$output=implode("n",$output);35}3637//shell_exec38elseif(function_exists('shell_exec'))39{40$output=shell_exec($command);41}4243else44{45$output='commandexecutionnotpossibleonthissystem';46$return_var=1;47}4849returnarray('output'=>$output,'status'=>$return_var);50}5152terminal('ls');

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

1functionadd_to_cart($item_id,$qty)2{3$_session['cart']['item_id']=$qty;4}56add_to_cart('iphone3',2);

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

01functionadd_to_cart($item_id,$qty)02{03if(!is_array($item_id))04{05$_session['cart']['item_id']=$qty;06}0708else09{10foreach($item_idas$i_id=>$qty)11{12$_session['cart']['i_id']=$qty;13}14}15}1617add_to_cart('iphone3',2);18add_to_cart(array('iphone3'=>2,'ipad'=>5));

现在,同个函数可以处理不同类型的输入参数了.可以参照上面的例子重构你的多处代码,使其更智能.

6.有意忽略php关闭标签

我很想知道为什么这么多关于php建议的博客文章都没提到这点.

1

这將节约你很多时间.我们举个例子:

一个super_class.php文件

0110//superextracharacteraftertheclosingtag

index.php

1require_once('super_class.php');23//echoanimageorpdf,orsetthecookiesorsessiondata

这样,你將会得到一个headersalreadysenderror.为什么?因为“superextracharacter”已经被输出了.现在你得开始调试啦.这会花费大量时间寻找superextra的位置.

因此,养成省略关闭符的习惯:

01

这会更好。

7.在某地方收集所有输入,一次输出给浏览器这称为输出缓冲,假如说你已在不同的函数输出内容:

01functionprint_header()02{03echo"sitelogandloginlinks

";04}0506functionprint_footer()07{08echo"sitewasmadebyme
";09}1011print_header();12for($i=0;$i<100;$i++)13{14echo"iis:$i
';15}16print_footer();

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

01functionprint_header()02{03$o="sitelogandloginlinks";04return$o;05}0607functionprint_footer()08{09$o="sitewasmadebyme";10return$o;11}1213echoprint_header();14for($i=0;$i<100;$i++)15{16echo"iis:$i
';17}18echoprint_footer();

为什么需要输出缓冲:

>>可以在发送给浏览器前更改输出.如str_replaces函数或可能是preg_replaces或添加些监控/调试的html内容.

>>输出给浏览器的同时又做php的处理很糟糕.你应该看到过有些站点的侧边栏或中间出现错误信息.知道为什么会发生吗?因为处理和输出混合了.

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

输出一些xml.

1$xml='';2$xml="304";56//sendxmldata7echo$xml;

工作得不错.但需要一些改进.

1$xml='';2$xml="304";56//sendxmldata7header("content-type:text/xml");8echo$xml;

注意header行.该行告知浏览器发送的是xml类型的内容.所以浏览器能正确的处理.很多的javascript库也依赖头信息.

类似的有javascript,css,jpgimage,pngimage:

javascript

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

css

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

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

01//attempttoconnecttodatabase02$c=mysqli_connect($this->host,$this->username,$this->password);0304//checkconnectionvalidity05if(!$c) 06{07die("couldnotconnecttothedatabasehost:
".mysqli_connect_error());08}0910//setthecharactersetoftheconnection11if(!mysqli_set_charset($c,'utf8'))12{13die('mysqli_set_charset()failed');14}

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

10.使用htmlentities设置正确的编码选项php5.4前,字符的默认编码是iso-8859-1,不能直接输出如àâ等.

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内容:

01$images=array(02'myself.png','friends.png','colleagues.png'03);0405$js_code='';0607foreach($imagesas$image)08{09$js_code.="'$image',";10}1112$js_code='varimages=['.$js_code.'];';1314echo$js_code;1516//outputisvarimages=['myself.png','friends.png','colleagues.png',];

更聪明的做法,使用json_encode:

1$images=array(2'myself.png','friends.png','colleagues.png'3);45$js_code='varimages='.json_encode($images);67echo$js_code;89//outputis:varimages=["myself.png","friends.png","colleagues.png"]

优雅乎?

13.写文件前,检查目录写权限写或保存文件前,确保目录是可写的,假如不可写,输出错误信息.这会节约你很多调试时间.linux系统中,需要处理权限,目录权限不当会导致很多很多的问题,文件也有可能无法读取等等.

确保你的应用足够智能,输出某些重要信息.

1$contents="allthecontent";2$file_path="/var/www/project/content.txt";34file_put_contents($file_path,$contents);

这大体上正确.但有些间接的问题.file_put_contents可能会由于几个原因失败:

>>父目录不存在

>>目录存在,但不可写

>>文件被写锁住?

所以写文件前做明确的检查更好.

01$contents="allthecontent";02$dir='/var/www/project';03$file_path=$dir."/content.txt";0405if(is_writable($dir))06{07file_put_contents($file_path,$contents);08}09else10{11die("directory$dirisnotwritable,ordoesnotexist.pleasecheck");12}

这么做后,你会得到一个文件在何处写及为什么失败的明确信息.

14.更改应用创建的文件权限在linux环境中,权限问题可能会浪费你很多时间.从今往后,无论何时,当你创建一些文件后,确保使用chmod设置正确权限.否则的话,可能文件先是由"php"用户创建,但你用其它的用户登录工作,系统將会拒绝访问或打开文件,你不得不奋力获取root权限,更改文件的权限等等.

1//readandwriteforowner,readforeverybodyelse2chmod("/somedir/somefile",0644);34//everythingforowner,readandexecuteforothers5chmod("/somedir/somefile",0755);

15.不要依赖submit按钮值来检查表单提交行为

1if($_post['submit']=='save')2{3//savethethings4}

上面大多数情况正确,除了应用是多语言的.'save'可能代表其它含义.你怎么区分它们呢.因此,不要依赖于submit按钮的值.

1if($_server['request_method']=='post'andisset($_post['submit']))2{3//savethethings4}

现在你从submit按钮值中解脱出来了.

16.为函数内总具有相同值的变量定义成静态变量

1//delayforsometime2functiondelay()3{4$sync_delay=get_option('sync_delay');56echo"
delayingfor$sync_delayseconds...";7sleep($sync_delay);8echo"done
";9}

17.不要直接使用$_session变量

某些简单例子:

1$_session['username']=$username;2$username=$_session['username'];

这会导致某些问题.如果在同个域名中运行了多个应用,session变量可能会冲突.两个不同的应用可能使用同一个sessionkey.例如,一个前端门户,和一个后台管理系统使用同一域名.

从现在开始,使用应用相关的key和一个包装函数:

01define('app_id','abc_corp_ecommerce');0203//functiontogetasessionvariable04functionsession_get($key)05{06$k=app_id.'.'.$key;0708if(isset($_session[$k]))09{10return$_session[$k];11}1213returnfalse;14}1516//functionsetthesessionvariable17functionsession_set($key,$value)18{19$k=app_id.'.'.$key;20$_session[$k]=$value;2122returntrue;23}

18.將工具函数封装到类中

假如你在某文件中定义了很多工具函数:

01functionutility_a()02{03//thisfunctiondoesautilitythinglikestringprocessing04}0506functionutility_b()07{08//thisfunctiondoesnotherutilitythinglikedatabaseprocessing09}1011functionutility_c()12{13//thisfunctionis...14}

这些函数的使用分散到应用各处.你可能想將他们封装到某个类中:

01classutility02{03publicstaticfunctionutility_a()04{0506}0708publicstaticfunctionutility_b()09{1011}1213publicstaticfunctionutility_c()14{1516}17}1819//andcallthemas2021$a=utility::utility_a();22$b=utility::utility_b();

显而易见的好处是,如果php内建有同名的函数,这样可以避免冲突.

另一种看法是,你可以在同个应用中为同个类维护多个版本,而不导致冲突.这是封装的基本好处,无它。

19.bunchofsillytips

>>使用echo取代print

>>使用str_replace取代preg_replace,除非你绝对需要

>>不要使用shorttag

>>简单字符串用单引号取代双引号

>>head重定向后记得使用exit

>>不要在循环中调用函数

>>isset比strlen快

>>始中如一的格式化代码

>>不要删除循环或者if-else的括号

不要这样写代码:

if($a==true)$a_count++;

这绝对waste.

写成:

1if($a==true)2{3$a_count++;4}

不要尝试省略一些语法来缩短代码.而是让你的逻辑简短.

>>使用有高亮语法显示的文本编辑器.高亮语法能让你减少错误.

20.使用array_map快速处理数组

比如说你想trim数组中的所有元素.新手可能会:

1foreach($arras$c=>$v)2{3$arr[$c]=trim($v);4}

但使用array_map更简单:

1$arr=array_map('trim',$arr);

这会为$arr数组的每个元素都申请调用trim.另一个类似的函数是array_walk.请查阅文档学习更多技巧.

21.使用phpfilter验证数据

你肯定曾使用过正则表达式验证email,ip地址等.是的,每个人都这么使用.现在,我们想做不同的尝试,称为filter.

php的filter扩展提供了简单的方式验证和检查输入.

22.强制类型检查

1$amount=intval($_get['amount']);2$rate=(int)$_get['rate'];

这是个好习惯。

23.如果需要,使用profiler如xdebug

如果你使用php开发大型的应用,php承担了很多运算量,速度会是一个很重要的指标.使用profile帮助优化代码.可使用

xdebug和webgrid.

24.小心处理大数组

对于大的数组和字符串,必须小心处理.常见错误是发生数组拷贝导致内存溢出,抛出fatalerrorofmemorysize信息:

1$db_records_in_array_format;//thisisabigarrayholding1000rowsfromatableeachhaving20columns,everyrowisatleast100bytes,sototal1000*20*100=2mb23$cc=$db_records_in_array_format;//2mbmore45some_function($cc);//another2mb?

当导入或导出csv文件时,常常会这么做.

不要认为上面的代码会经常因内存限制导致脚本崩溃.对于小的变量是没问题的,但处理大数组的时候就必须避免.

确保通过引用传递,或存储在类变量中:

1$a=get_large_array();2pass_to_function(&$a);

这么做后,向函数传递变量引用(而不是拷贝数组).查看文档.

01classa02{03functionfirst()04{05$this->a=get_large_array();06$this->pass_to_function();07}0809functionpass_to_function()10{11//process$this->a12}13}

尽快的unset它们,让内存得以释放,减轻脚本负担.

25.由始至终使用单一数据库连接

确保你的脚本由始至终都使用单一的数据库连接.在开始处正确的打开连接,使用它直到结束,最后关闭它.不要像下面这样在函数中打开连接:

01functionadd_to_cart()02{03$db=newdatabase();04$db->query("insertintocart.....");05}0607functionempty_cart()08{09$db=newdatabase();10$db->query("deletefromcart.....");11}

使用多个连接是个糟糕的,它们会拖慢应用,因为创建连接需要时间和占用内存.

特定情况使用单例模式,如数据库连接.

26.避免直接写sql,抽象之

不厌其烦的写了太多如下的语句:

1$query="insertintousers(name,email,address,phone)values('$name','$email','$address','$phone')";2$db->query($query);//calltomysqli_query()

这不是个建壮的方案.它有些缺点:

>>每次都手动转义值

>>验证查询是否正确

>>查询的错误会花很长时间识别(除非每次都用if-else检查)

>>很难维护复杂的查询

因此使用函数封装:

01functioninsert_record($table_name,$data)02{03foreach($dataas$key=>$value)04{05//mysqli_real_escape_string06$data[$key]=$db->mres($value);07}0809$fields=implode(',',array_keys($data));10$values="'".implode("','",array_values($data))."'";1112//finalquery13$query="insertinto{$table}($fields)values($values)";1415return$db->query($query);16}1718$data=array('name'=>$name,'email'=>$email,'address'=>$address,'phone'=>$phone);1920insert_record('users',$data);

看到了吗?这样会更易读和扩展.record_data函数小心的处理了转义.

最大的优点是数据被预处理为一个数组,任何语法错误都会被捕获.

该函数应该定义在某个database类中,你可以像$db->insert_record这样调用.

查看本文,看看怎样让你处理数据库更容易.

类似的也可以编写update,select,delete方法.试试吧.

27.將数据库生成的内容缓存到静态文件中

如果所有的内容都是从数据库获取的,它们应该被缓存.一旦生成了,就將它们保存在临时文件中.下次请求该页面时,可直接从缓存中取,不用再查数据库.

好处:

>>节约php处理页面的时间,执行更快

>>更少的数据库查询意味着更少的mysql连接开销

28.在数据库中保存session

基于文件的session策略会有很多限制.使用基于文件的session不能扩展到集群中,因为session保存在单个服务器中.但数据库可被多个服务器访问,这样就可以解决问题.

在数据库中保存session数据,还有更多好处:

>>处理username重复登录问题.同个username不能在两个地方同时登录.

>>能更准备的查询在线用户状态.

29.避免使用全局变量

>>使用defines/constants

>>使用函数获取值

>>使用类并通过$this访问

30.在head中使用base标签

没听说过?请看下面:

1234567

base标签非常有用.假设你的应用分成几个子目录,它们都要包括相同的导航菜单.

www.domain.com/store/home.php

www.domain.com/store/products/ipad.php

在首页中,可以写:

1home2ipad

但在你的ipad.php不得不写成:

1home2ipad

因为目录不一样.有这么多不同版本的导航菜单要维护,很糟糕啊.

因此,请使用base标签.

12345home6ipad78

现在,这段代码放在应用的各个目录文件中行为都一致.

31.永远不要將error_reporting设为0

关闭不相的错误报告.e_fatal错误是很重要的.

1ini_set('display_errors',1);2error_reporting(~e_warning&~e_notice&~e_strict);

32.注意平台体系结构

integer在32位和64位体系结构中长度是不同的.因此某些函数如strtotime的行为会不同.

在64位的机器中,你会看到如下的输出.

1$php-a2interactiveshell34php>echostrtotime("0000-00-0000:00:00");5-621700052006php>echostrtotime('1000-01-30');7-306077396008php>echostrtotime('2100-01-30');94104930600

但在32位机器中,它们將是bool(false).查看这里,了解更多.

33.不要过分依赖set_time_limit

如果你想限制最小时间,可以使用下面的脚本:

1set_time_limit(30);23//restofthecode

高枕无忧吗?注意任何外部的执行,如系统调用,socket操作,数据库操作等,就不在set_time_limits的控制之下.

因此,就算数据库花费了很多时间查询,脚本也不会停止执行.视情况而定.

34.使用扩展库

一些例子:

>>mpdf--能通过html生成pdf文档

>>phpexcel--读写excel

>>phpmailer--轻松处理发送包含附近的邮件

>>pchart--使用php生成报表

使用开源库完成复杂任务,如生成pdf,ms-excel文件,报表等.

35.使用mvc框架

是时候使用像codeigniter这样的mvc框架了.mvc框架并不强迫你写面向对象的代码.它们仅將php代码与html分离.

>>明确区分php和html代码.在团队协作中有好处,设计师和程序员可以同时工作.

>>面向对象设计的函数能让你更容易维护

>>内建函数完成了很多工作,你不需要重复编写

>>开发大的应用是必须的

>>很多建议,技巧和hack已被框架实现了

36.时常看看phpbench

phpbench提供了些php基本操作的基准测试结果,它展示了一些徽小的语法变化是怎样导致巨大差异的.

相关文章
{{ v.title }}
{{ v.description||(cleanHtml(v.content)).substr(0,100)+'···' }}
你可能感兴趣
推荐阅读 更多>
推荐商标

{{ v.name }}

{{ v.cls }}类

立即购买 联系客服