PHP debug_backtrace的胡思亂想

来源:http://www.cnblogs.com/shouce/archive/2016/06/03/5555070.html
-Advertisement-
Play Games

本文示例代碼測試環境是Windows下的APMServ（PHP5.2.6） 簡述 可能大家都知道，php中有一個函數叫debug_backtrace，它可以回溯跟蹤函數的調用信息，可以說是一個調試利器。 好，來複習一下。 one(); function one() { two(); } functi ...


本文示例代碼測試環境是Windows下的APMServ（PHP5.2.6）

 

簡述

可能大家都知道，php中有一個函數叫debug_backtrace，它可以回溯跟蹤函數的調用信息，可以說是一個調試利器。

好，來複習一下。

複製代碼 
one();

function one() {
    two();
}

function two() {
    three();
}

function three() {
    print_r( debug_backtrace() );
}

/*
輸出：
Array
(
    [0] => Array
        (
            [file] => D:\apmserv\www\htdocs\test\debug\index.php
            [line] => 10
            [function] => three
            [args] => Array
                (
                )

        )

    [1] => Array
        (
            [file] => D:\apmserv\www\htdocs\test\debug\index.php
            [line] => 6
            [function] => two
            [args] => Array
                (
                )

        )

    [2] => Array
        (
            [file] => D:\apmserv\www\htdocs\test\debug\index.php
            [line] => 3
            [function] => one
            [args] => Array
                (
                )

        )

)
*/
複製代碼

 

順便提一下類似的函數：debug_print_backtrace，與之不同的是它會直接列印回溯信息。

回來看debug_backtrace，從名字來看用途很明確，是讓開發者用來調試的。直到有一天我註意到它返回的file參數，file表示函數或者方法的調用腳本來源（在哪個腳本文件使用的）。忽然我想到，如果當前腳本知道調用來源，那是否可以根據這個來源的不同，來實現一些有趣的功能，比如文件許可權管理、動態載入等。

 

 

實戰

 

實現魔術函數 

獲取當前函數或方法的名稱 

儘管PHP中已經有了__FUNCTION__和__METHOD__魔術常量，但我還是想介紹一下用debug_backtrace獲取當前函數或者方法名稱的方法。

代碼如下：

複製代碼 
//函數外部輸出getFuncName的值
echo getFuncName();

printFuncName();

Object::printMethodName();

//調用了上面兩個函數後，再次在外部輸出getFuncName，看看是否有‘緩存’之類的問題
echo getFuncName();



function printFuncName() {
    echo getFuncName();
}

class Object {
    static function printMethodName() {
        echo getFuncName();
    }
}

/**
 * 獲取當前函數或者方法的名稱
 * 函數名叫getFuncName，好吧，其實method也可以當做function，實在想不出好名字
 * 
 * @return string name
 */
function getFuncName() {
    $debug_backtrace = debug_backtrace();
    //如果函數名是以下幾個，表示載入了腳本，併在函數外部調用了getFuncName
    //這種情況應該返回空
    $ignore = array(
        'include',
        'include_once',
        'require',
        'require_once'
    );
    //第一個backtrace就是當前函數getFuncName，再上一個（第二個）backtrace就是調用getFuncName的函數了
    $handle_func = $debug_backtrace[1];
    if( isset( $handle_func['function'] ) && !in_array( $handle_func['function'], $ignore ) ) {
        return $handle_func['function'];
    }
    return null;
}


//輸出：
//null
//printFuncName
//printMethodName
//null
複製代碼

 

看上去沒有問題，很好。

 

 

載入相對路徑文件

如果在項目中要載入相對路徑的文件，必需使用include或者require之類的原生方法，但現在有了debug_backtrace，我可以使用自定義函數去載入相對路徑文件。

新建一個項目，目錄結構如下：

 

我想在index.php中調用自定義函數，並使用相對路徑去載入package/package.php，並且在package.php中使用同樣的方法載入_inc_func.php 

三個文件的代碼如下（留意index.php和package.php調用import函數的代碼）：

