PHP プログラマーのためのデバッグ手法のまとめ_PHP チュートリアル

この記事では、Apache や PHP でエラー報告を有効にすることや、単純な PHP スクリプトに print ステートメントを戦略的に配置してより困難なバグの原因を見つけることなど、PHP アプリケーションをデバッグするさまざまな方法について説明します。また、リアルタイム構文解析機能を備えた柔軟な開発環境である Eclipse 用の PHPEclipse プラグイン、および PHPEclipse 用の DBG デバッガー拡張機能についても学習します。
はじめに
コーディング時に大幅な時間を節約できる PHP デバッグ手法が多数あります。効果的かつ基本的なデバッグ手法は、エラー報告を有効にすることです。もう 1 つの少し高度なテクニックには、print ステートメントの使用が含まれます。これは、実際に画面に表示される内容を表示することで、見つけにくいバグを正確に特定するのに役立ちます。 PHPEclipse は、一般的な構文エラーを強調表示する Eclipse プラグインで、デバッガーと組み合わせて使用​​してブレークポイントを設定できます。

セットアップ
この記事で説明されている概念を学ぶには、PHP、Web サーバー、および Eclipse が必要です。デバッガー拡張機能は、PHP バージョン V5.0.3 をサポートします。
PHP で作成されたページを解析してブラウザに表示するには、Web サーバーが必要です。この記事ではApache2を使用しています。ただし、どの Web サーバーでも十分です。
この記事で紹介したデバッグ手法の一部を利用するには、Eclipse V3.1.1 とプラグイン PHPEclipse V1.1.8 をインストールする必要があります。 Eclipse には Java™ テクノロジーが必要なので、Java™ テクノロジーもダウンロードしてください。
PHP デバッガー拡張モジュールも必要です。取り付けは少し面倒です。デバッガー拡張機能のインストール手順に慎重に従ってください。次に、php.ini ファイル内の、PHP 拡張機能のロードと構成を必要とする行をコメント アウトします。デバッガを使用する必要がある場合は、コメントを解除してください。
ダウンロード情報については、「リソース」を参照してください。次にエラーメッセージについてです。

エラー メッセージ
エラー メッセージは、開発者としての防御の最前線です。エラー メッセージを表示するように構成されていないサーバー上で PHP でコードを開発したい人はいません。ただし、コードをデバッグし、実行する準備ができたら、エラー レポートがオフになっていることを確認する必要があります。これは、サイト訪問者にエラー メッセージが表示されることを望まないためです。これにより、エラー メッセージを悪用するのに十分な情報が提供されてしまいます。サイトの弱点とサイトをハッキングします。
エラーをスローまたは生成した正しいコード行を示すエラー メッセージを利用することもできます。このように、デバッグは、生成されたエラーが表示される行番号をブラウザーで調べ、コード内のその行を検査することになります。後で、PHPEclipse プラグインが、その場で構文エラーに下線を引いたり、ファイルを保存するときに赤い "x" でマークしたりすることで、開発やデバッグ中に非常に役立つことがわかります。
まず、エラーレポートを有効にし、php.ini ファイルでエラーレポートのレベルを設定する方法を見てみましょう。次に、Apache の構成ファイルでこれらの設定をオーバーライドする方法を学びます。
PHP のエラーレポート
php.ini ファイルには多くの構成設定があります。 Linux に PHP および Apache 2 をインストールする手順 (「参考文献」を参照) に記載されているように、php.ini ファイルを設定し、適切なディレクトリに配置しておく必要があります。 PHP アプリケーションをデバッグするときに注意すべき構成変数が 2 つあります。 2 つの変数とそのデフォルト値は次のとおりです:

コードをコピーします コードは次のとおりです:

display_errors = Off
error_reporting = E_ALL

これら 2 つは、php で検索すると見つかります。 .ini ファイル 変数の現在のデフォルト値。 display_errors 変数の目的は明らかです。この変数は、エラーを表示するかどうかを PHP に指示します。デフォルト値はオフです。ただし、開発プロセスを容易にするために、この値を On に設定します。

コードをコピー コードは次のとおりです:

display_errors = On

error_reporting error_reporting 変数のデフォルト値は E_ALL です。この設定では、不適切なコーディング方法から無害なヒント、エラーに至るまで、あらゆるものが表示されます。 E_ALL は、ブラウザの出力を混乱させる小さな事柄 (変数が初期化されていないなど) についてのヒントも画面上に表示するため、開発目的には少し粒度が高すぎます。私が知りたいのはエラーと不適切なコーディング方法だけであり、無害なヒントは知りたいわけではありません。そのため、error_reporting のデフォルト値を次の値に置き換えてください:

