博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
PHP 自动加载 深度总结
阅读量:7309 次
发布时间:2019-06-30

本文共 19107 字,大约阅读时间需要 63 分钟。

写在前边

我们将介绍 include* require* 的一些使用细节,

以及从 PHP 应用 和 zend 源码角度,来分别分析 __autoload spl_autoload_register 的实现和调用过程。
分析的目的更多的是让自己对这些细节加深认识,并进一步深入了解 Zend 源码。

PHP 版本:`php-5.6`核心方法:` spl_autoload_register`

类加载方式

  • 手动加载
  • __autoload
  • spl_autoload_register

手动加载

包含:include include_once requice requice_one

include

以下文档也适用于 require。

被包含文件先按参数给出的路径寻找,如果没有给出目录(只有文件名)时则按照 include_path 指定的目录寻找。如果在 include_path 下没找到该文件则 include 最后才在调用脚本文件所在的目录和当前工作目录下寻找。如果最后仍未找到文件则 include 结构会发出一条警告;这一点和 require 不同,后者会发出一个致命错误。

如果定义了路径——不管是绝对路径(在 Windows 下以盘符或者 开头,在 Unix/Linux 下以 / 开头)还是当前目录的相对路径(以 . 或者 .. 开头)——include_path 都会被完全忽略。例如一个文件以 ../ 开头,则解析器会在当前目录的父目录下寻找该文件。

代码示例:

FILE: run.php

FILE: class.php

结果:

clipboard.png

结论:

  1. include 成功返回值:1,失败返回值:false
  2. include 失败会有 warning,不会中断进程

include_once

include_once 行为和 include 语句类似,唯一区别是如果该文件中已经被包含过,则不会再次包含。

run.php 修改如下:

结果:

clipboard.png

结论:

  1. include_once 重复包含时,会直接返回 1,并忽略此次包含操作,继续执行

require

requireinclude 几乎完全一样,但 require 在出错时产生 E_COMPILE_ERROR 级别的错误。(脚本将会中止运行)

run.php 修改如下:

结果:

clipboard.png

结论:

  1. require 包含成功,同 include 一样,返回值:1
  2. require 包含失败,直接抛出 Fatal error,进程中止

require_once

require_once 语句和 require 语句完全相同,唯一区别是 PHP 会检查该文件是否已经被包含过,如果是则不会再次包含。

run.php 修改如下:

ini_set('display_errors', '1');// 直接包含$ret = require_once 'class.php';echo sprintf("include ret-value:%d,ret-type:%s\n", $ret, gettype($ret));Foo::getFoo();// 重复包含$ret2 = require_once './class.php';echo sprintf("include ret-value:%d,ret-type:%s\n", $ret, gettype($ret));Foo::getFoo();// 包含不存在的文件$ret1 = require_once './class1.php';echo sprintf("include ret-value:%d,ret-type:%s\n", $ret1, gettype($ret1));

结果:

clipboard.png

结论:

  1. 成功,返回值:1
  2. 重复包含,返回 1,并忽略此次包含

总结

include include_once requice requice_one 成功时,都会返回 1,差别在于 包含失败、重复包含 的处理

__autoload

尝试加载未定义的类。此函数将会在 PHP 7.2.0 中弃用。

PHP 代码解释

使用示例:

FILE:foo.php

FILE:run.php

结果:

➜  load git:(master) ✗ php run.phpI am foo!

结论:

遇到未包含的类,会触发 __autoload 进行加载,如果所有加载规则中没有此类,则 Fatal error

Zend 代码解释

下面,我们来看一下 Zend 引擎是如何触发 __autoload 调用的。

利用 来查看刚才执行过程中产生的 opcode,结果如下:
clipboard.png

我们看到,PHP 运行到第 10 行时,所生成的 opcode 为:INIT_STATIC_METHOD_CALL,两个操作数都为常量(CONST)。

根据 opcode 的处理函数对应规则,我们利用 命名法 可以确定,
处理函数为:ZEND_INIT_STATIC_METHOD_CALL_SPEC_CONST_CONST_HANDLER
源码位置为:vim Zend/zend_vm_execute.h +3819
源码如下:

