在 NetBeans IDE 中调试 PHP 源代码

目录

• 准备工作
• 如何在 NetBeans IDE 中使用 XDebug 进行 PHP 调试
• 调试选项
• 使用工具栏和编辑器
• 调试器窗口
• 调试会话
• 样例调试会话
• 使用其他监视
• PHP 和 HTML 混合用例
• 路径映射、调试器代理以及在定制 URL 上启动调试会话

要学习本教程，您需要具备以下软件和资源。

软件或资源	要求的版本
NetBeans IDE	PHP 下载包
PHP 引擎	版本 5
Web 服务器	推荐使用 Apache HTTP Server 2.2。
PHP 调试器	XDebug 2.0 或更高版本

准备工作

要在适用于 PHP 的 NetBeans IDE 中成功调试 PHP 应用程序，您需要为进行 PHP 开发安装并配置 PHP 引擎、Apache 本地 Web 服务器和 XDebug 调试器。如果您难以使 XDebug 正常工作，请参见 NetBeans XDebug Wiki，并/或通过 咨询社区。

如何在 NetBeans IDE 中使用 XDebug 进行 PHP 调试

从 NetBeans IDE 中运行 XDebug 时，将在设置断点的每行暂停执行 PHP 程序。当程序暂停执行时，XDebug 可以检索有关当前程序状态的信息，如程序变量的值。实际上，此过程可以用下列工作流来表示：

1. 在应暂停执行 PHP 源代码的每行设置断点。
2. 启动调试会话。
3. 当到达包含断点的行时，可以按 F7 和 F8 键，以逐行执行脚本。在调试器窗口中监视应用程序的状态。
4. 关闭调试会话。

有关在 NetBeans IDE 中使用 XDebug 的工作流详细信息，请参见调试会话。

NetBeans IDE 提供了一个调试工具栏，可帮助您逐步执行文件。请参见使用工具栏和编辑器。

调试选项

NetBeans IDE 的 "Options"（选项）中包含一个标签，用于更改 PHP 调试的某些缺省设置。要打开这些选项，请转至 "Tools"（工具）> "Options"（选项）（在 Mac 上则转至 "NetBeans" > "Preferences"（首选项）），然后依次选择 "PHP" 选项和 "Debugging"（调试）标签。

注意：NetBeans IDE 版本 7.1 中引入了 "Debugging"（调试）标签。对于早期版本的 NetBeans，调试选项包含在 "General PHP"（常规 PHP）标签中。版本 7.1 中的部分选项在早期版本中不可用。

您可以在此面板中更改以下选项：

• Debugger port（调试器端口）。这是 XDebug 使用的端口，如 php.ini 中所设置。缺省情况下为端口 9000。此对话框中的端口号必须与您在 php.ini 中设置的调试器端口相同。在此对话框中，不能改动 XDebug 使用的端口。只能将 XDebug 使用的端口通知 NetBeans IDE。
• Session ID（会话 ID）。调试会话的任意名称。缺省情况下为 netbeans-xdebug。如果需要设置 php.ini 中的 xdebug.idekey 属性（如在某些远程调试情况下），则必须注意该值。
• Stop at First Line（在第一行停止）。勾选此选项时，调试器会话在代码的第一行停止，而不在第一个断点处停止。在启动调试会话时，该选项可使您的屏幕一直居于 IDE 中，而不切换至浏览器窗口。
• Watches and Balloon Evaluation（监视和气球式求值）。缺省情况下，将禁用监视和气球式求值。监视和气球式求值会导致 XDebug 不稳定。
• Maximum Depth of Structures（最大结构深度）。设置嵌套结构（如嵌套数组、对象中的对象等）的可见性。
• Maximum Number of Children（最大子项数）。设置监视求值期内数组项的可见性。（如果将 "Maximum Number of Children"（最大子项数）设置为 1，则只会看到数组中的第一项，即使该数组有多个项也是如此。）
• Show Requested URLs（显示请求的 URL）。在调试期间打开新的 "Output"（输出）窗口。此 "Output"（输出）窗口名为 "PHP Requested Urls"（PHP 请求的 URL），它会显示当前处理的 URL。这些 URL 是可单击的。在 "Output"（输出）窗口中单击 URL，以便在浏览器窗口中打开该 URL。
• PHP Debugger Console（PHP 调试器控制台）。打开新的 "Output"（输出）窗口，以显示受调试脚本的输出。

  注意：请设置 php.ini 文件中的 output_buffering = Off。否则，在 "Output"（输出）窗口中，将会延迟显示脚本输出。

