PHP显示错误信息|极客教程

PHP显示错误信息

在 PHP 程序开发过程中，错误信息的输出对于调试和排查问题非常重要。PHP 提供了多种方式来显示错误信息，本文将详细介绍这些方法。

错误报告级别

在 PHP 中，可以通过设置错误报告级别来控制错误信息的显示方式。错误报告级别可以通过在代码中设置 error_reporting 常量来修改，常见的错误报告级别有以下几种：

E_ALL：显示所有错误和警告信息。
E_ERROR：只显示致命错误信息。
E_WARNING：显示警告和其他非致命错误信息，但不显示通知。
E_NOTICE：显示通知和其他非致命错误信息，但不显示警告。

我们可以使用 error_reporting() 函数动态修改错误报告级别，这在调试代码时非常有用。

在页面上显示错误信息

在开发环境中，我们可以将错误信息直接输出到页面上，方便快速找出问题所在。为了实现这一点，我们需要在代码中添加以下内容：

<?php
// 显示所有错误和警告信息
error_reporting(E_ALL);

// 设置错误报告方式为显示在页面上
ini_set('display_errors', 1);

将上述代码添加到 PHP 文件的顶部，即可在页面上显示所有错误和警告信息。这样的输出方式非常直观，但对于正式环境来说，不应该将错误信息直接显示在页面上，因为这可能会泄露敏感信息，甚至使网站遭受攻击。

在日志文件中记录错误信息

为了在生产环境中更加安全地处理错误信息，我们可以将错误信息记录到日志文件中，而不是直接显示在页面上。PHP 提供了 error_log() 函数来实现这一功能。

我们可以将以下代码添加到 PHP 文件中，用来记录错误信息到日志文件：

<?php
// 显示所有错误和警告信息
error_reporting(E_ALL);

// 将错误信息写入日志文件
ini_set('log_errors', 1);
ini_set('error_log', '/path/to/errorlog.txt');

在上述代码中，我们使用 ini_set() 函数来设置 log_errors 和 error_log 选项，分别用于启用错误日志功能和指定日志文件的路径。

通过设置 log_errors 为 1，PHP 会将错误信息写入指定的日志文件中。你需要将 ‘/path/to/errorlog.txt’ 替换为你实际想要存储错误日志的路径。

自定义错误处理函数

除了将错误信息写入日志文件，我们还可以编写自定义的错误处理函数来处理 PHP 运行过程中出现的错误。通过自定义错误处理函数，我们可以在错误发生时执行特定的操作，比如发送邮件通知、记录错误详情等。

首先，我们需要编写一个错误处理函数，函数的定义如下：

<?php
function customError( $errno,$ errstr,  $errfile,$ errline) {
    // 错误处理逻辑代码
}

在错误处理函数中，我们可以根据需要执行各种操作。$errno 参数表示错误级别，$errstr 参数表示错误信息，$errfile 参数表示错误发生的文件，$errline 参数表示错误发生的行号。

然后，我们需要使用 set_error_handler() 函数来注册自定义的错误处理函数，代码如下：

<?php
// 显示所有错误和警告信息
error_reporting(E_ALL);

// 注册自定义错误处理函数
set_error_handler("customError");

在上述代码中，我们使用 set_error_handler() 函数将自定义错误处理函数 customError 注册为错误处理器。

使用自定义错误处理函数时，需要注意以下几点：

错误处理函数必须接受四个参数，否则会导致致命错误。
错误处理函数必须返回 true，否则 PHP 会继续执行默认的错误处理机制。
如果错误处理函数中发生了致命错误，程序会立即停止执行。

显示具体的错误详情

在默认情况下，PHP 只会显示错误的类型和位置信息，有时候这些信息并不足以定位问题。我们可以通过以下两种方式来显示更详细的错误详情：

方式一：修改 PHP 配置文件

首先，我们可以通过修改 PHP 配置文件来显示更详细的错误详情。打开 PHP 配置文件（一般为 php.ini），将以下两行代码的注释符号 ; 去掉：

; display_errors = On
; display_startup_errors = On

修改后，保存配置文件并重启 Web 服务器，错误信息就会显示更详细的内容了。

方式二：在代码中设置