static int ZEND_FASTCALL  ZEND_INIT_STATIC_METHOD_CALL_SPEC_CONST_CONST_HANDLER(ZEND_OPCODE_HANDLER_ARGS){    USE_OPLINE    zval *function_name;    zend_class_entry *ce;    call_slot *call = EX(call_slots) + opline->result.num;    SAVE_OPLINE();    if (IS_CONST == IS_CONST) {        /* no function found. try a static method in class */        if (CACHED_PTR(opline->op1.literal->cache_slot)) {            ce = CACHED_PTR(opline->op1.literal->cache_slot);        } else {            ce = zend_fetch_class_by_name(Z_STRVAL_P(opline->op1.zv), Z_STRLEN_P(opline->op1.zv), opline->op1.literal + 1, opline->extended_value TSRMLS_CC);            if (UNEXPECTED(EG(exception) != NULL)) {                HANDLE_EXCEPTION();            }            if (UNEXPECTED(ce == NULL)) {                zend_error_noreturn(E_ERROR, "Class '%s' not found", Z_STRVAL_P(opline->op1.zv));            }            CACHE_PTR(opline->op1.literal->cache_slot, ce);        }        call->called_scope = ce;    } else {        ce = EX_T(opline->op1.var).class_entry;        if (opline->extended_value == ZEND_FETCH_CLASS_PARENT || opline->extended_value == ZEND_FETCH_CLASS_SELF) {            call->called_scope = EG(called_scope);        } else {            call->called_scope = ce;        }    }    if (IS_CONST == IS_CONST &&        IS_CONST == IS_CONST &&        CACHED_PTR(opline->op2.literal->cache_slot)) {        call->fbc = CACHED_PTR(opline->op2.literal->cache_slot);    } else if (IS_CONST != IS_CONST &&               IS_CONST == IS_CONST &&               (call->fbc = CACHED_POLYMORPHIC_PTR(opline->op2.literal->cache_slot, ce))) {        /* do nothing */    } else if (IS_CONST != IS_UNUSED) {        char *function_name_strval = NULL;        int function_name_strlen = 0;        if (IS_CONST == IS_CONST) {            function_name_strval = Z_STRVAL_P(opline->op2.zv);            function_name_strlen = Z_STRLEN_P(opline->op2.zv);        } else {            function_name = opline->op2.zv;            if (UNEXPECTED(Z_TYPE_P(function_name) != IS_STRING)) {                if (UNEXPECTED(EG(exception) != NULL)) {                    HANDLE_EXCEPTION();                }                zend_error_noreturn(E_ERROR, "Function name must be a string");            } else {                function_name_strval = Z_STRVAL_P(function_name);                function_name_strlen = Z_STRLEN_P(function_name);             }        }        if (function_name_strval) {            if (ce->get_static_method) {                call->fbc = ce->get_static_method(ce, function_name_strval, function_name_strlen TSRMLS_CC);            } else {                call->fbc = zend_std_get_static_method(ce, function_name_strval, function_name_strlen, ((IS_CONST == IS_CONST) ? (opline->op2.literal + 1) : NULL) TSRMLS_CC);            }            if (UNEXPECTED(call->fbc == NULL)) {                zend_error_noreturn(E_ERROR, "Call to undefined method %s::%s()", ce->name, function_name_strval);            }            if (IS_CONST == IS_CONST &&                EXPECTED(call->fbc->type <= ZEND_USER_FUNCTION) &&                EXPECTED((call->fbc->common.fn_flags & (ZEND_ACC_CALL_VIA_HANDLER|ZEND_ACC_NEVER_CACHE)) == 0)) {                if (IS_CONST == IS_CONST) {                    CACHE_PTR(opline->op2.literal->cache_slot, call->fbc);                } else {                    CACHE_POLYMORPHIC_PTR(opline->op2.literal->cache_slot, ce, call->fbc);                }            }        }        if (IS_CONST != IS_CONST) {        }    } else {        if (UNEXPECTED(ce->constructor == NULL)) {            zend_error_noreturn(E_ERROR, "Cannot call constructor");        }        if (EG(This) && Z_OBJCE_P(EG(This)) != ce->constructor->common.scope && (ce->constructor->common.fn_flags & ZEND_ACC_PRIVATE)) {            zend_error_noreturn(E_ERROR, "Cannot call private %s::__construct()", ce->name);        }        call->fbc = ce->constructor;    }    if (call->fbc->common.fn_flags & ZEND_ACC_STATIC) {        call->object = NULL;    } else {        if (EG(This) &&            Z_OBJ_HT_P(EG(This))->get_class_entry &&            !instanceof_function(Z_OBJCE_P(EG(This)), ce TSRMLS_CC)) {            /* We are calling method of the other (incompatible) class,               but passing $this. This is done for compatibility with php-4. */            if (call->fbc->common.fn_flags & ZEND_ACC_ALLOW_STATIC) {                zend_error(E_DEPRECATED, "Non-static method %s::%s() should not be called statically, assuming $this from incompatible context", call->fbc->common.scope->name, call->fbc->common.function_name);            } else {                /* An internal function assumes $this is present and won't check that. So PHP would crash by allowing the call. */                zend_error_noreturn(E_ERROR, "Non-static method %s::%s() cannot be called statically, assuming $this from incompatible context", call->fbc->common.scope->name, call->fbc->common.function_name);            }        }        if ((call->object = EG(This))) {            Z_ADDREF_P(call->object);            call->called_scope = Z_OBJCE_P(call->object);        }    }    call->num_additional_args = 0;    call->is_ctor_call = 0;    EX(call) = call;    CHECK_EXCEPTION();    ZEND_VM_NEXT_OPCODE();}