就本教程而言，您不需要更改任何这些设置，除非选择性地启用监视。

使用工具栏和编辑器

可以使用编辑器来查看文件内容。因此，在进行调试时，编辑器以及调试器工具栏可为您提供在执行期间逐步执行代码的功能，以便查看文件内容如何影响在浏览器中执行的操作。

• 使用调试器工具栏
• 设置断点
• 检查工具提示

调试器窗口

启动调试会话时，将在主编辑器窗口下打开一组调试器窗口。在调试器窗口中，可以在逐步执行代码时跟踪变量和表达式值，检查执行线程的调用栈，验证源 URL 以及在会话之间切换（如果正在运行并发调试会话）。

• "Sessions"（会话）窗口
• "Variables"（变量）窗口
• "Watches"（监视）窗口
• "Call Stack"（调用栈）窗口
• "Threads"（线程）窗口
• "Sources"（源）窗口
• "Breakpoints"（断点）窗口

可以从 IDE 的 "Window"（窗口）> "Debugging"（调试）菜单中访问所有调试器窗口。在调试会话处于活动状态后，便可以开始使用调试器窗口。

调试会话

以下过程是典型调试会话的工作流。

运行调试会话：

1. 启动 IDE，然后打开包含要调试的源代码的文件。
2. 在要暂停调试器的每行设置断点。要设置断点，请将光标放在行首，然后按 Ctrl-F8/⌘-F8 组合键，或者选择 "Debug"（调试）> "Toggle Line Breakpoint"（开启/关闭行断点）。
3. 在 "Projects"（项目）窗口中，导航至当前项目节点，单击鼠标右键，然后从弹出式菜单中选择 "Debug"（调试）。IDE 将打开调试器窗口并在调试器中运行该项目，直至到达断点为止。
   注意：如果当前项目设置为主项目，则可以选择 "Debug"（调试）> "Debug Main Project"（调试主项目），按 Ctrl-F5 组合键或单击 。
4. 切换至 "Local Variables"（局部变量）窗口。该窗口显示当前函数中已初始化的所有变量及其类型和值。
5. 要查看该函数外部的变量值，请将光标置于此变量出现的某个位置上。工具提示会显示变量值。
6. 要逐行（包括所有被调用函数中的行）执行程序，请按 F7 键或选择 "Debug"（调试）> "Step Into"（步入），然后在 "Local Variables"（局部变量）窗口中监视这些变量值的更改。
7. 要通过监视表达式的更改来检查程序逻辑，请定义一个新监视：
   1. 要打开 "Watches"（监视）窗口，请选择 "Window"（窗口）> "Debugging"（调试）> "Watches"（监视），或按 Ctrl-Shift-2 组合键。"Watches"（监视）窗口打开。
   2. 在 "Watches"（监视）窗口中的任意位置单击鼠标右键，然后从弹出式菜单中选择 "New Watch"（新建监视）。"New Watch"（新建监视）窗口打开。
   3. 输入监视表达式，然后单击 "OK"（确定）。

   现在，您便可以在调试过程中进行其他检查。

   重要提示：您必须在 PHP "Options"（选项）的 "Debugging"（调试）标签中启用监视才能设置监视。

