如何使用 php 代码分析工具 xhprof

我们相信：世界是美好的，你是我也是。平行空间的世界里面，不同版本的生活也在继续...

相比较phptrace、xdebug，xhprof的功能更加强大，但是对于代码来说，它是侵入式的。其基本功能的基础是要对php源码进行修改，必须嵌入这个扩展的相关代码，才能实现其强大的功能。所以，这样来说，是不是方便大家使用，就仁者见仁智者见智了。

苏南大叔将简要介绍一下xhprof的使用，本文的写作环境是php5.6.31下的xhprof，至于php7.2.0b3下的xhprof，虽然编译成功。但是在实际运行中，还是有一定的概率导致502错误。所以，这里并没有采用这个环境。大家如果要在php7下面使用xhprof的话，就还需要三思而行。详细的中文介绍，可以点击这里查看：http://doc.php.sh/zh/book.xhprof.html

放置库文件

代码需要能够访问到这两个目录，xhprof_lib和xhprof_html。但是这两个目录是否放置于网站根目录，就不一定了。对于xhprof_lib来说，需要能够被include到。而xhprof_html，需要能够通过地址访问到。所以，如果你不会配置nginx或者apache，那么简单的把这两组文件复制到网站根目录下面，是最好的选择。

对比sample.php埋点

官方源码里面有个examples/sample.php文件。

对比官方源码里面的example.php。我们可以知道：埋点分为两部分。
一部分是放在php文件主代码之前，见下面。

//date_default_timezone_set("Asia/Hong_Kong");
include_once "./xhprof_lib/utils/xhprof_lib.php";
include_once "./xhprof_lib/utils/xhprof_runs.php";
xhprof_enable(XHPROF_FLAGS_NO_BUILTINS | XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

一部分是放在php文件主代码结束之，见下面。

$xhprof_data = xhprof_disable();
$xhprof_runs = new XHProfRuns_Default();
$run_id = $xhprof_runs->save_run($xhprof_data, "xhprof_foo");
//$run_id = $xhprof_runs->save_run($xhprof_data, str_replace(".", "_", basename(__FILE__)));

运行代码，写入日志

运行代码后，就会按着php.ini中的『xhprof.output_dir = /tmp/xhprof』的设定，写入日志文件。所以，请确保对应的文件夹权限。

查看分析

运行 http:///xhprof_html/ 即可查看相关结果。当然这个前提是，你已经成功放置了xhprof_lib和xhprof_html这两个文件夹。正常情况下，是这样的效果。

可能需要安装的组件

如果最后一步，查看图表失败的话。如下图所示：

brew install graphviz

小小的进阶

苏南大叔说了，这种调用方式，对代码本身是有侵入性的。事实上不是太友好。那么进阶的操作就是，把上述两个注入点，用下面的形式改写成一个单独的文件。

//开启xhprof
xhprof_enable(XHPROF_FLAGS_MEMORY | XHPROF_FLAGS_CPU);
//在程序结束后收集数据
register_shutdown_function(function() {
    $xhprof_data        = xhprof_disable();
    //让数据收集程序在后台运行
    if (function_exists('fastcgi_finish_request')) {
        fastcgi_finish_request();
    }
    //保存xhprof数据
    ...
});

然后利用php.ini的auto_prepend_file功能，来把这个文件自动注入到源码中。这个idea其实是相当不错的。几乎把代码的侵入性降到了最低点。

auto_prepend_file = /opt/inject.php

当然，也可以通过nginx修改php.ini。效果是差不多的。

fastcgi_param PHP_VALUE "auto_prepend_file=/opt/inject.php";

基本的使用教程就是这样的，更多有关xhprof的中文介绍。可以点击这里查看，http://doc.php.sh/zh/book.xhprof.html 。苏南大叔编写的xhprof系列教程，可以点击这里查看。https://newsn.net/tag/xhprof/ 。

如果本文对您有帮助，或者节约了您的时间，欢迎打赏瓶饮料，建立下友谊关系。
本博客不欢迎：各种镜像采集行为。请尊重原创文章内容，转载请保留作者链接。