通过以上源码,我们发现关键方法为 zend_fetch_class_by_name,跟进此方法:

zend_class_entry *zend_fetch_class_by_name(const char *class_name, uint class_name_len, const zend_literal *key, int fetch_type TSRMLS_DC) /* {
{
{ */{ zend_class_entry **pce; int use_autoload = (fetch_type & ZEND_FETCH_CLASS_NO_AUTOLOAD) == 0; if (zend_lookup_class_ex(class_name, class_name_len, key, use_autoload, &pce TSRMLS_CC) == FAILURE) { if (use_autoload) { if ((fetch_type & ZEND_FETCH_CLASS_SILENT) == 0 && !EG(exception)) { if ((fetch_type & ZEND_FETCH_CLASS_MASK) == ZEND_FETCH_CLASS_INTERFACE) { zend_error(E_ERROR, "Interface '%s' not found", class_name); } else if ((fetch_type & ZEND_FETCH_CLASS_MASK) == ZEND_FETCH_CLASS_TRAIT) { zend_error(E_ERROR, "Trait '%s' not found", class_name); } else { zend_error(E_ERROR, "Class '%s' not found", class_name); } } } return NULL; } return *pce;}

我们发现是通过 zend_lookup_class_ex 来获取类,继续跟进:

ZEND_API int zend_lookup_class_ex(const char *name, int name_length, const zend_literal *key, int use_autoload, zend_class_entry ***ce TSRMLS_DC) /* {
{
{ */{ ... /* 注意:在 类的符号表 中没有找到示例中调用的类 foo */ if (zend_hash_quick_find(EG(class_table), lc_name, lc_length, hash, (void **) ce) == SUCCESS) { if (!key) { free_alloca(lc_free, use_heap); } return SUCCESS; } ... /* * ZVAL_STRINGL 为 zval (即 PHP 类型的实现基础 zvalue_value)赋值宏, * 此处实现了 把 ZEND_AUTOLOAD_FUNC_NAME 值 赋给 autoload_function * #define ZEND_AUTOLOAD_FUNC_NAME "__autoload" */ ZVAL_STRINGL(&autoload_function, ZEND_AUTOLOAD_FUNC_NAME, sizeof(ZEND_AUTOLOAD_FUNC_NAME) - 1, 0); ... fcall_info.size = sizeof(fcall_info); fcall_info.function_table = EG(function_table); fcall_info.function_name = &autoload_function; fcall_info.symbol_table = NULL; fcall_info.retval_ptr_ptr = &retval_ptr; fcall_info.param_count = 1; fcall_info.params = args; fcall_info.object_ptr = NULL; fcall_info.no_separation = 1; fcall_cache.initialized = EG(autoload_func) ? 1 : 0; fcall_cache.function_handler = EG(autoload_func); /* 留意此处 */ fcall_cache.calling_scope = NULL; fcall_cache.called_scope = NULL; fcall_cache.object_ptr = NULL; ... retval = zend_call_function(&fcall_info, &fcall_cache TSRMLS_CC); /* 调用自动加载函数 */ ... EG(autoload_func) = fcall_cache.function_handler; zval_ptr_dtor(&class_name_ptr); zend_hash_quick_del(EG(in_autoload), lc_name, lc_length, hash); ...}

