PHP スキル: 高品質の PHP コードのための 50 の実践的なヒント (パート 1)

高品質の PHP コードのための 50 の実践的なヒント、気に入っていただければ幸いです。

1. 相対パスを使用しないでください:

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

このメソッドには多くの欠点があります。最初に指定された php インクルード パスを検索し、次に現在のディレクトリを検索します。チェックされるパスが多すぎます。スクリプトが別のディレクトリのスクリプトにインクルードされている場合、そのベース ディレクトリが、他のスクリプトが配置されているディレクトリになります。

もう 1 つの問題は、スケジュールされたタスクがスクリプトを実行するときに、その親ディレクトリが作業ディレクトリではない可能性があることです。したがって、最善の選択は絶対パスを使用することです:

view sourceprint?
 define('ROOT' , '/var/www/project/');
 require_once(ROOT . '../../lib/some_class.php');
 //rest of the code

絶対パスを定義しましたが、値はハードコーディングされています。パス /var/www/project も変更される可能性があるため、変更する必要があります。いいえ、次のような __FILE__ 定数を使用できます。

//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

これで、外部サーバーへの移動など、どのディレクトリに移動しても、コードは変更せずに正しく実行されます。

2 . require、include、include_once、required_once を直接使用しないでください。

次のようなクラス ライブラリ、ツール ファイル、ヘルパー関数などの複数のファイルをスクリプトの先頭に導入できます。より柔軟なヘルパー関数インクルード ファイルを作成する必要があります。

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');

また、同じファイルの複数のディレクトリを検索するなど、さらに多くのことを行うこともできます。クラスファイルを配置するディレクトリは、コード内で 1 つずつ変更することなく、簡単に変更できます。同様の関数を使用して、HTML コンテンツなどのファイルをロードすることができます

3. アプリケーションのコードのデバッグを継続します

開発環境では、データベース クエリ ステートメントを出力し、問題が解決されたら、問題のある変数値をダンプします。解決したら、コメントするか削除します。ただし、デバッグ コードは保存しておいた方がよいでしょう。開発環境では、次のことができます:

function load_class($class_name)
 {
 //path to the class file
 $path = ROOT . '/lib/' . $class_name . '.php');
 if(file_exists($path))
 {
 require_once( $path );
 }
 }

サーバーでは、次のことができます:

define('ENVIRONMENT' , 'development');
 if(! $db->query( $query )
 {
 if(ENVIRONMENT == 'development')
 {
 echo "$query failed";
 }
 else
 {
 echo "Database error. Please contact administrator";
 }
 }

4. クロスプラットフォーム関数を使用してコマンドを実行します

system、exec、passthru、shell_exec これら 4 つの関数を使用してシステムを実行できます。コマンド それぞれの動作は若干異なります。問題は、共有ホスティングでは特定の機能が選択的に無効になる可能性があることです。ほとんどの初心者は、使用する前に毎回どの機能が利用可能であるかを確認する傾向があります。より良い解決策は、関数をクロスプラットフォーム関数にカプセル化することです

利用可能なシステム関数がある限り、上記の関数はシェル コマンドを実行します。これにより、コードの一貫性が維持されます。関数を柔軟に使用できます

define('ENVIRONMENT' , 'production');
 if(! $db->query( $query )
 {
 if(ENVIRONMENT == 'development')
 {
 echo "$query failed";
 }
 else
 {
 echo "Database error. Please contact administrator";
 }
 }

単一の項目を追加するには、上の関数を使用します。また、項目のリストを追加する場合は、別の関数を作成する必要がありますか? いいえ、さまざまな種類のパラメーターに少し注意を払う必要があります。例:

/**
 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');

同じ関数でさまざまなタイプの入力パラメータを処理できるようになり、コードをよりスマートにリファクタリングできます

6。タグ

これについて言及した PHP アドバイス ブログ投稿が他にもたくさんある理由を知りたいです

function add_to_cart($item_id , $qty)
  
{
 $_SESSION['cart']['item_id'] = $qty;
 }
add_to_cart( 'IPHONE3' , 2 );

例を見てみましょう:

super_class.php ファイル

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) );

<?php
 echo "Hello";
 //Now dont close this tag

このようにすると、「ヘッダーはすでに送信されました」というエラーが発生します。これは、「スーパー エクストラ文字」が出力されているためです。これにより、スーパー エクストラの場所を見つけるのに時間がかかります。したがって、終了文字を省略する習慣を身につけてください:

 //super extra character after the closing tag
index.php

これはより良いでしょう。

7. すべての入力をどこかに集めて一度にブラウザに出力します

Function がある場合、これは出力バッファリングと呼ばれます。出力コンテンツ:

require_once('super_class.php');
 //echo an image or pdf , or set the cookies or session data

代わりに、出力を関数のローカル変数に保存するか、ob_start と ob_end_clean を使用できます。

<?php
 class super_class
 {
 function super_function()
 {
 //super code
 }
 }
 //No closing tag

出力バッファリングが必要な理由:
> str_replaces 関数や preg_replaces などの出力を変更するか、php 処理を同時に実行しながらブラウザに出力する必要があります。一部のサイトのサイドバーまたは中央にエラー メッセージが表示されることがありますが、これは処理と出力が混在しているためです。

8. HTML 以外のコンテンツが出力される場合は、正しい MIME タイプのヘッダー情報を送信してください。

XML を出力します。

function print_header()
 {
 echo "Site Log and Login links";
 }
 function print_footer()
 {
 echo "Site was made by me";
 }
 print_header();
 for($i = 0 ; $i < 100; $i++)
 {
 echo "I is : $i &#39;;
 }
print_footer();

は正常に動作します。ただし、ヘッダー行に注意してください。そのため、ブラウザはそれを正しく処理できます。多くの JavaScript ライブラリもヘッダー情報に依存します
同様のものには、javascript、css、jpg 画像、png 画像が含まれます:

function print_header()
 {
 $o = "Site Log and Login links";
 return $o;
 }
function print_footer()
 {
 $o = "Site was made by me";
 return $o;
 }
echo print_header();
 for($i = 0 ; $i < 100; $i++)
 {
 echo "I is : $i &#39;;
 }
 echo print_footer();

9 mysql 接続に正しい文字エンコーディングを設定します
mysql で unicode/utf が設定されていることに遭遇しました。 table-8エンコーディングでもphpadminでも正しく表示できますが、内容を取得してページに出力すると文字化けが発生します。

$xml = '';
 $xml = "0
 ";
//Send xml data
 echo $xml;

に接続すると、文字化けが発生します。アプリケーションが複数の言語をサポートしたい場合は、これが必要です

php5.4 より前の正しいエンコード オプションを設定します。の文字数は ISO-8859-1 であり、À âWait; などを直接出力することはできません。

$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 "Delaying for $sync_delay seconds...";
 sleep($sync_delay);
 echo "Done ";
 }

用静态变量取代:

//Delay for some time
 function delay()
 {
 static $sync_delay = null;
 if($sync_delay == null)
 {
 $sync_delay = get_option('sync_delay');
 }
 echo "Delaying for $sync_delay seconds...";
 sleep($sync_delay);
 echo "Done ";
 }

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 .....");
 }

使用多个连接是个糟糕的, 它们会拖慢应用, 因为创建连接需要时间和占用内存。特定情况使用单例模式, 如数据库连接.。

这个秘籍是不是很精彩，相信一定对大家学习php程序设计有所帮助。

相关文章：

php技巧篇：高质量php代码的50个实用技巧（下）