xhprof擴展安裝與使用

目錄

• 一、xhprof擴展安裝步驟
• 二、xhprof的使用
• 總結
• 參考資料

一、xhprof擴展安裝步驟

xhprof是PHP的一個擴展，最好也直接安裝上graphviz圖形繪製工具（用於xhprof分析結果以直觀的圖形方式顯示），廢話不多說，直奔正題。

1、安裝

• PHP5版本的安裝

wget http://pecl.php.net/get/xhprof-0.9.4.tgz
tar -zxvf xhprof-0.9.4.tgz 
cd xhprof-0.9.4
cd extension/
phpize
./configure
make
make install

• PHP7版本的安裝

  下載源碼包xhprof：https://github.com/rustjason/xhprof/tree/php7

unzip xhprof-php7.zip 
cd xhprof-php7/extension/
phpize 
./configure --with-php-config=/usr/local/php/bin/php-config 
make
make install

2、修改php.ini配置文件

在php.ini配置文件中追加下麵配置，並創建目錄/home/wwwroot/default/xhprof_data

[xhprof]
extension = xhprof.so
// xhprof分析結果文件存放根目錄
xhprof.output_dir = /home/wwwroot/default/xhprof_data

3、添加一個環境變數XHPROF_ROOT_PATH

為了後期每個項目都能使用xhprof來進行性能分析，建議給PHP加一個環境變數，這樣之後，在任何項目代碼里都可以很方便的調用xhprof來分析性能瓶頸，請執行如下操作：

vim /usr/local/php/etc/php-fpm.conf
env[XHPROF_ROOT_PATH]=/usr/local/php/include/xhprof/

4、將xhprof核心源代碼複製到上述XHPROF_ROOT_PATH環境變數所指定的目錄下

cp -r xhprof_lib /usr/local/php/include/xhprof/xhprof_lib

5、將下麵兩個目錄複製到xhprof_data的同級目錄下（最好都放到web根目錄下）

查看分析結果文件有用

//執行
cp -r xhprof_html /home/wwwroot/default/xhprof_html
cp -r xhprof_lib /home/wwwroot/default/xhprof_lib

//改變xhprof_data目錄擁有者，為了瀏覽器訪問時能在xhprof_data目錄下寫入文件
chown -R www:www xhprof_data

6、訪問xhprof根目錄

配置demo.com功能變數名稱根目錄為/home/wwwroot/default/，則可訪問如下鏈接查看xhprof結果分析根目錄http://demo.com/xhprof_data/，如下圖所示：

7、形象化的查看分析結果

安裝圖形繪製工具，後面的分析結果可以通過該工具以圖形顯示,更直觀
執行安裝命令：yum install graphviz

二、xhprof的使用

1、xhprof性能分析小demo

下麵寫的三種方式實現階乘的代碼

<?php

xhprof_enable(XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);

$n = 5;

echo jc($n);
echo '<br>';

echo jc($n);
echo '<br>';

echo jc($n);
echo '<br>';

function jc($n){
    if($n == 1){
        return 1;
    }
    
    return $n * jc($n-1);
}

function jc2($n){
    $m = 1;
    for($i=1; $i<=$n; $i++){
        $m = $m * $i;
    }
    
    return $m;
}

function jc3($n){
    $arr = [];
    $arr[1] = 1;
    
    for($i = 2; $i<=$n; $i++){
        $arr[$i] = $i * $arr[$i-1];
    }
    
    return $arr[$n];
}


$data = xhprof_disable();
//$_SERVER['XHPROF_ROOT_PATH'] 這就是第三步添加的那個環境變數
include_once $_SERVER['XHPROF_ROOT_PATH'] . "xhprof_lib/utils/xhprof_lib.php";
include_once $_SERVER['XHPROF_ROOT_PATH'] . "xhprof_lib/utils/xhprof_runs.php";
$x = new XHProfRuns_Default();

//拼接文件名
$xhprofFilename = date('Ymd_His');

//print_r($data);die;//此處的列印數據看起來非常不直觀，所以需要安裝yum install graphviz 圖形化界面顯示,更直觀
$x->save_run($data, $xhprofFilename);

上述小demo執行後，會在xhprof_data目錄下生成一個分析結果保存文件，網頁端訪問結果文件，如下圖：

當我在點[View Full Callgraph]查看圖形分析界面時，問題出現了，如下圖：

好在網上查到原因是，php配置文件中有個disable_functions禁用函數列表，把裡面的proc_open去掉即可。

圖形分析結果顯示如下

2、實際項目中該如何引入xhprof

請參考如下截圖所示引入思路（在項目控制器基類構造方法和析構方法里做手腳），思路技巧僅供學習參考，如下圖：

下麵是我在項目（以Yii2為框架）下引入xhprof代碼一覽

<?php
namespace backend\component;

use Yii;
use common\component\baseController;

class backendBaseController extends baseController
{
    public $layout = "/content";
    public $enableCsrfValidation = false;

    public static $profiling = 0;

    public function init(){
        parent::init();
        
        self::$profiling = 1;// !(mt_rand() % 9);
        if  (self::$profiling) {
            xhprof_enable(XHPROF_FLAGS_CPU | XHPROF_FLAGS_MEMORY);
        }
    }

    public function __destruct()
    {
        if(self::$profiling){
            $data = xhprof_disable();
            //$_SERVER['XHPROF_ROOT_PATH'] 該環境變數由第3步得來
            include_once $_SERVER['XHPROF_ROOT_PATH'] . "/xhprof_lib/utils/xhprof_lib.php";
            include_once $_SERVER['XHPROF_ROOT_PATH'] . "/xhprof_lib/utils/xhprof_runs.php";
            $x = new XHProfRuns_Default();

            //當前路由
            $routeName = Yii::$app->requestedRoute;
            //路由為空，則說明是首頁
            if (empty($routeName)){
                $routeName = Yii::$app->defaultRoute;
            }

            //拼接xhprof分析結果保存文件名
            $xhprofFilename = str_replace('/', '_', $routeName).'_'.date('Ymd_His');
            $x->save_run($data, $xhprofFilename);
        }
    }
}

總結

xhprof是一個分析PHP代碼性能瓶頸，提高PHP代碼效率的有利工具,通過xhprof，可以看到代碼慢在哪裡，哪裡還有優化的空間等等。

最後分享一個關於xhprof不錯的資料 ipc2015-xhprof.pdf 下載鏈接：https://pan.baidu.com/s/1EPuKunXlI1gvmtLICHyCxw 密碼：11p0

參考資料

1.使用XHProf查找PHP性能瓶頸

2.PHP性能分析工具 xhprof

3.xhprof安裝了graphviz還報錯failed to execute cmd " dot -Tpng"