PHP debug_backtrace的胡思乱想

时间  2019-11-19
标签 php debug backtrace 胡思乱想 栏目 PHP 繁體版
原文   原文链接

本文示例代码测试环境是Windows下的APMServ（PHP5.2.6） php

 

简述

可能你们都知道，php中有一个函数叫debug_backtrace，它能够回溯跟踪函数的调用信息，能够说是一个调试利器。 html

好，来复习一下。 程序员

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表示函数或者方法的调用脚原本源（在哪一个脚本文件使用的）。突然我想到，若是当前脚本知道调用来源，那是否能够根据这个来源的不一样，来实现一些有趣的功能，好比文件权限管理、动态加载等。 app

 

 

实战

 

实现魔术函数 

获取当前函数或方法的名称 

尽管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，我可使用自定义函数去加载相对路径文件。 ui

新建一个项目，目录结构以下： spa

 


我想在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教程