讓程式設計師不再苦逼的四大神器

---

做程式猿「媛」是一個苦逼的活，大週六地早起在技術群裡招呼，看到沒有啥人響應，說了一句，「估計都沒有醒」，然後一位哥們拋過來，「在加班」 ！
做 Web 開發更是一個苦逼的活，不像是做 iOS，搞定客戶端，基本上就萬事大吉了。做 Web 開發不僅僅是要做後端，前端也需要了解和熟悉！
做前後端通吃的 DevOps 全棧工程師絕對是最苦逼的活，不但需要做開發，而且還要了解運維、優化，不會運維的工程師絕對不是一個好架構師！
但所幸的事，一個優秀的工程師儘管很忙，儘管要熟悉前後端、系統、運營、優化，但是在他的工具箱裡，放著一大堆工具，讓這種生活變得不那麼苦逼。
這裡就介紹四個讓我們 DevOps 生活變得美好的神器。分別是 Xdebug、XHProf 、OneAPM 和 SocketLog。
Xdebug
作為開發人員，睡得最踏實的事是對自己寫的程式碼瞭如指掌，無論是從功能層面，還是效能層面。而做 Web PHP 開發，比較棘手的一件事情就是程式碼的除錯。作為指令碼語言，在遠端伺服器端執行，客戶端生成的全是 HTML 程式碼，一般認為我們無法準確地除錯執行的情況，更不要說單步除錯、變數監控等事情了。其實這是有誤解的，有一個 PHP 擴充套件 Xdebug 能讓方便地讓我們除錯遠端伺服器上執行的程式碼。
方法很簡單，從 Xdebug 下載最新版的原始碼。 wget 解壓：

tar –zxvf xdebug-2.3.3.tgz  
cd xdebug-2.3.3  
phpize  
./configure –with-php-config=/usr/bin/php-config
make  
make install

再增加相應的配置到 php.ini ，需要注意有兩點：
1. xdebug 是 zend_extension
2. 埠預設是 9000，和 php-fpm 的預設埠衝突，所以這裡換用 9100

[xdebug]
zend_extension=/usr/lib/php/extensions/no-debug-non-zts-20121212/xdebug.so  
xdebug.remote_enable=on  
xdebug.remote_handler=dbgp  
xdebug.remote_host=localhost  
xdebug.remote_port=9100

這樣就裝好了，就是如此簡單，下面我們可以開始使用了。以 ThinkPHP 應用開發做例子吧。ThinkPHP 典型的單入口應用，呼叫層次相對複雜。所以想要了解呼叫堆疊還是比較麻煩的。要想得到某一行的呼叫堆疊，可以使用 PHP 自帶的 debug_backtrace 函式可以獲得，但是不怎麼形象，返回來一個陣列而已。而 Xdebug 就能讓這一切視覺化起來。
配合 Xdebug 使用的是 Netbeans 自帶的除錯工具。首先通過首選項修改了一下 PHP 除錯的埠，從9000改成9100，其他不用動。注意在第一行停止是選上的，這將在 PHP 程式除錯時，執行到第一行 PHP 程式碼時停止，在 ThinkPHP 中，即入口檔案 index.php 的第一行停止。

在本例中，筆者做了一個租車管理系統的示例，專案名為 zuches。將程式碼部署在 http://localhost/zuches 能訪問的地方，索引檔案是 index.php。

由於 index.php 是入口檔案，所以在 index.php 上點選右鍵，選擇除錯。

然後 Netbeans 自動開啟了如下地址，進入除錯狀態 ：http://localhost/zuches/index.php?XDEBUG_SESSION_START=netbeans-xdebug 同時執行位置指示停留到了 index.php 的第一行。如下：

點選繼續執行，由於在 IndexController.class.php 的 index 方法中加上了斷點，所以位置指示又停留在了相應的斷點處。

這個時候，我們可以檢視中斷時候的呼叫堆疊和變數了。通過堆疊可以方便地定位到各定位的類和相應方法。

各種變數，無論是區域性變數和例項屬性，無論是 cookie，還是提交資料，都能在變數表中看到，一目瞭然。

