PHP 코드 품질을 향상시키는 36가지 전략에 대한 자세한 소개
- 黄舟원래의
- 2017-03-07 09:22:391325검색
PHP 코드 품질을 향상시키는 36가지 팁
1. 상대 경로를 사용하지 마세요
자주 보는 내용:
require_once('../../lib/some_class.php');
이 방법에는 많은 단점이 있습니다.
먼저 지정된 PHP 포함 경로를 찾은 다음 현재 디렉터리를 찾습니다.
검사되는 경로가 너무 많습니다.
스크립트가 다른 디렉터리의 스크립트에 포함된 경우 해당 기본 디렉터리는 다른 스크립트가 있는 디렉터리가 됩니다.
또 다른 문제는 예약된 작업이 스크립트를 실행할 때 해당 상위 디렉터리가 작업 디렉터리가 아닐 수 있다는 것입니다.
따라서 가장 좋은 옵션은 절대 경로를 사용하는 것입니다:
define('ROOT' , '/var/www/project/'); require_once(ROOT . '../../lib/some_class.php'); //rest of the code
절대 경로를 정의했고 값이 하드 코딩되어 있습니다. /var/www/project 경로도 변경될 수 있으므로 매번 변경해야 합니까? 아니요, __FILE__ 상수를 사용할 수 있습니다. as:
아아아아이제 외부 서버로 이동하는 등 어떤 디렉터리로 이동하더라도 코드가 변경 없이 올바르게 실행됩니다.
2. require, include, include_once, require_once
를 직접 사용하지 마세요. 클래스 라이브러리, 도구 파일,
//suppose your script is /var/www/project/index.php //Then __FILE__ will always have that full path. define('ROOT' , pathinfo(__FILE__, PATHINFO_DIRNAME)); require_once(ROOT . '../../lib/some_class.php'); //rest of the code
와 같은 도우미 함수 등 여러 파일을 스크립트 헤드에 도입할 수 있습니다. 이 사용법은 좀 더 유연해야 합니다. 예를 들면 다음과 같습니다.
require_once('lib/Database.php'); require_once('lib/Mail.php'); require_once('helpers/utitlity_functions.php');
코드가 더 읽기 쉬워졌나요?
향후 필요에 따라 다음과 같이 이 기능을 확장할 수 있습니다.
function load_class($class_name)
{
//path to the class file
$path = ROOT . '/lib/' . $class_name . '.php');
require_once( $path );
}
load_class('Database');
load_class('Mail');더 많은 일을 할 수 있습니다:
동일한 파일에 대한 여러 디렉터리 찾기
클래스 파일이 있는 디렉터리는 코드의 각 위치를 수정하지 않고도 쉽게 변경할 수 있습니다
유사한 기능을 사용하여 HTML 콘텐츠와 같은 파일을 로드할 수 있습니다.
3. 애플리케이션에 대한 디버깅 코드 유지
개발 환경에서는 데이터베이스 쿼리를 인쇄하고, 문제가 있는 변수 값을 덤프하고, 문제가 해결되면 주석을 달거나 삭제합니다. 그러나 더 나은 접근 방식은 디버그 코드를 유지하는 것입니다.
개발 환경에서는 다음을 수행할 수 있습니다.
rreee서버에서는 다음을 수행할 수 있습니다.
function load_class($class_name)
{
//path to the class file
$path = ROOT . '/lib/' . $class_name . '.php');
if(file_exists($path))
{
require_once( $path );
}
}4. 크로스 플랫폼 기능을 사용하여 명령 실행
System, exec, passthru, shell_exec 이 4가지 함수는 시스템 명령을 실행하는 데 사용할 수 있습니다. 각각의 동작은 약간 다릅니다. 문제는 공유 호스팅에서는 대부분의 초보자가 처음 확인할 때마다 특정 기능이 선택적으로 비활성화될 수 있다는 것입니다. 어떤 기능을 사용할 수 있는지 알아보고 사용하세요.
더 나은 해결책은 해당 기능을 크로스 플랫폼 기능으로 캡슐화하는 것입니다.
define('ENVIRONMENT' , 'development');
if(! $db->query( $query )
{
if(ENVIRONMENT == 'development')
{
echo "$query failed";
}
else
{
echo "Database error. Please contact administrator";
}
}위 함수는 시스템 함수가 사용 가능한 한 쉘 명령을 실행하여 코드 일관성을 유지합니다.
5. 함수를 유연하게 작성
아아아위의 기능을 사용하여 단일 항목을 추가할 때 다른 기능을 만들어야 합니까? 아니요, 다양한 유형의 매개변수에 주의를 기울이면 더 유연해집니다. :
아아아아이제 동일한 함수로 다양한 유형의 입력 매개변수를 처리할 수 있으며 위의 예를 참조하여 코드의 여러 부분을 리팩터링하여 더욱 스마트하게 만들 수 있습니다.
6. PHP 닫는 태그를 의도적으로 무시
PHP 조언에 관한 수많은 블로그 게시물에서 왜 이 내용이 언급되지 않는지 알고 싶습니다.
define('ENVIRONMENT' , 'production');
if(! $db->query( $query )
{
if(ENVIRONMENT == 'development')
{
echo "$query failed";
}
else
{
echo "Database error. Please contact administrator";
}
}이렇게 하면 시간이 많이 절약될 것입니다. 예를 들어 보겠습니다.
super_class.php 파일
/**
Method to execute a command in the terminal
Uses :
1. system
2. passthru
3. exec
4. shell_exec
*/
function terminal($command)
{
//system
if(function_exists('system'))
{
ob_start();
system($command , $return_var);
$output = ob_get_contents();
ob_end_clean();
}
//passthru
else if(function_exists('passthru'))
{
ob_start();
passthru($command , $return_var);
$output = ob_get_contents();
ob_end_clean();
}
//exec
else if(function_exists('exec'))
{
exec($command , $output , $return_var);
$output = implode("\n" , $output);
}
//shell_exec
else if(function_exists('shell_exec'))
{
$output = shell_exec($command) ;
}
else
{
$output = 'Command execution not possible on this system';
$return_var = 1;
}
return array('output' => $output , 'status' => $return_var);
}
terminal('ls');index.php
아아아앙이렇게 하면 헤더가 이미 전송되었습니다. 이유는 무엇입니까? 이제 디버깅을 시작해야 합니다. 슈퍼 엑스트라의 위치를 찾는 데 시간이 많이 걸립니다.
따라서 닫는 문자를 생략하는 습관을 들이세요:
function add_to_cart($item_id , $qty)
{
$_SESSION['cart']['item_id'] = $qty;
}
add_to_cart( 'IPHONE3' , 2 );
이게 더 좋을 것 같아요
7. 모든 입력을 어딘가에 모아서 한번에 브라우저에 출력
이를 출력 버퍼링이라고 합니다.
function add_to_cart($item_id , $qty)
{
if(!is_array($item_id))
{
$_SESSION['cart']['item_id'] = $qty;
}
else
{
foreach($item_id as $i_id => $qty)
{
$_SESSION['cart']['i_id'] = $qty;
}
}
}
add_to_cart( 'IPHONE3' , 2 );
add_to_cart( array('IPHONE3' => 2 , 'IPAD' => 5) );와 같이 다양한 기능으로 출력이 있다고 가정해 보겠습니다. 또는 출력을 중앙에서 수집하여 함수의 로컬 변수에 저장하거나 다음과 같이 ob_start 및 ob_end_clean을 사용할 수 있습니다. 출력 버퍼링이 필요한 이유:
>>str_replaces 기능이나 preg_replaces 등 브라우저로 보내기 전에 출력을 변경하거나 일부 모니터링/디버깅 HTML 콘텐츠를 추가할 수 있습니다.
>>PHP를 처리하면서 브라우저에 출력하는 것이 끔찍합니다. 일부 사이트에서 사이드바나 중간에 오류 메시지가 나타나는 것을 보셨을 것입니다. 왜 그런 일이 발생하는지 아십니까?
8. HTML이 아닌 콘텐츠가 출력되는 경우 올바른 MIME 유형 헤더 정보를 보냅니다.
일부 XML을 출력합니다.
<?php echo "Hello"; //Now dont close this tag
잘 작동하지만 개선이 필요합니다.
아아아아헤더 줄에 주의하세요. 이 줄은 전송된 콘텐츠가 xml 유형임을 브라우저에 알려줍니다. 따라서 브라우저는 이를 올바르게 처리할 수 있습니다.
유사한 것에는 javascript, CSS, jpg 이미지, png 이미지가 포함됩니다.
자바스크립트
아아아아CSS
아아아아9. mysql 연결에 대한 올바른 문자 인코딩을 설정하세요
유니코드/utf-8 인코딩이 mysql 테이블에 설정되어 있고 phpadmin이 이를 올바르게 표시할 수 있지만 콘텐츠를 가져와서 페이지에 출력하면 문자 인코딩이 깨져 나타나는 것을 발견했습니다. mysql 연결
//Attempt to connect to database
$c = mysqli_connect($this->host , $this->username, $this->password);
//Check connection validity
if (!$c)
{
die ("Could not connect to the database host: <br />". mysqli_connect_error());
}
//Set the character set of the connection
if(!mysqli_set_charset ( $c , 'UTF8' ))
{
die('mysqli_set_charset() failed');
}一旦连接数据库, 最好设置连接的 characterset. 你的应用如果要支持多语言, 这么做是必须的.
10. 使用 htmlentities 设置正确的编码选项
php5.4前, 字符的默认编码是ISO-8859-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内容:
$images = array(
'myself.png' , 'friends.png' , 'colleagues.png'
);
$js_code = '';
foreach($images as $image)
{
$js_code .= "'$image' ,";
}
$js_code = 'var images = [' . $js_code . ']; ';
echo $js_code;
//Output is var images = ['myself.png' ,'friends.png' ,'colleagues.png' ,];更聪明的做法, 使用 json_encode:
$images = array( 'myself.png' , 'friends.png' , 'colleagues.png' ); $js_code = 'var images = ' . json_encode($images); echo $js_code; //Output is : var images = ["myself.png","friends.png","colleagues.png"]
优雅乎?
13. 写文件前, 检查目录写权限
写或保存文件前, 确保目录是可写的, 假如不可写, 输出错误信息. 这会节约你很多调试时间. linux系统中, 需要处理权限, 目录权限不当会导致很多很多的问题, 文件也有可能无法读取等等.
确保你的应用足够智能, 输出某些重要信息.
$contents = "All the content"; $file_path = "/var/www/project/content.txt"; file_put_contents($file_path , $contents);
这大体上正确. 但有些间接的问题. file_put_contents 可能会由于几个原因失败:
>>父目录不存在
>>目录存在, 但不可写
>>文件被写锁住?
所以写文件前做明确的检查更好.
$contents = "All the content";
$dir = '/var/www/project';
$file_path = $dir . "/content.txt";
if(is_writable($dir))
{
file_put_contents($file_path , $contents);
}
else
{
die("Directory $dir is not writable, or does not exist. Please check");
}这么做后, 你会得到一个文件在何处写及为什么失败的明确信息.
14. 更改应用创建的文件权限
在linux环境中, 权限问题可能会浪费你很多时间. 从今往后, 无论何时, 当你创建一些文件后, 确保使用chmod设置正确权限. 否则的话, 可能文件先是由"php"用户创建, 但你用其它的用户登录工作, 系统將会拒绝访问或打开文件, 你不得不奋力获取root权限, 更改文件的权限等等.
// Read and write for owner, read for everybody else
chmod("/somedir/somefile", 0644);
// Everything for owner, read and execute for others
chmod("/somedir/somefile", 0755);15. 不要依赖submit按钮值来检查表单提交行为
if($_POST['submit'] == 'Save')
{
//Save the things
}上面大多数情况正确, 除了应用是多语言的. 'Save' 可能代表其它含义. 你怎么区分它们呢. 因此, 不要依赖于submit按钮的值.
if( $_SERVER['REQUEST_METHOD'] == 'POST' and isset($_POST['submit']) )
{
//Save the things
}现在你从submit按钮值中解脱出来了.
16. 为函数内总具有相同值的变量定义成静态变量
//Delay for some time
function delay()
{
$sync_delay = get_option('sync_delay');
echo "<br />Delaying for $sync_delay seconds...";
sleep($sync_delay);
echo "Done <br />";
}用静态变量取代:
//Delay for some time
function delay()
{
static $sync_delay = null;
if($sync_delay == null)
{
$sync_delay = get_option('sync_delay');
}
echo "<br />Delaying for $sync_delay seconds...";
sleep($sync_delay);
echo "Done <br />";
}17. 不要直接使用 $_SESSION 变量
某些简单例子:
$_SESSION['username'] = $username; $username = $_SESSION['username'];
这会导致某些问题. 如果在同个域名中运行了多个应用, session 变量可能会冲突. 两个不同的应用可能使用同一个session key. 例如, 一个前端门户, 和一个后台管理系统使用同一域名.
从现在开始, 使用应用相关的key和一个包装函数:
define('APP_ID' , 'abc_corp_ecommerce');
//Function to get a session variable
function session_get($key)
{
$k = APP_ID . '.' . $key;
if(isset($_SESSION[$k]))
{
return $_SESSION[$k];
}
return false;
}
//Function set the session variable
function session_set($key , $value)
{
$k = APP_ID . '.' . $key;
$_SESSION[$k] = $value;
return true;
}18. 將工具函数封装到类中
假如你在某文件中定义了很多工具函数:
function utility_a()
{
//This function does a utility thing like string processing
}
function utility_b()
{
//This function does nother utility thing like database processing
}
function utility_c()
{
//This function is ...
}这些函数的使用分散到应用各处. 你可能想將他们封装到某个类中:
class Utility
{
public static function utility_a()
{
}
public static function utility_b()
{
}
public static function utility_c()
{
}
}
//and call them as
$a = Utility::utility_a();
$b = Utility::utility_b();显而易见的好处是, 如果php内建有同名的函数, 这样可以避免冲突.
另一种看法是, 你可以在同个应用中为同个类维护多个版本, 而不导致冲突. 这是封装的基本好处, 无它.
19. Bunch of silly tips
>>使用echo取代print
>>使用str_replace取代preg_replace, 除非你绝对需要
>>不要使用 short tag
>>简单字符串用单引号取代双引号
>>head重定向后记得使用exit
>>不要在循环中调用函数
>>isset比strlen快
>>始中如一的格式化代码
>>不要删除循环或者if-else的括号
不要这样写代码:
if($a == true) $a_count++;
这绝对WASTE.
写成:
if($a == true)
{
$a_count++;
}不要尝试省略一些语法来缩短代码. 而是让你的逻辑简短.
>>使用有高亮语法显示的文本编辑器. 高亮语法能让你减少错误.
20. 使用array_map快速处理数组
比如说你想 trim 数组中的所有元素. 新手可能会:
foreach($arr as $c => $v)
{
$arr[$c] = trim($v);
}但使用 array_map 更简单:
$arr = array_map('trim' , $arr);
这会为$arr数组的每个元素都申请调用trim. 另一个类似的函数是 array_walk. 请查阅文档学习更多技巧.
21. 使用 php filter 验证数据
你肯定曾使用过正则表达式验证 email , ip地址等. 是的,每个人都这么使用. 现在, 我们想做不同的尝试, 称为filter.
php的filter扩展提供了简单的方式验证和检查输入.
22. 强制类型检查
$amount = intval( $_GET['amount'] ); $rate = (int) $_GET['rate'];
这是个好习惯.
23. 如果需要,使用profiler如xdebug
如果你使用php开发大型的应用, php承担了很多运算量, 速度会是一个很重要的指标. 使用profile帮助优化代码. 可使用
xdebug和webgrid.
24. 小心处理大数组
对于大的数组和字符串, 必须小心处理. 常见错误是发生数组拷贝导致内存溢出,抛出Fatal Error of Memory size 信息:
$db_records_in_array_format; //This is a big array holding 1000 rows from a table each having 20 columns , every row is atleast 100 bytes , so total 1000 * 20 * 100 = 2MB $cc = $db_records_in_array_format; //2MB more some_function($cc); //Another 2MB ?
当导入或导出csv文件时, 常常会这么做.
不要认为上面的代码会经常因内存限制导致脚本崩溃. 对于小的变量是没问题的, 但处理大数组的时候就必须避免.
确保通过引用传递, 或存储在类变量中:
$a = get_large_array(); pass_to_function(&$a);
这么做后, 向函数传递变量引用(而不是拷贝数组). 查看文档.
class A
{
function first()
{
$this->a = get_large_array();
$this->pass_to_function();
}
function pass_to_function()
{
//process $this->a
}
}尽快的 unset 它们, 让内存得以释放,减轻脚本负担.
25. 由始至终使用单一数据库连接
确保你的脚本由始至终都使用单一的数据库连接. 在开始处正确的打开连接, 使用它直到结束, 最后关闭它. 不要像下面这样在函数中打开连接:
function add_to_cart()
{
$db = new Database();
$db->query("INSERT INTO cart .....");
}
function empty_cart()
{
$db = new Database();
$db->query("DELETE FROM cart .....");
}使用多个连接是个糟糕的, 它们会拖慢应用, 因为创建连接需要时间和占用内存.
特定情况使用单例模式, 如数据库连接.
26. 避免直接写SQL, 抽象之
不厌其烦的写了太多如下的语句:
$query = "INSERT INTO users(name , email , address , phone) VALUES('$name' , '$email' , '$address' , '$phone')"; $db->query($query); //call to mysqli_query()
这不是个建壮的方案. 它有些缺点:
>>每次都手动转义值
>>验证查询是否正确
>>查询的错误会花很长时间识别(除非每次都用if-else检查)
>>很难维护复杂的查询
因此使用函数封装:
function insert_record($table_name , $data)
{
foreach($data as $key => $value)
{
//mysqli_real_escape_string
$data[$key] = $db->mres($value);
}
$fields = implode(',' , array_keys($data));
$values = "'" . implode("','" , array_values($data)) . "'";
//Final query
$query = "INSERT INTO {$table}($fields) VALUES($values)";
return $db->query($query);
}
$data = array('name' => $name , 'email' => $email , 'address' => $address , 'phone' => $phone);
insert_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标签
没听说过? 请看下面:
<head> <base href="http://www.domain.com/store/"> </head> <body> <img src="happy.jpg" /> </body> </html>
base 标签非常有用. 假设你的应用分成几个子目录, 它们都要包括相同的导航菜单.
www.domain.com/store/home.php
www.domain.com/store/products/ipad.php
在首页中, 可以写:
<a href="home.php">Home</a> <a href="products/ipad.php">Ipad</a>
但在你的ipad.php不得不写成:
<a href="../home.php">Home</a> <a href="ipad.php">Ipad</a>
因为目录不一样. 有这么多不同版本的导航菜单要维护, 很糟糕啊.
因此, 请使用base标签.
<a href="home.php">Home</a> <a href="products/ipad.php">Ipad</a>