index.php：

複製代碼 
<?php

import( './package/package.php' );

/**
 * 載入當前項目下的文件
 * 
 * @param string $path 相對文件路徑
 */
function import( $path ) {
    //獲得backstrace列表
    $debug_backtrace = debug_backtrace();
    //第一個backstrace就是調用import的來源腳本
    $source = $debug_backtrace[0];

    //得到調用源的目錄路徑，和文件路徑結合，就可以算出完整路徑
    $source_dir = dirname( $source['file'] );
    require realpath( $source_dir . '/' . $path );
}

?>
複製代碼

package.php：

複製代碼 
<?php

echo 'package';

import( './_inc_func.php' );

?>
複製代碼

_inc_func.php：

<?php

echo '_inc_func';

?>

 

運行index.php：

//輸出：
//package
//_inc_func

 

可以看到，我成功了。

思考：這個方法我覺得非常強大，除了相對路徑之外，可以根據這個思路引伸出相對包、相對模塊之類的抽象特性，對於一些項目來說可以增強模塊化的作用。

 

 

管理文件調用許可權

我約定一個規範：文件名前帶下劃線的只能被當前目錄的文件調用，也就是說這種文件屬於當前目錄‘私有’，其它目錄的文件不允許載入它們。

這樣做的目的很明確：為了降低代碼耦合性。在項目中，很多時候一些文件只被用在特定的腳本中。但是經常發生的事情是：一些程式員發現這些腳本有自己需要用到的函數或者類，因此直接載入它來達到自己的目的。這樣的做法很不好，原本這些腳本編寫的目的僅僅為了輔助某些介面實現，它們並沒有考慮到其它通用性。萬一介面內部需要重構，同樣需要改動這些特定的腳本文件，但是改動後一些看似與這個介面無關腳本卻突然無法運行了。一經檢查，卻發現文件的引用錯綜複雜。

規範只是監督作用，不排除有人為了一己私欲而違反這個規範，或者無意中違反了。最好的方法是落實到代碼中，讓程式自動去檢測這種情況。

 

新建一個項目，目錄結構如下。

 

那麼對於這個項目來說，_inc_func.php屬於package目錄的私有文件，只有package.php可以載入它，而index.php則沒有這個許可權。

package目錄是一個包，package.php下提供了這個包的介面，同時_inc_func.php有package.php需要用到的一些函數。index.php將會使用這個包的介面文件，也就是package.php

 

它們的代碼如下

index.php：

複製代碼 
<?php

header("Content-type: text/html; charset=utf-8");

//定義項目根目錄
define( 'APP_PATH', dirname( __FILE__ ) );

import( APP_PATH . '/package/package.php' );
//輸出包的信息
Package_printInfo();

/**
 * 載入當前項目下的文件
 * 
 * @param string $path 文件路徑
 */
function import( $path ) {
    
    //應該檢查路徑的合法性
    $real_path = realpath( $path );
    $in_app = ( stripos( $real_path, APP_PATH ) === 0 );
    if( empty( $real_path ) || !$in_app ) {
        throw new Exception( '文件路徑不存在或不被允許' );
    }
    
    include $real_path;
}

?>
複製代碼

_inc_func.php：

複製代碼 
<?php

function _Package_PrintStr( $string ) {
    echo $string;
}

?>
複製代碼

package.php：

複製代碼 
<?php

define( 'PACKAGE_PATH', dirname( __FILE__ ) );

//引入私有文件
import( PACKAGE_PATH . '/_inc_func.php' );

function Package_printInfo() {
    _Package_PrintStr( '我是一個包。' );
}

?>
複製代碼

 

運行index.php：

//輸出：
//我是一個包。

 

整個項目使用了import函數載入文件，並且代碼看起來是正常的。但是我可以在index.php中載入package/_inc_func.php文件，並調用它的方法。

index.php中更改import( APP_PATH . '/package/package.php' );處的代碼，並運行：

複製代碼 
import( APP_PATH . '/package/_inc_func.php' );