總之，Xdebug 讓我們即使做的是伺服器端頁面和 API 開發，也可以像桌面應用開發一樣，除錯每一行程式碼了。
Xdebug 除了使用來進行單步除錯之外，還能收集請求中的執行日誌，記錄每一個函式的執行過程。這些日誌可以用 wincachegrind 等工具進行分析，看到函式的呼叫棧和所花的時間。這裡不再贅述，我們也不是很推薦，因為 XHProf 在這塊要輕量級和強大的多，不用如此費勁地下載日誌，分析日誌。
XHProf
如前文所述，對於 PHP 中函式呼叫棧和效能分析，XHProf 將 Xdebug 開的先河繼承併發揚光大。XHProf 也是 PHP 擴充套件，不過不建議從http://pecl.php.net/package/xhprof 上下載，版本已有近2年沒有更新了，最好從https://github.com/phacility/xhprof 上下載。下載編譯配置和使用過程都很簡單。
配置只需要加上如下兩行：

[xhprof]
extension=/usr/lib/php/extensions/no-debug-non-zts-20121212/xhprof.so

然後將要相應的 XHProf 程式碼配置到需要監控的頁面中，即可以獲得整個頁面的執行中，各函式的呼叫報表。XHProf 提供了示例，配置成功執行如下：

如何看到上面圖中的效果呢？將 examples、xhprof_html、xhprof_lib 三個目錄放到瀏覽器能訪問到的地方，比如 localhost 的主目錄內。修改 examples/sample.php 中的 <xhprof-ui-address> 換成 如：localhost/xhprof_html/。即可。
然後訪問 http://localhost/examples/sample.php 即可以得到輸出結果如下：

從 examples/sample.php 中可以看到，對於頁面的監測分析，在頁面頂部使用 xhprof_enable 開始，而效能的分析的結束，則是在頁面底部使用 xhprof_disable 結束 。這樣每次監控，都需要增加一段程式碼，所以為了規範起見。對 XHProf 相關的操作進行了封裝。繼續採用上例 ThinkPHP 版租車系統的例子，看看如何整合 XHProf 分析。
首先將對 XHProf 的操作封裝成了一個類。

<?php  
class XHProf  
{

    private static $strNameSpace = "";
    public static function init($strNameSpace = "myhome")
    {
        if (!function_exists("xhprof_enable"))
        {
            return;
        }
        self::$strNameSpace = strval($strNameSpace);

        $param = XHPROF_FLAGS_CPU + XHPROF_FLAGS_MEMORY;

    $path = getcwd();
        require_once $path.'/../xhprof_lib/utils/xhprof_lib.php';
        require_once $path.'/../xhprof_lib/utils/xhprof_runs.php';
        xhprof_enable($param);

        register_shutdown_function("XHProf::genResult");
    }

    public static function genResult()
    {

        $profiler_namespace = self::$strNameSpace;
        $xhprof_data = xhprof_disable();
        $xhprof_runs = new XHProfRuns_Default();
        $run_id = $xhprof_runs->save_run($xhprof_data, $profiler_namespace);
        $profiler_url = sprintf('http://' . $_SERVER['HTTP_HOST'] . '/xhprof_html/index.php?run=%s&source=%s', $run_id, $profiler_namespace);
        echo '<p style="position:absolute; left:0; top:0; background:orange; padding:8px;">'
        . '<a href="' . $profiler_url . '" target="_blank">Profiler output</a></p>';
    }

}

在這個封裝的類中，首先檢測了 xhprof_enable 函式是否存在，這可以用於判斷是否成功安裝配置了 xhprof 擴充套件。其次設定了引數，特別值得一提的是使用函式 register_shutdown_function 來註冊一個操作，這個操作在頁面結束之前，會自動執行。
這樣，在分析頁面效能之時，只需要在 ThinkPHP 應用的 index.php 上加上兩行，即可以了。
比如：

require_once "xhprof.php";  
XHProf::init("zuches");

執行後，得到如下效果：

並且每一個頁面，都有這樣的輸出。點選「Profiler output」即得到了報表。

