ホームページ > 記事 > バックエンド開発 > PHP debug_backtrace、phpdebugbacktrace_PHP チュートリアルについてのランダムな考え

PHP debug_backtrace、phpdebugbacktrace_PHP チュートリアルについてのランダムな考え

WBOYオリジナル: 2016-07-12 08:51:15938ブラウズ

PHP debug_backtrace、phpdebugbacktraceの雑感

この記事のサンプルコードのテスト環境はWindows上のAPMServ(PHP5.2.6)です

簡単な説明

おそらく皆さんは、PHP に debug_backtrace という関数の呼び出し情報をバックトラックできる、デバッグツールとも言える関数があることをご存知かと思います。

さて、復習しましょう。

PHP debug_backtrace、phpdebugbacktrace_PHP チュートリアルについてのランダムな考え

リーリー

ところで、同様の関数:

debug_print_backtrace ですが、違いはバックトレース情報を直接出力することです。

戻ってdebug_backtraceを見てください。名前から判断すると、目的は非常に明確で、開発者がデバッグのために使用します。ある日、返される file パラメータに気づくまで、file は関数またはメソッドの呼び出しスクリプトソース (どのスクリプトファイルで使用されるか) を表していました。突然、現在のスクリプトが呼び出し元を知っている場合、ファイルのアクセス許可管理、動的読み込みなど、ソースに基づいていくつかの興味深い機能を実装できるのではないかと考えました。

実戦

マジック関数を実装する

現在の関数またはメソッドの名前を取得します

PHP にはすでに

__FUNCTION__ と __METHOD__ マジック定数がありますが、それでも debug_backtrace を使用して現在の関数またはメソッド名を取得する方法を紹介したいと思います。

コードは次のとおりです:

リーリー

問題ないようです、大丈夫です。

相対パスファイルをロードする

プロジェクトに相対パスファイルをロードしたい場合は、

include や require などのネイティブメソッドを使用する必要がありますが、debug_backtrace を使用してカスタム関数を使用して相対パスファイルをロードできるようになりました。

次のディレクトリ構造で新しいプロジェクトを作成します:

index.php

でカスタム関数を呼び出し、相対パスを使用してpackage/package.phpをロードし、同じメソッドを使用してpackage.phpの_inc_func.phpをロードしたいと考えています 3 つのファイルのコードは次のとおりです (

import

関数を呼び出す index.php と package.php のコードに注意してください):

index.php:

リーリー

package.php:

リーリー

_inc_func.php:

リーリー

index.php

を実行:

リーリー

ご覧のとおり、成功しました。

感想: この方法は非常に強力だと思います。相対パスに加えて、相対パッケージや相対モジュールなどの抽象的な機能もこのアイデアに基づいて派生でき、一部のプロジェクトではモジュール化の役割を強化できます。

ファイル呼び出し権限を管理する

私はルールに同意しました: ファイルの前にアンダースコアがあるファイルは、現在のディレクトリ内のファイルによってのみ呼び出すことができます。つまり、そのようなファイルは現在のディレクトリ内では「プライベート」であり、他のディレクトリ内のファイルはアクセスできません。それらをロードしてください。

この目的は非常に明確です: コードの結合を減らすことです。プロジェクトでは、多くの場合、一部のファイルは特定のスクリプトでのみ使用されます。しかし、プログラマによっては、これらのスクリプトに使用する必要のある関数やクラスがあることに気づき、それを直接ロードして独自の目的を達成することがよくあります。このアプローチは非常に不適切です。これらのスクリプトを作成する本来の目的は、特定のインターフェイスの実装を支援することだけであり、他の汎用性は考慮されていません。インターフェイスを内部的にリファクタリングする必要がある場合は、これらの特定のスクリプトファイルも変更する必要があります。ただし、変更後、インターフェイスと関係がないと思われる一部のスクリプトが突然実行できなくなります。検査したところ、この文書への参照が紛らわしいことが判明しました。

规范只是监督作用，不排除有人为了一己私欲而违反这个规范，或者无意中违反了。最好的方法是落实到代码中，让程序自动去检测这种情况。

新建一个项目，目录结构如下。

那么对于这个项目来说，_inc_func.php属于package目录的私有文件，只有package.php可以载入它，而index.php则没有这个权限。

