autoload 自动加载源码分析

boomck 2019-12-07 PM 2436℃ 0条

Laravel 框架启动的第一件事便是加载 自动加载文件

require __DIR__.'/../vendor/autoload.php';

而这个autoload.php中却只有简简单单的几行代码

require_once __DIR__ . '/composer/autoload_real.php';

return ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0::getLoader();

而这个autoload_real.php 才是真正的核心代码

整个autoload_real.php源码:

class ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0
{
    private static $loader;

    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }

    public static function getLoader()
    {
        if (null !== self::$loader) {
            return self::$loader;
        }

        spl_autoload_register(array('ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0', 'loadClassLoader'), true, true);
        self::$loader = $loader = new \Composer\Autoload\ClassLoader();
        spl_autoload_unregister(array('ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0', 'loadClassLoader'));

        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
        if ($useStaticLoader) {
            require_once __DIR__ . '/autoload_static.php';

            call_user_func(\Composer\Autoload\ComposerStaticInitba18d171b895589f003c9e6898eda4c0::getInitializer($loader));
        } else {
            $map = require __DIR__ . '/autoload_namespaces.php';
            foreach ($map as $namespace => $path) {
                $loader->set($namespace, $path);
            }

            $map = require __DIR__ . '/autoload_psr4.php';
            foreach ($map as $namespace => $path) {
                $loader->setPsr4($namespace, $path);
            }

            $classMap = require __DIR__ . '/autoload_classmap.php';
            if ($classMap) {
                $loader->addClassMap($classMap);
            }
        }

        $loader->register(true);

        if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInitba18d171b895589f003c9e6898eda4c0::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequireba18d171b895589f003c9e6898eda4c0($fileIdentifier, $file);
        }

        return $loader;
    }
}

function composerRequireba18d171b895589f003c9e6898eda4c0($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;

        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
    }
}

我们一块一块来讲

第一块 单例和实例化

class ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0
{
    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }

    public static function getLoader()
    {
        if (null !== self::$loader) {
            return self::$loader;
        }

        spl_autoload_register(array('ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0', 'loadClassLoader'), true, true);
        self::$loader = $loader = new \Composer\Autoload\ClassLoader();
        spl_autoload_unregister(array('ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0', 'loadClassLoader'));
    }
}

这里的类名

ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0

是ComposerAutoloaderInit + 一串hash字符串拼接成的
目的就是防止你会用到相同的类名

往下看就是 getLoader() 方法中的前3行
很明显他是一个单例

然后就是

spl_autoload_register(array('ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0', 'loadClassLoader'), true, true);
self::$loader = $loader = new ComposerAutoloadClassLoader();
spl_autoload_unregister(array('ComposerAutoloaderInitba18d171b895589f003c9e6898eda4c0', 'loadClassLoader'));

这里先是注册了 loadClassLoader 然后在实例化ClassLoader()类之后 便又销毁了loadClassLoader
为什么不直接require,而要这么麻烦?原因就是怕有的用户也定义了个
\Composer\Autoload\ClassLoader 命名空间,导致自动加载错误文件。那为什么不跟引导类一样用个 hash 呢?因为这个类是可以复用的,框架允许用户使用这个类。

第二块 初始化核心类

        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') &&(!function_exists
('zend_loader_file_encoded') || !zend_loader_file_encoded());
        if ($useStaticLoader) {
            require_once __DIR__ . '/autoload_static.php';
            call_user_func(\Composer\Autoload\ComposerStaticInitba18d171b895589f003c9e6898eda4c0::
getInitializer($loader));
        } else {
            $map = require __DIR__ . '/autoload_namespaces.php';
            foreach ($map as $namespace => $path) {
                $loader->set($namespace, $path);
            }

            $map = require __DIR__ . '/autoload_psr4.php';
            foreach ($map as $namespace => $path) {
                $loader->setPsr4($namespace, $path);
            }

            $classMap = require __DIR__ . '/autoload_classmap.php';
            if ($classMap) {
                $loader->addClassMap($classMap);
            }
        }

这里先是判断 php的版本是否大于5.6 并且 没有使用HHVM 并且 没有zend_loader_file_encoded() 决定是否使用静态加载
若是 则使用getInitializer()直接加载
autoload_static.php 里面主要有

$files 全局函数
$prefixLengthsPsr4 PSR4标准顶级命名空间映射数组 这个里面放的是顶级命名空间的长度
$prefixDirsPsr4 根据长度再在这个数组中找到路径
$prefixesPsr0 psr0 规范的顶级命名空间映射
$classMap 直接命名空间全名与目录的映射,没有顶级命名空间 很庞大的一个数组

这五个数组

而getInitializer()绑定了后面四个数组
若不使用静态加载
其实也是将一个个命名空间映射与loader进行绑定

