PHP 的错误机制也是非常复杂的, 做了几年 php, 也没有仔细总结过, 现在就补上这一课.
特别说明: 文章的 PHP 版本使用 5.5.32
PHP 的错误级别
首先需要了解 php 有哪些错误. 截至到 php5.5, 一共有 16 个错误级别
注意: 尝试下面的代码的时候请确保打开 error_log:
- error_reporting(E_ALL);
- ini_set('display_errors', 'On');
- E_ERROR
这种错误是致命错误, 会在页面显示 Fatal Error, 当出现这种错误的时候, 程序就无法继续执行下去了
错误示例:
- // Fatal error: Call to undefined function hpinfo() in /tmp/php/index.php on line 5
- hpinfo(); //E_ERROR
注意, 如果有未被捕获的异常, 也是会触发这个级别的.
- // Fatal error: Uncaught exception 'Exception' with message 'test exception' in /tmp/php/index.php:5 Stack trace: #0 {main} thrown in /tmp/php/index.php on line 5
- throw new \Exception("test exception");
- E_WARNING
这种错误只是警告, 不会终止脚本, 程序还会继续进行, 显示的错误信息是 Warning. 比如 include 一个不存在的文件.
- //Warning: include(a.php): failed to open stream: No such file or directory in /tmp/php/index.php on line 7
- //Warning: include(): Failed opening 'a.php' for inclusion (include_path='.:/usr/share/pear:/usr/share/php') in /tmp/php/index.php on line 7
- include("a.php"); //E_WARNING
- E_NOTICE
这种错误程度更为轻微一些, 提示你这个地方不应该这么写. 这个也是运行时错误, 这个错误的代码可能在其他地方没有问题, 只是在当前上下文情况下出现了问题.
比如 $b 变量不存在, 我们把它赋值给另外一个变量
- //Notice: Undefined variable: b in /tmp/php/index.php on line 9
- $a = $b; //E_NOTICE
- E_PARSE
这个错误是编译时候发生的, 在编译期发现语法错误, 不能进行语法分析.
比如下面的 z 没有设置为变量.
- // Parse error: syntax error, unexpected '=' in /tmp/php/index.php on line 20
- z=1; // E_PARSE
- E_STRICT
这个错误是 PHP5 之后引入的, 你的代码可以运行, 但是不是 PHP 建议的写法.
比如在函数形参传递 ++ 符号
- // Strict Standards: Only variables should be passed by reference in /tmp/php/index.php on line 17
- function change (&$var) {
- $var += 10;
- }
- $var = 1;
- change(++$var);
- // E_STRICT
- E_RECOVERABLE_ERROR
这个级别其实是 ERROR 级别的, 但是它是期望被捕获的, 如果没有被错误处理捕获, 表现和 E_ERROR 是一样的.
经常出现在形参定义了类型, 但调用的时候传入了错误类型. 它的错误提醒也比 E_ERROR 的 fatal error 前面多了一个 Catachable 的字样.
- //Catchable fatal error: Argument 1 passed to testCall() must be an instance of A, instance of B given, called in /tmp/php/index.php on line 37 and defined in /tmp/php/index.php on line 33
- class A {
- }
- class B {
- }
- function testCall(A $a) {
- }
- $b = new B();
- testCall($b);
- E_DEPRECATED
这个错误表示你用了一个旧版本的函数, 而这个函数后期版本可能被禁用或者不维护了.
比如 curl 的 CURLOPT_POSTFIELDS 使用 \@FILENAME 来上传文件的方法
- // Deprecated: curl_setopt(): The usage of the @filename API for file uploading is deprecated. Please use the CURLFile class instead in /tmp/php/index.php on line 42
- $ch = curl_init("http://www.remotesite.com/upload.php");
- curl_setopt($ch, CURLOPT_POSTFIELDS, array('fileupload' => '@'. "test"));
- E_CORE_ERROR, E_CORE_WARNING
这两个错误是由 PHP 的引擎产生的, 在 PHP 初始化过程中发生.
E_COMPILE_ERROR, E_COMPILE_WARNING
这两个错误是由 PHP 引擎产生的, 在编译过程中发生.
E_USER_ERROR, E_USER_WARNING, E_USER_NOTICE, E_USER_DEPRECATED,
这些错误都是用户制造的, 使用 trigger_error, 这里就相当于一个口子给用户触发出各种错误类型. 这个是一个很好逃避 try catch 异常的方式.
- trigger_error("Cannot divide by zero", E_USER_ERROR);
- // E_USER_ERROR
- // E_USER_WARING
- // E_USER_NOTICE
- // E_USER_DEPRECATED
- E_ALL
E_STRICT 出外的所有错误和警告信息.
错误控制
php 中有很多配置和参数是可以控制错误, 以及错误的日志显示的. 第一步, 我们需要了解的是 php 中的有关错误的配置有哪些?
我们按照 php+php-fpm 的模型来说, 会影响 php 错误显示的其实是有两个配置文件, 一个是 php 本身的配置文件 php.ini, 另外一个是 php-fpm 的配置文件, php-fpm.conf.
php.ini 中的配置
- error_reporting = E_ALL // 报告错误级别, 什么级别的
- error_log = /tmp/php_errors.log // php 中的错误显示的日志位置
- display_errors = On // 是否把错误展示在输出上, 这个输出可能是页面, 也可能是 stdout
- display_startup_errors = On // 是否把启动过程的错误信息显示在页面上, 记得上面说的有几个 Core 类型的错误是启动时候发生的, 这个就是控制这些错误是否显示页面的.
- log_errors = On // 是否要记录错误日志
- log_errors_max_len = 1024 // 错误日志的最大长度
- ignore_repeated_errors = Off // 是否忽略重复的错误
- track_errors = Off // 是否使用全局变量 $php_errormsg 来记录最后一个错误
- xmlrpc_errors = 0 // 是否使用 XML-RPC 的错误信息格式记录错误
- xmlrpc_error_number = 0 // 用作 XML-RPC faultCode 元素的值.
- html_errors = On // 是否把输出中的函数等信息变为 HTML 链接
- docref_root = http://manual/en/ // 如果 html_errors 开启了, 这个链接的根路径是什么
- fastcgi.logging = 0 // 是否把 php 错误抛出到 fastcgi 中
我们经常会被问到, error_reporting 和 display_errors 有什么区别呢? 这两个函数是完全不一样的.
PHP 默认是会在日志和标准输出(如果是 fpm 模式标准输出就是页面)
error_reporting 的参数是错误级别. 表示什么样子的级别才应该触发错误. 如果我们告诉 PHP, 所有错误级别都不需要触发错误, 那么, 不管是日志, 还是页面, 都不会显示这个错误, 就相当于什么都没有发生.
display_errors 是控制是否要在标准输出展示错误信息
log_errors 则是控制是否要在日志中记录错误信息.
error_log 是显示错误日志的位置, 这个在 php-fpm 中往往会被重写, 于是往往会发现的是 cli 和 fpm 的错误日志竟然不是在同一个文件中.
ignore_repeated_errors 这个标记控制的是如果有重复的日志, 那么就只会记录一条, 比如下面的程序:
- error_reporting(E_ALL);
- ini_set('ignore_repeated_errors', 1);
- ini_set('ignore_repeated_source', 1);
- $a = $c; $a = $c; //E_NOTICE
- //Notice: Undefined variable: c in /tmp/php/index.php on line 20
本来会出现两次 NOTICE 的, 但是现在, 只会出现一次了...
track_errors 开启会把最后一个错误信息存储到变量里面去, 这个可能在对记日志的时候会有一些用处吧. 不过我觉得真是没啥用...
html_errors 和 docref_root 两个是个挺有人性化的配置, 配置了这两个参数以后, 我们返回的错误信息中如果有一些在文档中有的信息, 就会变成链接形式.
- error_reporting(E_ALL);
- ini_set('html_errors', 1);
- ini_set('docref_root', "https://secure.php.net/manual/zh/");
- include("a2.php"); //E_WARNING
能让你快速定位到我们出现错误的地方. 是不是很人性~
php-fpm 中的配置
- error_log = /var/log/php-fpm/error.log // php-fpm 自身的日志
- log_level = notice // php-fpm 自身的日志记录级别
- php_flag[display_errors] = off // 覆盖 php.ini 中的某个配置变量, 可被程序中的 ini_set 覆盖
- php_value[display_errors] = off // 同 php_flag
- php_admin_value[error_log] = /tmp/www-error.log // 覆盖 php.ini 中的某个配置变量, 不可被程序中的 ini_set 覆盖
- php_admin_flag[log_errors] = on // 同 php_admin_value
- catch_workers_output = yes // 是否抓取 fpmworker 的输出
- request_slowlog_timeout = 0 // 慢日志时长
- slowlog = /var/log/php-fpm/www-slow.log // 慢日志记录
php-fpm 的配置中也有一个 error_log 配置, 这个很经常会和 php.ini 中的 error_log 配置弄混. 但他们记录的东西是不一样的, php-fpm 的 error_log 只记录 php-fpm 本身的日志, 比如 fpm 启动, 关闭.
而 php.ini 中的 error_log 是记录 php 程序本身的错误日志.
那么在 php-fpm 中要覆盖 php.ini 中的 error_log 配置, 就需要使用到下面几个函数:
- php_flag
- php_value
- php_admin_flag
- php_admin_value
这四个函数 admin 的两个函数说明这个变量设置完之后, 不能在代码中使用 ini_set 把这个变量重新赋值了. 而 php_flag/value 就仍然以 php 代码中的 ini_set 为准.
slowlog 是 fpm 记录的, 可以使用 request_slowlog_timeout 设置判断慢日志的时长.
总结
我们经常弄混的就是日志问题, 以及某些级别的日志为何没有记录到日志中. 最主要的是要看 error_log,display_errors, log_errors 这三个配置, 只是在看配置的时候, 我们还要注意区分 php.ini 里面的配置是什么, php-fpm.ini 里面的配置是什么.
好吧, 我觉得弄懂这些配置, 基本就没有 php 日志记录不了的 WTF 的问题了.
来源: http://developer.51cto.com/art/201808/581408.htm