开发模式与产品模式下的PHP报错处理详解

程序报错总是在所难免,尽管我们书写代码时已经格外小心。

在开发php程序时,我们希望遇到php报错,可以第一时间展示给我们,以便于调试。当程序开发完成,成为正式产品时,我们希望将没有预测到的报错信息记录到错误日志中,而不是将这些报错信息展示给用户,因为用户极有可能利用这些暴露出脚本路径、数据库信息或其他的报错信息进行一些破坏性的黑客行动。

PHP 的错误处理

php脚本在执行过程中遇到错误将以报错的形式处理,有些错误在报错之后会终止脚本继续执行,而有些不会,具体请参阅手册。

php的报错处理方式根据以下配置选项进行,这些配置可以在代码中声明以设置,也可以在php.ini文件中设置。如果不需要经常改动这些配置,还是建议在php.ini文件中设置,以使你的代码更清爽简洁。

# 是否打印错误信息到浏览器/命令行界面

# 开发模式下建议开启,产品模式下强烈建议关闭

ini_set('display_errors', 'On');

# 是否记录错误信息到日志

# 开发模式和产品模式下都建议开启

ini_set('log_errors', 'On');

# 指定错误信息日志文件,若开启了 log_errors 选项,记得指定日志文件位置

# 要确保执行 php 脚本的系统用户拥有该文件的 write 权限,否则日志无法被写入

ini_set('error_log', '/usr/local/php/errors.log');

# 该选项用以设定错误报告的等级

# 等同于 error_reporting(E_ALL)

# 无论开发模式还是产品模式下都建议开到E_ALL(报告所有的错误信息)

# 产品模式下也需要设置此选项,因为关闭了 display_errors 并开启了 log_errors

# 所以浏览器/命令行界面不会因此暴露报错信息

ini_set('error_reporting', E_ALL);

除此之外,php 还给开发者提供了在代码中将自定义的错误信息记录到错误日志文件的内置函数:

bool error_log ( string $message [, int $message_type = 0 [, string $destination [, string $extra_headers ]]] )

必选参数是 message ,调用此函数会将 message 写入 php.ini 中定义的 error_log 文件中。

用户自定义的错误处理

另外,用户可以通过函数:

mixed set_error_handler ( callable $error_handler [, int $error_types = E_ALL | E_STRICT ] )

以自定义的方式来处理脚本运行时出现的错误,如果用户注册了 error_handler 并指定了 error_types ,那么当发生这些 error_types 的错误时,将绕过 php的标准错误处理程序。

(也就是说既不会输出错误信息,也不会记录错误信息日志),而是执行 error_handler 中的处理程序。

该函数的详细用法请参阅手册(https://www.php.net/manual/zh/function.set-error-handler.php)。