第三块 注册

这块非常简单粗暴

$loader->register(true);

public function register($prepend = false)
    {
        spl_autoload_register(array($this, 'loadClass'), true, $prepend);
    }

就是将loadCLass注册到 PHP SPL的spl_autoload_register() 中去
每当PHP遇到一个不认识的命名空间的时候,PHP会自动调用注册到spl_autoload_register里面的函数堆栈,运行其中的每个函数,直到找到命名空间对应的文件。

然后就是加载 全局函数

        if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInitba18d171b895589f003c9e6898eda4c0::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequireba18d171b895589f003c9e6898eda4c0($fileIdentifier, $file);
        }

        return $loader;

这里也区分是否使用静态加载

第四块 运行

这块就是自动加载核心的核心了

    public function loadClass($class)
    {
        if ($file = $this->findFile($class)) {
            includeFile($file);

            return true;
        }
    }

这个就是被注册进spl_autoload_register() 的方法
奥秘就在findFile()这个方法里

    public function findFile($class)
    {
        // class map lookup
        if (isset($this->classMap[$class])) {
            return $this->classMap[$class];
        }
        if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
            return false;
        }
        if (null !== $this->apcuPrefix) {
            $file = apcu_fetch($this->apcuPrefix.$class, $hit);
            if ($hit) {
                return $file;
            }
        }

        $file = $this->findFileWithExtension($class, '.php');

        // Search for Hack files if we are running on HHVM
        if (false === $file && defined('HHVM_VERSION')) {
            $file = $this->findFileWithExtension($class, '.hh');
        }

        if (null !== $this->apcuPrefix) {
            apcu_add($this->apcuPrefix.$class, $file);
        }

        if (false === $file) {
            // Remember that this class does not exist.
            $this->missingClasses[$class] = true;
        }

        return $file;
    }

在PHP遇到不认识的命名空间的时候 便会执行findFile()
这里分两大块 classMap和findFileWithExtension()方法
classMap简单粗暴 就是从classMap数组中寻找 找到便返回
实际上大多数也都在第一个判断就被找到了
例如:FE01ED3D-6E86-4A79-9BD3-20FE979CB43C.png

然后就是findFileWithExtension()了

private function findFileWithExtension($class, $ext)
    {
        // PSR-4 lookup
        // 将 ‘\\’ 转为 ‘/’ 并拼接上 .php
        //例如 ww\\ss\\cc => ww/ss/cc.php
        $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;

        $first = $class[0];
        //根据首字母来查找
        if (isset($this->prefixLengthsPsr4[$first])) {
            $subPath = $class;
            // 获取最右边的 \\ 并截取 例如:ww\\ss\\cc 变为 ww\\ss 循环在psr4标准中匹配
            while (false !== $lastPos = strrpos($subPath, '\\')) {
                $subPath = substr($subPath, 0, $lastPos);
                $search = $subPath . '\\'; // ww\\ss\\
                // 进行匹配
                if (isset($this->prefixDirsPsr4[$search])) {
                //若匹配上了 这里就会截取到/cc.php
                    $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1);
                    // 对匹配上的psr4 数组遍历 检查是否有这个文件 若有就返回
                    foreach ($this->prefixDirsPsr4[$search] as $dir) {
                        if (file_exists($file = $dir . $pathEnd)) {
                            return $file;
                        }
                    }
                }
            }
        }

        // PSR-4 fallback dirs
        foreach ($this->fallbackDirsPsr4 as $dir) {
            if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
                return $file;
            }
        }

        // PSR-0 lookup
        // ww\\ss\\cc => ww/ss
        if (false !== $pos = strrpos($class, '\\')) {
            // namespaced class name
            // 将路径最后的 _ 替换为 /
            $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
                . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
        } else {
            // PEAR-like class name
            // 替换路径里所有的 _
            $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
        }

        // 根据路径首字母来查找
        if (isset($this->prefixesPsr0[$first])) {
            foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
            // 确认 class 中 有 prefix 并在 第0位
                if (0 === strpos($class, $prefix)) {
                // 遍历dirs数组 能找到文件就返回
                    foreach ($dirs as $dir) {
                        if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
                            return $file;
                        }
                    }
                }
            }
        }

        // PSR-0 fallback dirs
        foreach ($this->fallbackDirsPsr0 as $dir) {
            if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
                return $file;
            }
        }

        // PSR-0 include paths.
        // 在当前include目录 查找
        if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
            return $file;
        }

        return false;
    }

这里也分为两块 先在psr4规范中寻找 再在psr0规范中寻找

以上这些就是自动加载的原理了

参考文献:composer自动加载

标签: laravel

非特殊说明,本博所有文章均为博主原创。

上一篇 php 拓展安装
下一篇 nginx 负载均衡

评论啦~