_Package_PrintStr( '我載入了/package/_inc_func.php腳本' );

//輸出：
//我載入了/package/_inc_func.php腳本
複製代碼

 

那麼，這時可以使用debug_backtrace檢查載入_inc_func.php文件的路徑來自哪裡，我改動了index.php中的import函數，完整代碼如下：

複製代碼 
/**
 * 載入當前項目下的文件
 * 
 * @param string $path 文件路徑
 */
function import( $path ) {
    
    //首先應該檢查路徑的合法性
    $real_path = realpath( $path );
    $in_app = ( stripos( $real_path, APP_PATH ) === 0 );
    if( empty( $real_path ) || !$in_app ) {
        throw new Exception( '文件路徑不存在或不被允許' );
    }
    
    $path_info = pathinfo( $real_path );
    //判斷文件是否屬於私有
    $is_private = ( substr( $path_info['basename'], 0, 1 ) === '_' );
    if( $is_private ) {
        //獲得backstrace列表
        $debug_backtrace = debug_backtrace();
        //第一個backstrace就是調用import的來源腳本
        $source = $debug_backtrace[0];
        
        //得到調用源路徑，用它來和目標路徑進行比較
        $source_dir = dirname( $source['file'] );
        $target_dir = $path_info['dirname'];
        //不在同一目錄下時拋出異常
        if( $source_dir !== $target_dir ) {
            $relative_source_file = str_replace( APP_PATH, '', $source['file'] );
            $relative_target_file = str_replace( APP_PATH, '', $real_path );
            $error = $relative_target_file . '文件屬於私有文件,' . $relative_source_file . '不能載入它。';
            throw new Exception( $error );
        }
    }
    
    include $real_path;
}
複製代碼

 

 這時再運行index.php，將產生一個致命錯誤：

//輸出：
//致命錯誤：/package/_inc_func.php文件屬於私有文件,/index.php不能載入它。

 

而載入package.php則沒有問題，這裡不進行演示。

可以看到，我當初的想法成功了。儘管這樣，在載入package.php後，其實在index.php中仍然還可以調用_inc_func.php的函數（package.php載入了它）。因為除了匿名函數，其它函數是全局可見的，包括類。不過這樣或多或少可以讓程式員警覺起來。關鍵還是看程式員本身，再好的規範和約束也抵擋不住爛程式員，他們總是會比你‘聰明’。

 

 

debug_backtrace的'BUG'

如果使用call_user_func或者call_user_func_array調用其它函數，它們調用的函數裡面使用debug_backtrace，將獲取不到路徑的信息。

例：

複製代碼 
call_user_func('import');

function import() {
    print_r( debug_backtrace() );
}


/*
輸出：
Array
(
    [0] => Array
        (
            [function] => import
            [args] => Array
                (
                )

        )

    [1] => Array
        (
            [file] => F:\www\test\test\index.php
            [line] => 3
            [function] => call_user_func
            [args] => Array
                (
                    [0] => import
                )

        )

)
*/
複製代碼

 

註意輸出的第一個backtrace，它的調用源路徑file沒有了，這樣一來我之前的幾個例子將會產生問題。當然可能你註意到第二個backtrace，如果第一個沒有就往回找。但經過實踐是不可行的，之前我就碰到這種情況，同樣會有問題，但是現在無法找回那時的代碼了，如果你發現，請將問題告訴我。就目前來說，最好不要使用這種方法，我有一個更好的解決辦法，就是使用PHP的反射API。

 

使用反射

使用反射API可以知道函數很詳細的信息，當然包括它聲明的文件和所處行數

複製代碼 
call_user_func('import');

function import() {
    $debug_backtrace = debug_backtrace();
    $backtrace = $debug_backtrace[0];
    if( !isset( $backtrace['file'] ) ) {
        //使用反射API獲取函數聲明的文件和行數
        $reflection_function = new ReflectionFunction( $backtrace['function'] );
        $backtrace['file'] = $reflection_function->getFileName();
        $backtrace['line'] = $reflection_function->getStartLine();
    }
    print_r($backtrace);
}