在本例中，可以看到最後的整合方法，執行時間超過了2 S，是值得關注並優化了。從報表中，可以首先看到各個方法或者函式的呼叫次數，執行時間，以及可以層層點進去看到父子層級的呼叫關係 。
需要注意的是，線上上，如上使用 XHProf 要慎重，即使開啟，也要有限制條件地開啟，比如當前使用者是某些除錯開發者使用者時才開啟。否則，普通使用者看到這樣的輸出，則不明所以，給使用者帶來困惑，當然，我們也可以不輸出，而將資料直接儲存，在後臺系統中檢視，這樣使用者就感受不到了。有一個工具，可以完全消除這些糾結。那就是 OneAPM，在第四部分我們再介紹。
SocketLog
作為程式設計師，除了新功能開發之外，最常見的一個工作就是查錯，尤其是遠端使用者的查錯，還是一個很痛苦的過程。當前又加上了微信開發，API 開發等操作。對於微信內、API 由遠端使用者所呼叫的時候，情況多變，查錯也更加地麻煩。這個時候，我們的第三個神器登場了。那就是 SocketLog。
SocketLog 是國內知名 PHP 開發者羅飛的作品，羅飛是 ThinkPHP 的核心開發者，也是優才學院全棧工程師主力講師。現任三生社群 CTO。SocketLog 的 github 地址為：https://github.com/luofei614/SocketLog ，在專案的主頁上，詳細地介紹了用法和所用的技術。這裡簡單地彙總講解一下。
SocketLog 的使用，主要要分成三個步驟，第一步是安裝 Chrome 外掛。可以從 github 下載的安裝包中去安裝，或者可以從 Chrome 應用商店下載。
第二步是需要啟動 Socket 服務，Socket 服務是 WebSocket 協議的，早期版本是 PHP 編寫的伺服器，新的版本已經使用 Node.js 來實現了。啟動方法很簡單，進入解壓後的目錄。
執行 node server/index.js 即可。
安裝好外掛之後，就在 Chrome 上看到如下圖示。灰色表示沒有連線上。

同時啟動了伺服器，做好設定，就會看到圖示變成藍色了。

需要注意的是，儘管我們這裡監聽地址配置成了本地地址，其實也可以配置遠端地址。不過遠端地址的話記得開啟伺服器上的防火牆，因為一般1229埠在防火牆中是關閉的。
SocketLog 的原理，是在伺服器端，往 WebSocket 伺服器上寫資料，作為客戶端的 Chrome 外掛，即能收到資料。所以不管是遠端 API 呼叫，還是網頁訪問，只要在程式中往這個 WebSocket 伺服器寫了資料，只要監聽了這個 Websocket 服務的客戶端都能收到相應的除錯日誌。
第三步是埋程式碼。使用方法也很簡單。比如我們在上面的 ThinkPHP 的 index.php 加入兩行程式碼。會看到如下輸出 。

然後我們在其他終端上也訪問一下這臺機器的這個頁面地址，看看是否能得到輸出呢？開始沒有任何輸出效果。因為預設情況下是不記錄普通使用者所呼叫的 slog 的。
在 slog 之上的語句加上這一行，就有了。

slog(array('force_client_id'=>'test'),'set_config');

Test 這個外掛的使用者，收到了所有的 slog 訊息。如下圖所示：

並且這種輸出 ，無論是別的使用者觸發，而還後臺服務程式，均可以輸出 。所以非常地方便，開發人員在自己的機器上就收集到了想要收集的使用者所觸發的除錯資訊。
然後為了體現對 SQL 語句的監聽。我們在 ThinkPHP/Library/Think/Db/Driver.class.php的第1139行加上 slog($str)，然後再訪問頁面，就得到了如下輸出 ，可見實現了對 SQL 日誌的監控。
SocketLog 的功能看起來雖然簡單，但是卻非常有用、好用，是不可多得的開發神器。有關 SocketLog 的更多介紹和使用說明，建議現在就立刻下載，並且進入 github 主頁好好地研究吧！
OneAPM
從上面的使用來看，SocketLog 和 XHProf 都有兩個不足之處，一是需要埋程式碼，二是隻是基於單獨一個頁面會話的。而 OneAPM 相對來講，就更強大了，可以理解為雲端 SaaS 版的 XHProf 和更強大的 SocketLog。不過有著更為強大的優勢。比如:

• OneAPM 的 PHP 探針，安裝完成之後，並不需要在程式碼中埋入任何程式碼。
  
• 在資料收集的過程中，不需要開發和運維的參與，探針全自動收集，並提交到遠端伺服器。
  