我们发现是通过 zend_call_function 出发了自动加载函数,而且看到了加载方法的名字 __autoload (宏:ZEND_AUTOLOAD_FUNC_NAME

zend_call_function 中会做一下检测并调用等,而且我们看到 zend_lookup_class_ex 的返回结果即为 zend_call_function 的返回结果。

接下来我们逐步退出函数调用栈:

假设 zend_call_function 调用失败,返回 FALSE
zend_lookup_class_ex 返回 FALSE
zend_fetch_class_by_name 返回 NULL
ZEND_INIT_STATIC_METHOD_CALL_SPEC_CONST_CONST_HANDLER 抛出异常 Class ** not found,如下图所示:
clipboard.png

结论

至此,我们通过 PHP 代码 Zend 源码 了解了 __autoload 的调用过程。

我们知道 __autoload 现在已并不推荐使用,
它的缺点也很明显,不支持多个自动加载函数。

spl_autoload_register

将函数注册到SPL __autoload函数队列中。如果该队列中的函数尚未激活,则激活它们。如果在你的程序中已经实现了__autoload()函数,它必须显式注册到__autoload()队列中。

PHP 代码解释

使用示例:

FILE:foo.php
(同上 __autoload)

FILE:foo2.class.php

FILE:run.php

结果如下:

clipboard.png

我们看到,调用 getFoo2 时,会先调用第一个注册的 autoload 方法,如果没找到对应的类,会产生 warning 并继续调用后边注册的 autoload 方法。

说明了 PHP 内核中为通过 spl_autoload_register 注册的 autoload 方法维护了一个队列,当前文件为包含调用类,便会触发此队列,并依次调用,直到队列结束 或者 找到对应类。

Zend 源码解释

首先,我们看一下 PHP 文件生成的 opcode

clipboard.png

我们发现,其方法调用所生成的 opcode__autoload 一样,

但是我们之前调用了 `spl_autoload_register,
那么,看一下 spl_autoload_register 的源码:
FILE: ext/spl/php_spl.c*

PHP_FUNCTION(spl_autoload_register){    char *func_name, *error = NULL;    int  func_name_len;    char *lc_name = NULL;    zval *zcallable = NULL;    zend_bool do_throw = 1;    zend_bool prepend  = 0;    zend_function *spl_func_ptr;    autoload_func_info alfi;    zval *obj_ptr;    zend_fcall_info_cache fcc;    if (zend_parse_parameters_ex(ZEND_PARSE_PARAMS_QUIET, ZEND_NUM_ARGS() TSRMLS_CC, "|zbb", &zcallable, &do_throw, &prepend) == FAILURE) {        return;    }    if (ZEND_NUM_ARGS()) {        if (Z_TYPE_P(zcallable) == IS_STRING) {            if (Z_STRLEN_P(zcallable) == sizeof("spl_autoload_call") - 1) {                if (!zend_binary_strcasecmp(Z_STRVAL_P(zcallable), sizeof("spl_autoload_call"), "spl_autoload_call", sizeof("spl_autoload_call"))) {                    if (do_throw) {                        zend_throw_exception_ex(spl_ce_LogicException, 0 TSRMLS_CC, "Function spl_autoload_call() cannot be registered");                    }                    RETURN_FALSE;                }            }        }            if (!zend_is_callable_ex(zcallable, NULL, IS_CALLABLE_STRICT, &func_name, &func_name_len, &fcc, &error TSRMLS_CC)) {            alfi.ce = fcc.calling_scope;            alfi.func_ptr = fcc.function_handler;            obj_ptr = fcc.object_ptr;            if (Z_TYPE_P(zcallable) == IS_ARRAY) {                if (!obj_ptr && alfi.func_ptr && !(alfi.func_ptr->common.fn_flags & ZEND_ACC_STATIC)) {                    if (do_throw) {                        zend_throw_exception_ex(spl_ce_LogicException, 0 TSRMLS_CC, "Passed array specifies a non static method but no object (%s)", error);                    }                    if (error) {                        efree(error);                    }                    efree(func_name);                    RETURN_FALSE;                }                else if (do_throw) {                    zend_throw_exception_ex(spl_ce_LogicException, 0 TSRMLS_CC, "Passed array does not specify %s %smethod (%s)", alfi.func_ptr ? "a callable" : "an existing", !obj_ptr ? "static " : "", error);                }                if (error) {                    efree(error);                }                efree(func_name);                RETURN_FALSE;            } else if (Z_TYPE_P(zcallable) == IS_STRING) {                if (do_throw) {                    zend_throw_exception_ex(spl_ce_LogicException, 0 TSRMLS_CC, "Function '%s' not %s (%s)", func_name, alfi.func_ptr ? "callable" : "found", error);                }                if (error) {                    efree(error);                }                efree(func_name);                RETURN_FALSE;            } else {                if (do_throw) {                    zend_throw_exception_ex(spl_ce_LogicException, 0 TSRMLS_CC, "Illegal value passed (%s)", error);                }                if (error) {                    efree(error);                }                efree(func_name);                RETURN_FALSE;            }        }        alfi.closure = NULL;        alfi.ce = fcc.calling_scope;        alfi.func_ptr = fcc.function_handler;        obj_ptr = fcc.object_ptr;        if (error) {            efree(error);        }            lc_name = safe_emalloc(func_name_len, 1, sizeof(long) + 1);        zend_str_tolower_copy(lc_name, func_name, func_name_len);        efree(func_name);        if (Z_TYPE_P(zcallable) == IS_OBJECT) {            alfi.closure = zcallable;            Z_ADDREF_P(zcallable);            lc_name = erealloc(lc_name, func_name_len + 2 + sizeof(zend_object_handle));            memcpy(lc_name + func_name_len, &Z_OBJ_HANDLE_P(zcallable),                sizeof(zend_object_handle));            func_name_len += sizeof(zend_object_handle);            lc_name[func_name_len] = '\0';        }        if (SPL_G(autoload_functions) && zend_hash_exists(SPL_G(autoload_functions), (char*)lc_name, func_name_len+1)) {            if (alfi.closure) {                Z_DELREF_P(zcallable);            }            goto skip;        }        if (obj_ptr && !(alfi.func_ptr->common.fn_flags & ZEND_ACC_STATIC)) {            /* add object id to the hash to ensure uniqueness, for more reference look at bug #40091 */            lc_name = erealloc(lc_name, func_name_len + 2 + sizeof(zend_object_handle));            memcpy(lc_name + func_name_len, &Z_OBJ_HANDLE_P(obj_ptr), sizeof(zend_object_handle));            func_name_len += sizeof(zend_object_handle);            lc_name[func_name_len] = '\0';            alfi.obj = obj_ptr;            Z_ADDREF_P(alfi.obj);        } else {            alfi.obj = NULL;        }        if (!SPL_G(autoload_functions)) {            ALLOC_HASHTABLE(SPL_G(autoload_functions));            zend_hash_init(SPL_G(autoload_functions), 1, NULL, (dtor_func_t) autoload_func_info_dtor, 0);        }        zend_hash_find(EG(function_table), "spl_autoload", sizeof("spl_autoload"), (void **) &spl_func_ptr);        if (EG(autoload_func) == spl_func_ptr) { /* registered already, so we insert that first */            autoload_func_info spl_alfi;            spl_alfi.func_ptr = spl_func_ptr;            spl_alfi.obj = NULL;            spl_alfi.ce = NULL;            spl_alfi.closure = NULL;            zend_hash_add(SPL_G(autoload_functions), "spl_autoload", sizeof("spl_autoload"), &spl_alfi, sizeof(autoload_func_info), NULL);            if (prepend && SPL_G(autoload_functions)->nNumOfElements > 1) {                /* Move the newly created element to the head of the hashtable */                HT_MOVE_TAIL_TO_HEAD(SPL_G(autoload_functions));            }        }        if (zend_hash_add(SPL_G(autoload_functions), lc_name, func_name_len+1, &alfi.func_ptr, sizeof(autoload_func_info), NULL) == FAILURE) {            if (obj_ptr && !(alfi.func_ptr->common.fn_flags & ZEND_ACC_STATIC)) {                Z_DELREF_P(alfi.obj);            }                            if (alfi.closure) {                Z_DELREF_P(alfi.closure);            }        }        if (prepend && SPL_G(autoload_functions)->nNumOfElements > 1) {            /* Move the newly created element to the head of the hashtable */            HT_MOVE_TAIL_TO_HEAD(SPL_G(autoload_functions));        }skip:        efree(lc_name);    }    if (SPL_G(autoload_functions)) {        zend_hash_find(EG(function_table), "spl_autoload_call", sizeof("spl_autoload_call"), (void **) &EG(autoload_func)); /* 注意此处 */    } else {        zend_hash_find(EG(function_table), "spl_autoload", sizeof("spl_autoload"), (void **) &EG(autoload_func));    }    RETURN_TRUE;} /* }}} */

通过分析源码,我们发现 spl_autoload_register 会把注册的自动加载函数添加到 autoload_functions 中,最后将 autoload_functions 赋值给 EG(autoload_func) (上方源码倒数第一个 if 判断逻辑中)。

而有印象的同学会发现,EG(autoload_func) 在分析 __autoload 调用源码时出现过(可以划到之前的分析查看),它是执行环境全局结构体中的成员,出现调用大概源码如下:

ZEND_API int zend_lookup_class_ex(const char *name, int name_length, const zend_literal *key, int use_autoload, zend_class_entry ***ce TSRMLS_DC){  ...    fcall_info.size = sizeof(fcall_info);    fcall_info.function_table = EG(function_table);    fcall_info.function_name = &autoload_function;    fcall_info.symbol_table = NULL;    fcall_info.retval_ptr_ptr = &retval_ptr;    fcall_info.param_count = 1;    fcall_info.params = args;    fcall_info.object_ptr = NULL;    fcall_info.no_separation = 1;    fcall_cache.initialized = EG(autoload_func) ? 1 : 0;    fcall_cache.function_handler = EG(autoload_func); /* 注意这里 */    fcall_cache.calling_scope = NULL;    fcall_cache.called_scope = NULL;    fcall_cache.object_ptr = NULL;    zend_exception_save(TSRMLS_C);    retval = zend_call_function(&fcall_info, &fcall_cache TSRMLS_CC);    zend_exception_restore(TSRMLS_C);  ...    return retval;}

分析到这里,我们已经知道了,spl_autoload_register 注册的函数是如何在 PHP 代码调用时被触发的。

感兴趣的同学可以继续查看一下 zend_call_function 的源码,了解具体的调用方式。

结论

通过 spl_autoload_register 注册自动加载函数,会在 Zend 引擎中维护一个 autoload 队列,即可添加多个 autoload 函数,并在 PHP 调用当前文件未知的类时,触发 autoload_func 的调用。

同时,细心的同学也会从 spl_autoload_register 源码中发现,当注册时传入的方法不可调用时, 如果有实现 spl_autoload,也其会被注册到 autoload 队列中。

更多使用细节,请参考:


以上分析,如有不适的地方,请多多指教!

转载地址:http://qkuim.baihongyu.com/

你可能感兴趣的文章
Sublime Text 3103 Crack 注册码
查看>>
linux centos yum 安装mysql5.6
查看>>
Oracle 增加修改删除字段
查看>>
更改DC时间每5分钟出现ID1030 1097|不要修改DC域控制器时间
查看>>
car认证中心配置
查看>>
yum 命令详解
查看>>
Linux内核模块(一)
查看>>
汇编总结:lea指令
查看>>
cobbler批量部署实验记录
查看>>
关于写日报
查看>>
我的友情链接
查看>>
新书试读_网络规划设计师考试考点分析与真题详解
查看>>
centos6.5安装openssh7.2p2方法
查看>>
ubuntu 13.04 root权限设置方法详解
查看>>
Iptables防火墙(一)
查看>>
使用nginx访问服务器log日志
查看>>
linux命令行抓取网页快照
查看>>
[免费赠票] 第九届中国云计算大会日程曝光
查看>>
完美spring boot 使用log4j2按级别输出到不同文件
查看>>
magento cron job
查看>>