package目录是一个包，package.php下提供了这个包的接口，同时_inc_func.php有package.php需要用到的一些函数。index.php将会使用这个包的接口文件，也就是package.php

它们的代码如下

index.php：

<?<span>php

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

</span><span>//</span><span>定义项目根目录</span>
<span>define</span>( 'APP_PATH', <span>dirname</span>( <span>__FILE__</span><span> ) );

import( APP_PATH </span>. '/package/package.php'<span> );
</span><span>//</span><span>输出包的信息</span>
<span>Package_printInfo();

</span><span>/*</span><span>*
 * 加载当前项目下的文件
 * 
 * @param string $path 文件路径
 </span><span>*/</span>
<span>function</span> import( <span>$path</span><span> ) {
    
    </span><span>//</span><span>应该检查路径的合法性</span>
    <span>$real_path</span> = <span>realpath</span>( <span>$path</span><span> );
    </span><span>$in_app</span> = ( <span>stripos</span>( <span>$real_path</span>, APP_PATH ) === 0<span> );
    </span><span>if</span>( <span>empty</span>( <span>$real_path</span> ) || !<span>$in_app</span><span> ) {
        </span><span>throw</span> <span>new</span> <span>Exception</span>( '文件路径不存在或不被允许'<span> );
    }
    
    </span><span>include</span> <span>$real_path</span><span>;
}

</span>?>

_inc_func.php：

<?<span>php

</span><span>function</span> _Package_PrintStr( <span>$string</span><span> ) {
    </span><span>echo</span> <span>$string</span><span>;
}

</span>?>

package.php：

<?<span>php

</span><span>define</span>( 'PACKAGE_PATH', <span>dirname</span>( <span>__FILE__</span><span> ) );

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

</span><span>function</span><span> Package_printInfo() {
    _Package_PrintStr( </span>'我是一个包。'<span> );
}

</span>?>

运行index.php：

<span>//</span><span>输出：
//我是一个包。</span>

整个项目使用了import函数载入文件，并且代码看起来是正常的。但是我可以在index.php中载入package/_inc_func.php文件，并调用它的方法。

index.php中更改import( APP_PATH . '/package/package.php' );处的代码，并运行：

import( APP_PATH . '/package/_inc_func.php'<span> );

_Package_PrintStr( </span>'我载入了/package/_inc_func.php脚本'<span> );

</span><span>//</span><span>输出：
//我载入了/package/_inc_func.php脚本</span>

那么，这时可以使用debug_backtrace检查载入_inc_func.php文件的路径来自哪里，我改动了index.php中的import函数，完整代码如下：

<span>/*</span><span>*
 * 加载当前项目下的文件
 * 
 * @param string $path 文件路径
 </span><span>*/</span>
<span>function</span> import( <span>$path</span><span> ) {
    
    </span><span>//</span><span>首先应该检查路径的合法性</span>
    <span>$real_path</span> = <span>realpath</span>( <span>$path</span><span> );
    </span><span>$in_app</span> = ( <span>stripos</span>( <span>$real_path</span>, APP_PATH ) === 0<span> );
    </span><span>if</span>( <span>empty</span>( <span>$real_path</span> ) || !<span>$in_app</span><span> ) {
        </span><span>throw</span> <span>new</span> <span>Exception</span>( '文件路径不存在或不被允许'<span> );
    }
    
    </span><span>$path_info</span> = <span>pathinfo</span>( <span>$real_path</span><span> );
    </span><span>//</span><span>判断文件是否属于私有</span>
    <span>$is_private</span> = ( <span>substr</span>( <span>$path_info</span>['basename'], 0, 1 ) === '_'<span> );
    </span><span>if</span>( <span>$is_private</span><span> ) {
        </span><span>//</span><span>获得backstrace列表</span>
        <span>$debug_backtrace</span> = <span>debug_backtrace</span><span>();
        </span><span>//</span><span>第一个backstrace就是调用import的来源脚本</span>
        <span>$source</span> = <span>$debug_backtrace</span>[0<span>];
        
        </span><span>//</span><span>得到调用源路径，用它来和目标路径进行比较</span>
        <span>$source_dir</span> = <span>dirname</span>( <span>$source</span>['file'<span>] );
        </span><span>$target_dir</span> = <span>$path_info</span>['dirname'<span>];
        </span><span>//</span><span>不在同一目录下时抛出异常</span>
        <span>if</span>( <span>$source_dir</span> !== <span>$target_dir</span><span> ) {
            </span><span>$relative_source_file</span> = <span>str_replace</span>( APP_PATH, '', <span>$source</span>['file'<span>] );
            </span><span>$relative_target_file</span> = <span>str_replace</span>( APP_PATH, '', <span>$real_path</span><span> );
            </span><span>$error</span> = <span>$relative_target_file</span> . '文件属于私有文件,' . <span>$relative_source_file</span> . '不能载入它。'<span>;
            </span><span>throw</span> <span>new</span> <span>Exception</span>( <span>$error</span><span> );
        }
    }
    
    </span><span>include</span> <span>$real_path</span><span>;
}</span>

