PHP debug_backtrace에 대한 무작위 생각
- 黄舟원래의
- 2016-12-28 13:33:221316검색
간략한 설명
여러분도 아시다시피 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은 함수나 메소드(스크립트 파일이 사용되는)의 호출 스크립트 소스를 나타냅니다. 갑자기 현재 스크립트가 호출 소스를 알고 있다면 파일 권한 관리, 동적 로딩 등과 같은 소스를 기반으로 몇 가지 흥미로운 기능을 구현할 수 있을까 하는 생각이 들었습니다.
실전 전투
마법 기능 구현
현재 함수나 메서드 이름 가져오기
이미 __FUNCTION__이 있지만 PHP 및 __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.php, 동일한 방법을 사용하여 package.php에 _inc_func.php를 로드합니다
세 파일의 코드는 다음과 같습니다(가져오기를 호출하는 index.php 및 package.php의 코드에 주의하세요) 함수):
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:
<?phpecho '_inc_func';?>
인덱스 실행 .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有很好的灵活性，只要稍加利用，可以实现一些有趣的功能。但同时我发现它并不是很好控制，因为每次调用任何一个方法或函数，都有可能改变它的值。如果要使用它来做一些逻辑处理（比如说我本文提到的一些想法），需要一个拥有良好规范准则的系统，至少在加载文件方面吧。
以上就是PHP debug_backtrace的胡思乱想的内容，更多相关内容请关注PHP中文网（www.php.cn）！