其次，我们还可以在代码中设置，通过 ini_set() 函数来显示更详细的错误详情：

<?php
// 显示所有错误和警告信息
error_reporting(E_ALL);

// 设置错误报告方式为显示在页面上
ini_set('display_errors', 1);

// 显示具体的错误详情
ini_set('display_startup_errors', 1);

在上述代码中，我们使用 ini_set() 函数将 display_startup_errors 配置选项设置为显示详细的错误详情。

记录异常信息

除了常规的错误信息，PHP 还提供了异常处理机制来处理更复杂的错误情况。当发生无法恢复的错误时，我们可以使用 try...catch 语句捕获异常并进行处理。

以下是 try...catch 语句的基本语法：

try {
    // 可能会抛出异常的代码
} catch (Exception $e) {
    // 异常处理代码
}

在 try 代码块中，我们放置可能会抛出异常的代码。在发生异常时，会立即跳转到 catch 代码块中，执行异常处理代码。

以下是一个示例，演示了如何捕获和处理一个简单的异常：

<?php
try {
    // 故意抛出一个异常
    throw new Exception('这是一个测试异常');
} catch (Exception  $e) { // 处理异常 echo '捕获的异常：' .$ e->getMessage();
}

在上述代码中，我们使用 throw 关键字抛出了一个异常，并在 catch 代码块中使用 $e->getMessage() 获取到异常对象的错误信息。

结论

通过本文的介绍，你应该了解了如何在 PHP 中显示错误信息。在开发过程中，选择合适的错误显示方式，对于及时发现和解决问题有着重要的作用。

通过适当地设置错误报告级别和错误显示方式，以及编写自定义的错误处理函数，可以更好地处理和跟踪错误信息，提高代码的可靠性和可维护性。

然而，在实际开发过程中，除了显示错误信息之外，还有一些其他的技巧可以帮助我们更好地排查和调试问题。下面是一些常用的技巧：

使用错误日志

除了在页面上显示错误信息之外，将错误信息写入错误日志文件是一种更安全和可控的方式。可以使用 error_log() 函数将错误信息写入指定的日志文件，以便在需要时进行查看和分析。

<?php
// 开启错误日志功能
ini_set('log_errors', 1);

// 指定错误日志文件路径
ini_set('error_log', '/path/to/error.log');

通过以上代码，将错误信息写入 /path/to/error.log 文件中。

跟踪错误堆栈

当出现错误时，了解错误发生的上下文信息是非常重要的。PHP 可以输出错误的堆栈跟踪信息，这包括了代码执行的路径和调用关系。

<?php
try {
    // 可能会抛出异常的代码
} catch (Exception  $e) { // 输出错误的堆栈跟踪信息 echo$ e->getTraceAsString();
}

通过使用 getTraceAsString() 方法，可以获取到错误的堆栈跟踪信息，并输出到页面上或者写入日志文件。

使用断言

断言是一种用于验证程序的运行状态的工具。我们可以使用 assert() 函数来创建断言，并在错误条件下停止程序的执行。

<?php
 $number = 10; // 断言：$ number 必须小于 5
assert($number < 5, '出现错误');

// 后续代码
echo '断言成功';

在上述代码中，如果断言失败（即 $number 大于等于 5），程序会立即停止执行，并输出错误信息。

使用调试工具

除了以上的技巧之外，还可以使用一些调试工具来辅助排查问题。常见的 PHP 调试工具包括：

Xdebug：一个功能强大的 PHP 调试器，可以提供调试会话、断点调试、堆栈跟踪等功能。
PhpStorm：一款专业的集成开发环境（IDE），内置了丰富的调试功能。
Chrome 开发者工具：通过 Chrome 浏览器的开发者工具，可以检查网络请求、查看页面错误等功能。

使用这些调试工具，可以更加方便地定位和解决问题，提高开发效率。

在 PHP 中显示错误信息是一个非常重要的开发技巧。通过正确地设置错误报告级别和错误显示方式，结合安全的错误日志记录机制和自定义错误处理函数，可以更好地监测和处理错误。同时，使用其他技巧如跟踪错误堆栈、使用断言和调试工具，可以提高排查问题的效率和准确性。

PHP显示错误信息