8. 要取消对某个函数中代码的逐行执行操作并跳至该函数调用后的下一行，请按 Ctrl-F7/⌘-F7 组合键或选择 "Debug"（调试）> "Step Out"（步出）。
9. 要跳过对某个函数中代码的逐行执行操作，获取该函数返回的值，并跳至该函数调用后的下一行，请按 F8 键或选择 "Debug"（调试）> "Step Over"(步过）。
10. 要暂停调试会话，请选择 "Debug"（调试）> "Pause"（暂停）。
11. 要继续调试会话，请选择 "Debug"（调试）> "Continue"（继续）或按 。
12. 要取消调试会话，请按 。

13. 在程序结束时，调试器窗口会关闭。

样例调试会话

本部分中的样例说明了基本的调试器函数，包括步入和步过函数。此外，还显示了典型的调试器窗口输出。

1. 使用以下参数创建新的 PHP 项目：
   • 项目类型 - PHP 应用程序
   • 源位置 - htdocs 文件夹的缺省位置
   • 运行配置 - "Local Web Site"（本地 Web 站点）
   有关设置 PHP 项目的更多详细信息，请参见设置 PHP 项目文档。
2. 要在会话过程中使用热键，请将光标置于项目节点上，然后从弹出式菜单中选择 "Run Main Project"（运行主项目）。
3. 在 index.php 文件中，输入以下代码：

     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
     <html>
     	<head>
     		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
     			<title>NetBeans PHP debugging sample</title>
   		</head>
   <body>
   	<?php
     	$m=5;
     	$n=10;
     	  $sum_of_factorials = calculate_sum_of_factorials ($m, $n);
     	  echo "The sum of factorials of the entered integers is " . $sum_of_factorials;
     	
   	    function calculate_sum_of_factorials ($argument1, $argument2) {
     	 	$factorial1 = calculate_factorial ($argument1);
     	 	$factorial2 = calculate_factorial ($argument2);
     	 	$result = calculate_sum ($factorial1, $factorial2);
     	 	return $result;
     		}
   	
   	  function calculate_factorial ($argument) {
     	  	$factorial_result = 1;
     	 	for ($i=1; $i<=$argument; $i++) {
     	 		$factorial_result = $factorial_result*$i;
     	 	}
     			return $factorial_result;
     		}
   	  
   	    function calculate_sum ($argument1, $argument2) {
    			return $argument1 + $argument2;
        	}	
   ?>
     </body>
   </html>
     

   该代码包含三个函数：
   • calculate_factorial () 函数
   • calcualte_sum () 函数
   • calculate_sum_of_factorials () 函数，该函数调用 calculate_factorial () 函数两次，再调用 calcualte_sum () 函数一次，然后返回计算的阶乘和。
4. 在 PHP 块的开头设置一个断点（Ctrl-F8/⌘-F8 组合键）：

   <?php

5. 要启动调试，请单击 。调试器将在断点处停止。
6. 按 F7 键三次。调试器将在调用函数 calculate_sum_of_factorials () 的行上停止。"Local Variables"（局部变量）窗口会显示变量 $m 和 $n 以及它们的值：
   
7. 要步入函数 calculate_sum_of_factorials ()，请按 F7 键。调试器开始执行函数 calculate_sum_of_factorials () 中的代码，然后在函数 calculate_factorial () 的调用处停止。
   
   现在，"Local Variables"（局部变量）窗口将显示函数 calculate_sum_of_factorials () 中声明的局部变量 $argument1 和 $argument2。
   
8. 按 F7 键。调试器开始执行函数 calculate_factorial () 中的代码。"Call Stack"（调用栈）窗口将按倒序显示函数的调用栈，最后调用的函数位于列表顶部：
   
9. 按 F7 键步入循环。在 "Variables"（变量）窗口中查看变量值。
   
10. 如果您确定代码运行正常，请按 Ctrl-F7/⌘-F7 组合键，以取消函数执行。程序将在调用函数 calculate_factorial () 后返回至下一行。
    注意：您也可以按 F7 键，直到程序执行完函数 calculate_factorial () 为止。您也会在调用该函数后返回至下一行。
    
11. 由于您刚检查了函数 calculate_factorial ()，并且确定其运行正常，因此可以跳过对该函数的再次执行操作（“步过”）。要越过该函数，请按 F8 键。程序将在函数 calculate_sum () 的调用处停止。
    
12. 要步入函数 calculate_sum ()，请按 F7 键。
13. 要越过该函数，请按 F8 键。对于任何一种情况，调试器都会在函数 calculate_sum_of_factorials () 的最后一行停止。
    
14. 按 F7 键。调试器将移到 echo 语句所在的行上。
15. 按 F7 键，直到调试器退出程序为止。将打开浏览器窗口并显示程序执行的结果：
    

PHP 和 HTML 混合用例

您可以调试同时包含 PHP 块和 HTML 块的代码。在样例调试会话部分的示例中，对值进行了固定编码。现在，将通过用于输入值的 HTML 输入表单来扩展该代码。

1. 将以下 HTML 代码添加到 <?php ?> 块的上方：

    <form action="index.php" method="POST">
          Enter the first integer, please:
          <input type="text" name="first_integer"/><br/>
          Enter the second integer, please:
          <input type="text" name="second_integer"/><br/>
          <input type="submit" name="enter" value="Enter"/>
   </form>

   有关详细信息，请参见 HTML 输入表单。

2. 替换 <?php ?> 块顶部的以下行：

   $m=5;
     	$n=10;
     	  $sum_of_factorials = calculate_sum_of_factorials ($m, $n);
     	  echo "The sum of factorials of the entered integers is " . $sum_of_factorials;
   

   替换为以下代码：

   if (array_key_exists ("first_integer", $_POST) && array_key_exists ("second_integer", $_POST)) {
   
       $result = calculate_sum_of_factorials ($_POST["first_integer"], $_POST["second_integer"]);
   
       echo "Sum of factorials is " . $result;
   
   }

3. 在 <?php ?> 块的开头设置断点，然后启动调试会话。
4. 按 F7 键。调试器将步入程序。同时，会打开浏览器窗口，但不显示输入表单。这是调试器的正确行为，因为它必须首先通过 Web 页的整个源代码，然后才能显示该页面。实际上，这意味着调试器通过了两次代码。第一次是调试器处理代码以显示 HTML 输入表单。第二次是调试器逐步执行 PHP 代码。
5. 按 F7 键，直到调试器到达程序末尾并且打开输入表单为止。
6. 填写该表单，然后单击 Enter 键。将继续调试会话（如样例调试会话部分中所述）。

路径映射、调试器代理以及在定制 URL 上启动调试会话

可以调试脚本和 Web 页，还可以在本地或远程调试 Web 页。遗憾的是，对于远程调试，在远程服务器上调试的 PHP 文件与在本地计算机上运行的 NetBeans IDE 中打开的文件并不相同。因此，NetBeans 中的调试器支持必须能够将服务器路径映射到本地路径。然而，由于存在诸多复杂因素，无法针对各种情况自动解决路径映射问题。因此，自 NetBeans 6.7 开始，可以通过项目设置为各种运行配置手动定义路径映射。此外，还可以指定代理服务器（如果有），以及在其上启动调试会话的 URL。如果未指定此 URL，则将从索引文件开始执行调试。

设置路径映射并启用定制调试 URL：

1. 在 "Projects"（项目）窗口中右键单击项目节点，然后从上下文菜单中打开项目的 "Properties"（属性）。
2. 在 "Project Properties"（项目属性）对话框中，转至 "Run Configuration"（运行配置）类别。
3. 单击 "Advanced"（高级）按钮。"Advanced Web Configuration"（高级 Web 配置）对话框打开。
4. 添加要进行路径映射的服务器路径和项目路径。
5. 在 "Debug URL"（调试 URL）下，选中以下一个选项（不要将缺省值保留为选中状态）：
   
   
   • "Ask Every Time"（每次都询问）：让 IDE 提示您在启动调试会话时输入 URL。
   • "Do Not Open Web Browser"（不打开 Web 浏览器）：需要您手动打开浏览器并输入 URL（您需要 GET/POST XDEBUG_SESSION_START 变量）。
6. 使用代理服务器进行调试时，请在 "Debugger Proxy"（调试器代理）类别中输入该服务器的主机名和端口。

有关详细信息，请参见 "NetBeans for PHP"(NetBeans PHP) 博客中的 Path Mapping in PHP Debugger（使用 PHP 调试器进行路径映射）的帖子。

要发送意见和建议、获得支持以及随时了解 NetBeans IDE PHP 开发功能的最新开发情况，请加入 邮件列表。

返回至 PHP 学习资源