/*
輸出：
Array
(
    [function] => import
    [args] => Array
        (
        )

    [file] => F:\www\test\test\index.php
    [line] => 5
) 
*/
複製代碼

 

可以看到通過使用反射介面ReflectionMethod的方法，file又回來了。

類方法的反射介面是ReflectionMethod，獲取聲明方法同樣是getFileName。

 

 

總結

在一個項目中，我通常不會直接使用include或者require載入腳本。我喜歡把它們封裝到一個函數里，需要載入腳本的時候調用這個函數。這樣可以在函數里做一些判斷，比如說是否引入過這個文件，或者增加一些調用規則等，維護起來比較方便。

幸好有了這樣的習慣，所以我可以馬上把debug_backtrace的一些想法應用到整個項目中。

總體來說debug_backtrace有很好的靈活性，只要稍加利用，可以實現一些有趣的功能。但同時我發現它並不是很好控制，因為每次調用任何一個方法或函數，都有可能改變它的值。如果要使用它來做一些邏輯處理（比如說我本文提到的一些想法），需要一個擁有良好規範準則的系統，至少在載入文件方面吧。

 

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • java語言的國際化
    我們可以使用jdk內置的 Locale 類來實現java語言的國際化。使用方法很簡單： 命名格式為： xxx_語言代碼_國家代碼 我們這裡 用到了 中英文名稱為: RetrievingRequestXMLError=Error retrieving requestXML from HTTP POST ...
  • 九度OJ--1167（C++）
    #include <iostream>#include <algorithm>#include <map> using namespace std; int main() { int n, i, *arr1, *arr2; map<int, int> match; while(cin>>n) { a ...
  • 走進Java中的持有對象(容器類)之一 容器分類
    Java容器可以說是增強程式員編程能力的基本工具，本系列將帶您深入理解容器類。 容器的用途 如果對象的數量與生命周期都是固定的，自然我們也就不需要很複雜的數據結構。 我們可以通過創建引用來持有對象，如 也可以通過數組來持有多個對象，如 然而，一般情況下，我們並不知道要創建多少對象，或者以何種方式創建 ...
  • 生成PDF全攻略之在已有PDF上添加內容
    項目在變，需求在變，不變的永遠是敲擊鍵盤的程式員..... PDF 生成後，有時候需要在PDF上面添加一些其他的內容，比如文字,圖片.... 經歷幾次失敗的嘗試，終於獲取到了正確的代碼書寫方式。 在此記錄總結，方便下次以不變應萬變，需要的 jar 請移步：生成PDF全攻略 上述的這段代碼算是在原有 ...
  • aardio中獲取網路圖片經GDI處理後保存到本地
    摘自aardio培訓群 www.aardio.com ...
  • elixir 高可用系列（四） Task
    概述 之前學習的 Agent，GenSever以及GenEvent，都是用來管理狀態或者處理消息的。 但是在很多時候，我們需要的是執行某個任務，這時如果使用 GenSever 或者 GenEvent，就會顯得比較笨重。 這時，我們就可以使用 Task 模塊，使用 Task 模塊時註意以下幾點: 1. ...
  • Python下Tesseract Ocr引擎及安裝介紹
    1、Tesseract介紹 tesseract 是一個google支持的開源ocr項目，其項目地址：https://github.com/tesseract-ocr/tesseract，目前最新的源碼可以在這裡下載。 實際使用tesseract ocr也有兩種方式：1- 動態庫方式 libtesse ...
  • 第一個Python程式——博客自動訪問腳本
    動機 今天有朋友寫信說他認為自己的wordpress博客內顯示的訪問統計信息不正常，希望我能為他製造一些訪問信息，供他對比。朋友提出的請求是在短時間內快速打開100個不同的博客頁面，以便他從產生的訪問量變化中理解博客訪問數據。 本人作為一個搞電腦的人，有把任何重覆性勞動自動化的衝動，所以雖然點開1 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類