这时再运行index.php，将产生一个致命错误：

<span>//</span><span>输出：
//致命错误：/package/_inc_func.php文件属于私有文件,/index.php不能载入它。</span>

而载入package.php则没有问题，这里不进行演示。

可以看到，我当初的想法成功了。尽管这样，在载入package.php后，其实在index.php中仍然还可以调用_inc_func.php的函数（package.php载入了它）。因为除了匿名函数，其它函数是全局可见的，包括类。不过这样或多或少可以让程序员警觉起来。关键还是看程序员本身，再好的规范和约束也抵挡不住烂程序员，他们总是会比你‘聪明’。

debug_backtrace的'BUG'

如果使用call_user_func或者call_user_func_array调用其它函数，它们调用的函数里面使用debug_backtrace，将获取不到路径的信息。

例：

<span>call_user_func</span>('import'<span>);

</span><span>function</span><span> import() {
    </span><span>print_r</span>( <span>debug_backtrace</span><span>() );
}


</span><span>/*</span><span>
输出：
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
                )

        )

)
</span><span>*/</span>

注意输出的第一个backtrace，它的调用源路径file没有了，这样一来我之前的几个例子将会产生问题。当然可能你注意到第二个backtrace，如果第一个没有就往回找。但经过实践是不可行的，之前我就碰到这种情况，同样会有问题，但是现在无法找回那时的代码了，如果你发现，请将问题告诉我。就目前来说，最好不要使用这种方法，我有一个更好的解决办法，就是使用PHP的反射API。

使用反射

使用反射API可以知道函数很详细的信息，当然包括它声明的文件和所处行数

<span>call_user_func</span>('import'<span>);

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

</span><span>/*</span><span>
输出：
Array
(
    [function] => import
    [args] => Array
        (
        )

    [file] => F:\www\test\test\index.php
    [line] => 5
) 
</span><span>*/</span>

可以看到通过使用反射接口ReflectionMethod的方法，file又回来了。

类方法的反射接口是ReflectionMethod，获取声明方法同样是getFileName。

总结

在一个项目中，我通常不会直接使用include或者require载入脚本。我喜欢把它们封装到一个函数里，需要载入脚本的时候调用这个函数。这样可以在函数里做一些判断，比如说是否引入过这个文件，或者增加一些调用规则等，维护起来比较方便。

幸好有了这样的习惯，所以我可以马上把debug_backtrace的一些想法应用到整个项目中。

总体来说debug_backtrace有很好的灵活性，只要稍加利用，可以实现一些有趣的功能。但同时我发现它并不是很好控制，因为每次调用任何一个方法或函数，都有可能改变它的值。如果要使用它来做一些逻辑处理（比如说我本文提到的一些想法），需要一个拥有良好规范准则的系统，至少在加载文件方面吧。

声明：

この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

前の記事：PHP セッション処理関数 session、セッション関数 session_PHP チュートリアル次の記事：PHP セッション処理関数 session、セッション関数 session_PHP チュートリアル

続きを見る

PHP debug_backtrace、phpdebugbacktrace_PHP チュートリアルについてのランダムな考え

PHP debug_backtrace、phpdebugbacktraceの雑感

簡単な説明

debug_backtrace的'BUG'

使用反射

总结

関連記事