（轉）利用PHP的debug_backtrace函數，實現PHP文件權限管理、動態加載 【反射】

時間  2019-11-17
標籤 利用 php debug backtrace 函數 實現 文件 權限 管理 動態 加載 反射 欄目 PHP 简体版
原文   原文鏈接

原文地址：http://www.cnblogs.com/melonblog/archive/2013/05/09/3062303.htmlphp

原文做者：豆漿油條 - melonhtml

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

 

簡述

可能你們都知道，php中有一個函數叫debug_backtrace，它能夠回溯跟蹤函數的調用信息，能夠說是一個調試利器。緩存

好，來複習一下。app

複製代碼 
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獲取當前函數或者方法名稱的方法。測試

代碼以下：ui

複製代碼 
//函數外部輸出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
複製代碼

 

看上去沒有問題，很好。spa

 

 

加載相對路徑文件

若是在項目中要加載相對路徑的文件，必需使用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有很好的靈活性，只要稍加利用，能夠實現一些有趣的功能。但同時我發現它並非很好控制，由於每次調用任何一個方法或函數，都有可能改變它的值。若是要使用它來作一些邏輯處理（好比說我本文提到的一些想法），須要一個擁有良好規範準則的系統，至少在加載文件方面吧。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程