コードをコピーします コードは次のとおりです:

error_reporting = E_ALL & ~E_NOTICE

Apache を再起動すれば準備完了です。次に、Apache で同じことを行う方法を学びます。
サーバー上のエラーレポート
コンピューター上に複数のバージョンの PHP が存在する可能性があるため、Apache の動作によっては、PHP でエラーレポートを有効にしても機能しない場合があります。 Apache は 1 つの php.ini ファイルしか参照できないため、Apache が使用している PHP バージョンを判断することが難しい場合があります。 Apache が自身の設定にどの php.ini ファイルを使用しているかわからないことは、セキュリティ上の問題です。ただし、正しいエラー レベルが設定されるように Apache で PHP 変数を構成する方法があります。
また、サーバー側でこれらの構成変数を設定して php.ini ファイルをオーバーライドまたはプリエンプトして、より高いレベルのセキュリティを提供する方法を知っておくとよいでしょう。
Apache を構成するときは、/conf/httpd.conf にある http.conf ファイルの基本構成がすでに公開されている必要があります。
php.ini ファイルで既に行ったことを行うには、次の行を httpd.conf に追加し、php.ini ファイルを上書きします:

コードをコピーします コードは次のとおりです:

php_flag display_errors on
php_value error_reporting 2039

これは、php.ini ファイル内の display_errors にすでに設定されているフラグと error_reporting の値をオーバーライドします。値 2039 は E_ALL および ~E_NOTICE を表します。 E_ALL を使用する場合は、値を 2047 に設定します。繰り返しますが、Apache を再起動する必要があります。
次に、サーバーでのエラー報告をテストします。
エラーレポートのテスト
エラーレポートを有効にすると、時間を大幅に節約できます。 PHP のエラーはコード内のエラーを示しています。単純な PHP ファイル test.php を作成し、リスト 1 に示すように定義します。
リスト 1. エラーを生成する単純な PHP

コードをコピーします コードは次のとおりです。