• 由於資料累積，所以支援歷史報表，以及比 XHProf 和 SocketLog 更豐富的功能。
  
• PHP 只是 OneAPM 所支援的一種語言，它可以支援多種語言，HTML5、iOS、Android、Java、.NET、python、Node.js、PHP、ruby等。
  

OneAPM 的安裝過程也比較簡單，不過由於是 SaaS 服務，所以得上官網註冊一個賬號。登入了之後，在應用程式裡，點選新增，再選中 PHP，就進入了安裝探針的說明。

分為如下幾步：
1. 獲取授權編號
OneAPM 授權憑證，用於配置和身份識別。
2. 下載 OneAPM PHP agent 安裝程式
3. 解壓 OneAPM PHP Agent

tar -xzf OneAPM_php_Agent_2.3.11.tar.gz

4. 安裝 OneAPM PHP Agent

• 定位路徑至您的安裝包所在資料夾

cd oneapm-php5-linux-install-script

• 執行安裝命令

sudo ./oneapm-install install

5. 輸入 License Key
請點選步驟1中的「生成授權編號按鈕」成功安裝，介面如下：

若出現以下資訊，則代表安裝成功。

OneAPM is now installed on your system. Congratulations!

當頁面出現以下提示時，啟動 Daemon

And then start php-agent in /usr/bin/oneapm-daemon

執行以下指令來啟動 Daemon

sudo /usr/bin/oneapm-daemon

重啟 Apache 或你使用的 web 排程程式 「如 php-fpm 」
6. 靜候5分鐘，開啟 OneAPM 之旅
靜候5分鐘，等待應用程式向 OneAPM 傳送應用程式效能資料，即可開始使用 OneAPM 應用效能管理。
OneAPM 收集的資料很豐富。將收集的響應時間資料，分為四個大塊:

• Web 事務，就是頁面業務邏輯本身
  
• 資料庫，資料庫的連線和資料讀取
  
• 錯誤統計，對所有型別的錯誤做了歸類統計
  
• 外部服務，即外部 API 等的裝置
  

以筆者的站點為例，12小時的資料如下圖：

從上面這個圖，我們看到響應時間，慢的達到了600 ms 以上，那是什麼導致的呢？我們可以分別檢視：

可見 Web 事務比較穩定，可以比較清楚地看到平均的響應時間在 50ms-75ms之間。

資料庫響應時間也很短，在幾 ms 這個級別。而外部服務就明顯在幾百 ms 這個級別，還有的高達 600 ms 。

不說別的，就通過這簡單的報表，從目前看，就可以定位到，想要做優化，從外部服務的響應時間上下手優化，帶來的效果是最大的。
下面我們再來看看三個細化一層的報表 ，在 Web 事務統計中，儘管平均數很低，但是也列出了響應時間最長的5個請求。如下：

從上面的資料可以看出，響應時間最長的幾個，主要突出在 bind.php，這個是負責 QQ 登入的請求，需要向騰訊請求資料。
而在資料庫一欄中，可以看到最慢的5個表格的情況。

在外部的服務中，果不出所料，是對微博、微信、QQ 登入、七牛上傳、支付寶通知等外部服務，所佔時間最長。如下圖所示。

這只是普通的統計報表，對於具體的某一個慢的頁面，更有詳細的呼叫分析。
比如上面的 bind.php ，果真最慢的是從網路上獲取資料。也就是說，第三方登入時，從第三方網站取資料花了絕大部分時間。 去檢視詳情，OneAPM 稱為慢事務追蹤，拉到頁面的最底部就能看到。


在後臺報表中，我們同樣也能看到是哪些 SQL 語句慢。比如如下是 bind.php 中慢的 SQL 語句。

更為重要的是，還有所有錯誤資訊的收集，也一目瞭然。

所以無論從功能之強大，還是易用之方便，OneAPM 不愧是商業化的 SaaS 服務，比 XHProf 勝去了不少。在筆者的專案中，已經大量使用。並取得了好的效果。
以上四個專案，讓我們對自己所寫的程式碼，更加成竹在胸，無論是執行過程還是調優著手了都有了充分的把握。特意對比，彙總整理的這四大神器，希望它們能改善每一位 PHP 開發者的生活，讓我們的 PHP 開發不再那麼地苦逼！