print("The next line generated an error.
");
printaline(" PLEASE?");
print("上記のエラーのため表示されません。");

最初の print() ステートメントは、その内容を Web ブラウザーに表示します。ただし、2 番目のステートメントではエラーが生成され、Web ページに表示されます。これにより、図 1 に示すように、最後の print() ステートメントが機能しなくなります。

図 1. 生成エラー

バグレポートが有効になりました!次に、print ステートメントを使用してアプリケーションのデバッグを支援します。

print ステートメントの紹介
アプリケーションの機能的なバグはエラーを生成しないため、PHP アプリケーションをデバッグするために print または die ステートメントを適切に配置して使用する方法の知識は、すべてのデバッグ戦略において大きな資産となります。 print ステートメントを使用すると、コード内で問題のあるステートメントの位置を絞り込むことができます。これらのステートメントには構文エラーはなく、バグではありませんが、コードの機能という点ではバグです。これらはエラーをスローしないため、発見してデバッグするのが最も難しいバグです。分かっているのは、ブラウザに表示されているコンテンツが希望のものではないか、データベースに保存したいコンテンツがまったく保存されていないことだけです。
GET リクエストを通じて送信されたフォーム データを処理しており、ブラウザーに情報を表示したいと考えていますが、何らかの理由でデータが正しく送信されていないか、GET リクエストからデータを正しく読み取ることができないとします。このタイプの問題をデバッグするには、print() または die() ステートメントを使用して変数の値が何であるかを知ることが重要です。
die() ステートメントはプログラムの実行を停止し、Web ブラウザーにテキストを表示します。 die() ステートメントは、コードをコメントアウトしたくない場合や、エラーの前の情報とエラー メッセージのみを表示し、それ以降の情報は表示したくない場合に特に便利です。
PHP の print ステートメントを使用してこの概念をテストしてみましょう
デバッグに print ステートメントを使用します
プログラマーとして Linux® でアプリケーションを開発していたとき、どこにバグがあるかをすぐに教えてくれる便利な GUI はありませんでした。プログラムに print ステートメントを多く入れるほど、バグをアプリケーション内の 1 行に絞り込める可能性が高くなることがわかりました。別の PHP ファイル test2.php を作成し、リスト 2 に示すように定義します。

リスト 2. GET 経由で送信されたすべての変数を表示します

コードをコピーします コードは次のとおりです:

$j = "";
print("GET リクエスト経由でスクリプトを取得します。"); as $key => $i){
print("$key=$j
");
}
if($_GET['Submit'] == "GET リクエストを送信")
$j = "完了しました!
";
?>

名前:

メール:

非常に簡単にリスト 2 にはバグがあります。あなたは素晴らしいです！ただし、これは非常に単純なスクリプトであり、デバッグに print ステートメントを使用する例として示されているだけであることに注意してください。このスクリプトは、GET リクエストからすべての変数を単純に抽出し、存在する場合はブラウザーに表示します。テスト用の GET リクエストで変数をサーバーに送信するためのフォームも提供されています。図 2 に示す出力を見てください。

図 2. test2.php の出力


ここで、GET リクエストを送信

ボタンをクリックします。ブラウザには $_GET<font face="新宋体"> リクエストされたキーのみが表示され、正しい値は表示されないことに注意してください。ループ内に print ステートメントを入れると、</font>foreach<font face="新宋体"> ループ内の各要素にデータが実際に存在するかどうかを確認できます。リスト 3 を参照してください。 </font>リスト 3. print ステートメントを使用してコードの機能を確認します

コードをコピーします コードは次のとおりです:

...

foreach($_GET as $key => $i){
print("正しいデータですか? " . $_GET[$key] . "
");
}
...


放进去的 print 语句是粗体。注意，现在已经知道在 Web 浏览器上显示的 $key 值是正确的，但是由于某些原因，值没有正确地显示。请看新的输出，如图 3 所示。
图 3. 修改后的 test2.php 的输出

现在已经知道应用程序正确地从 <font face="新宋体">GET</font> 请求接收到了变量，那么肯定是在代码中有 bug。查看之后注意到，用来显示值的变量 <font face="新宋体">$j</font> 是错误的。在 <font face="新宋体">foreach</font> 语句中指定的是 <font face="新宋体">$i</font>，所以它肯定会有正确的值，但是无意之中输入了 <font face="新宋体">$j</font>。所以通过把 <font face="新宋体">$j</font> 替换成 <font face="新宋体">$i</font>，迅速地修正了错误，重新载入页面之后，就看到了正确的输出，如图 4 所示。

图 4. 修正后的 test2.php 的输出

现在可以删除或注释掉刚才添加的 print 语句了，因为已经发现了代码中的 bug。注意，这只是在调试应用程序时可能遇到的许多错误中的一个很小的子集。对于使用数据库时可能遇到的问题，一个好的解决方案是输出 SQL 语句，以确保执行的 SQL 就是想要执行的。

现在要来看看如何使用 Eclipse IDE 和 PHPEclipse 插件及调试器扩展进一步在调试历程中提供帮助。

使用 PHPEclipse

您可能用过 Eclipse，但是可能不熟悉它。请参阅 参考资料 获得 Eclipse 平台的介绍。

用于 Eclipse 的 PHPEclipse 插件是用来开发 PHP 应用程序的一个流行工具。请启动 Eclipse 并把工作区目录指定为 Apache 的 www 目录（在我的机器上是 c:\www）。现在单击 File > New > Project。会弹出 New Project 向导。双击 PHP 文件夹并选择 PHP Project。单击 Next，输入项目名称 debugArticle，并单击 Finish。

如果把 Web 服务器设置为在端口 80 上侦听，那么不需要做任何修改。否则，请转到 Navigator 窗口，在 PHP 项目 debugArticle 上右击，选择 Properties，然后单击 PHP Project Settings。单击 Configure Workspace Settings 然后修改合适的 localhost 或者添加 Web 服务器侦听的端口（例如 http://localhost:8080）。单击 Apply 完成设置。

Navigator 窗口应当显示项目和一个 .project 文件。在项目上右击，就像前面做的那样，只是这次选择 New > PHP File。用想要创建的 PHP 文件的名称 test3.php 替换 *.php，然后单击 Finish。在 Eclipse IDE 中应当出现一个新文件。可能需要导航到窗口底部的 PHP 浏览器来查看 PHP 文件的当前输出（参见图 5）。

图 5. Eclipse 的 PHPEclipse 插件

注意，只有 Windows® 的用户可以像清单 5 所示的那样使用 PHP 浏览器。通过打开独立浏览器窗口并把浏览器指向测试脚本所在目录，也可以使用同样的功能。

现在来演示这个应用程序，证明它的强大能力。

在 “使用调试器” 一节中，将学习如何用 Eclipse、PHPEclipse 和前面下载的调试器 PHP 扩展来调试 PHP 应用程序。先从学习如何使用它的语法解析功能开始。

语法解析和加下划线

先从查看 PHPEclipse 如何提供帮助调试 PHP 应用程序的实时语法解析功能开始。要看这个特性的实际应用，先从在 Eclipse 中定义 test3.php 开始，如下所示。

<?php
print(,"Hello World!");
?>

注意，在清单 4 中加下划线的两个字符在 Eclipse 中加了下划线，提示语法不正确。按 Ctrl+S 保存文件，会在 Eclipse 中显示解析错误：在代码中与解析错误对应的行上会加上红 “x”，如图 6 所示。

图 6. 语法错误强调

现在演示 PHP 浏览器。这个窗口提供了当前 PHP 脚本的预览，如图 6 所示。

从上面定义的 test3.php 中删除逗号（<font face="新宋体">,</font>）。按 Ctrl+S 保存文件，然后观察 PHP 浏览器窗口的更新，显示了 Hello World（参见图 7）。

图 7. 在 PHPEclipse 中预览 PHP 脚本

下面是用调试器在 PHP 中设置断点。

使用调试器

使用调试器，可以设置断点并查看 PHP 代码到所设断点之前的浏览器输出。然后可以继续代码的执行并查看到下一断点之前的浏览器输出，然后再到下一个，直到 PHP 脚本完成。

现在把 “设置” 一节中在 php.ini 中注释掉的行取消注释，并重新启动 Apache。现在装入了调试器，Eclipse 能够和它挂上了。

现在在 Eclipse 中设计调试环境。请创建新的 test4.php 文件，先保持为空。现在单击 Run > Debug。在左侧面板中选择 PHP DBG Script，并单击 New。现在转到 File 选项卡，输入当前项目 debugArticle 以及想要调试的文件 test4.php。现在转到 Environment 选项卡，然后再到 Interpreter 子选项卡。在 PHP 的安装目录中找到 php.exe 文件（我的是 c:\apps\php5.0.3\php.exe）。现在单击 Remote Debug 子选项卡，选择 Remote Debug，如果没有使用 Windows，请取消 “Open with DBGSession URL in internal browser box” 复选框。把 Remote Source 路径设置成与要测试的 PHP 脚本的绝对路径（不是 Web 路径）相同（我的设置是 c:\www\debugArticle\test4.php）。现在单击 Debug。

现在应当装入 Debug 透视图，如图 8 所示。否则，请单击 Window > Open Perspective > Other，并选择 Debug。

图 8. Eclipse 中的 Debug 透视图

现在可以设置断点了。

对于本文中使用的插件和扩展的版本，断点功能是必需的，因为 PHP 在把输出发送到浏览器之前会缓冲它。除此之外，需要做的不仅仅是设置一个断点把当前显示数据刷新到 Web 浏览器，所以要像下面和图 8 所示那样定义 test4.php。

清单 4. 设置和创建断点

<?php
function break-point(){
  ob_flush();
  flush();
  sleep(.1);
  debugBreak();
}
print("This will get shown first, ");
print("as will this<br>");
breakpoint();
print("This won't get shown until after ");
print("continuing the break-point<br>");
breakpoint();
print("END!");
?

<font face="新宋体">breakpoint()</font> 函数会把缓冲的输出和其他缓冲的数据刷新到 Web 浏览器。对 <font face="新宋体">sleep(.1)</font> 的调用是必需的，这样代码中止于 <font face="新宋体">debugBreak()</font> 之前，服务器才有足够的时间把数据刷新到 Web 浏览器，这个函数是前面下载的 PHP 调试器扩展的内部函数。这样，调用 <font face="新宋体">breakpoint()</font> 会把 HTML 块、<font face="新宋体">print()</font> 和 <font face="新宋体">echo()</font> 语句的数据刷新到浏览器，然后中止代码执行。

在像清单 4 那样编写完代码之后，可以打开浏览器并指向 test4.php，或者可以查看 PHP 浏览器窗口（我的是 http://localhost/debugArticle/test4.php）。每次输入和保存文件时，在 PHP 浏览器窗口中就已经启动了调试序列。如果不使用 Windows，请通过浏览器查看 test4.php。在保存了文件之后，用 F8 或单击 Run > Resume 继续代码执行。持续这么做，直到最后一行输出是 <font face="新宋体">END!</font> 为止（参见图 9、10 和 11）。

图 9. 初始的到第一个断点的 PHP 浏览器输出

请注意图 9 中的 Debug 窗口如何把执行显示为挂起的。

图 10. 第一个断点之后到第二个断点之前的 PHP 浏览器输出

图 10 的 Debug 窗口仍然把执行显示为挂起，而第二组数据显示在 PHP 浏览器中。

图 11. 完整的 PHP 浏览器输出

注意，图 11 的 Debug 窗口中的代码不再挂起，整个脚本已经执行，如图 11 中的 PHP 浏览器所示。

既然已经看到了用 PHPEclipse 和调试器扩展进行开发的优势，那么很难想像没有它会怎么样。

结束语

现在已经向 PHP 的调试技术集中添加了错误报告的运用、print 语句、PHPEclipse 和调试器扩展，您可以通过减少每行代码的错误数量，成为更有效的 PHP 编码人员。请参阅 参考资料 获得一些 PHP 教程，可以在上面测试这些新技能。

下载 Sample code for PHP Debugging

参考资料

学习

• 您可以参阅本文在 developerWorks 全球站点上的 英文原文。
  
  
• 学习如何在基于 Windows 和 UNIX® 的系统上 安装 Java。
  
  
• 请访问 Eclipse.org 获得编程和如何使用它的全面信息。
  
  
• “Eclipse 平台入门”（developerWorks，2002 年 11 月）提供了 Eclipse 的历史和概述，包括如何安装 Eclipse 和插件的细节。
  
  
• 请访问 PHPEclipse 学习关于安装 PHPEclipse 和如何使用它的更多内容。
  
  
• DBG 是一个全功能的 PHP 调试器引擎，一个交互的工具，有助于调试 PHP 脚本。请阅读 Installing and configuring the debugger 上的这份教程。
  
  
• 要学习关于 Eclipse 的更多内容，请访问 developerWorks 的 Eclipse project resources。
  
  
• 要学习关于 PHP 的更多内容，请访问 developerWorks 的 PHP project resources。
  
  
• 请参阅 PHP 手册获得更多关于 error reporting 的内容。
  
  
• 请阅读安装 PHP and Apache2 on Linux 的操作说明。
  
  
• 请阅读安装 PHP and Apache2 on Windows 的操作说明。
  
  
• 要获得一系列学习 PHP 编程的 developerWorks 教程，请参阅 “学习 PHP，第 1 部分”、学习 PHP，第 2 部分 和 学习 PHP，第 3 部分。
  
  
• 请密切关注 developerWorks technical events and webcasts。
  
  
• 请访问 developerWorks 开放源码专区 获得丰富的 how-to 信息、工具和项目更新，有助于用开放源码技术进行开发并把它们用于 IBM 的产品。
  
  

获得产品和技术

• PHP.net から PHP の最新バージョンをダウンロードしてください。
  
  
• Apache 2の最新バージョンをダウンロードしてください。
  
  Sun Corporation から
• Java テクノロジー をダウンロードしてください。
  
  最新バージョンの
• Eclipse を Eclipse.org からダウンロードしてください。
  
  Sourceforge から
• PHPEclipse をダウンロードします。 Eclipse を eclipse-install-dir に抽出し、次に PHPEclipse を eclipse-install-dir に抽出します。拡張機能をインストールするときは、PHPEclipse の手順に従ってください。ただし、php.ini ファイル内で PHP 拡張機能をロードして構成する必要がある行をコメント アウトします。デバッガーを使用する準備ができたら、これらの行のコメントを解除します。
  
  
• Linux 用の無料 SEK を注文してください。これは、DB2®、Lotus®、Rational®、Tivoli®、および WebSphere® の最新の Linux 用 IBM 試用版ソフトウェアを含む 2 枚の DVD のセットです。
  
  ダウンロードまたは DVD で入手できる
• IBM トライアル ソフトウェア を使用して、次のオープンソース開発プロジェクトを革新しましょう。
  
  

ディスカッション

developerWorks ブログ
• に参加して、developerWorks コミュニティに参加してください。

著者について

タイラー・アンダーソンは、2004 年にブリガム・ヤング大学を卒業し、コンピューター サイエンスの学位を取得しました。彼は現在、コンピュータ工学の修士課程の学生として最終学期を迎えています。以前は DPMG.com でデータベース プログラマーとして働いていましたが、現在はオレゴン州ビーバートンの Stexar Corporation でエンジニアを務めています。 元のアドレス http://www.ibm.com/developerworks/cn/opensource/os-debug/

http://www.bkjia.com/PHPjc/320848.html

www.bkjia.comtru​​ehttp://www.bkjia.com/PHPjc/320848.html技術記事この記事では、Apache と PHP でエラー報告を有効にする方法や、単純な PHP スクリプトに print ステートメントを戦略的に配置して検索する方法など、PHP アプリケーションをデバッグするさまざまな方法について説明します。