thinkphp源碼分析（三）—自動加載篇（Loader的分析）

時間 2019-12-07

標籤 thinkphp 源碼分析自動加載 loader 欄目 PHP 简体版

原文原文鏈接

源碼分析

自動加載

系統會調用 Loader::register()方法註冊自動加載，在這一步完成後，全部符合規範的類庫（包括Composer依賴加載的第三方類庫）都將自動加載。php

系統的自動加載由下面主要部分組成：thinkphp

1. 註冊系統的自動加載方法 \think\Loader::autoload
2. 註冊系統命名空間定義
3. 加載類庫映射文件（若是存在）
4. 若是存在Composer安裝，則註冊**Composer**自動加載
5. 註冊extend擴展目錄

一個類庫的自動加載檢測順序爲：數組

1. 是否認義類庫映射；
2. PSR-4自動加載檢測；
3. PSR-0自動加載檢測；
4. 能夠看到，定義類庫映射的方式是最高效的。

源碼

/**
     * 註冊自動加載機制
     * @access public
     * @param  callable $autoload 自動加載處理方法
     * @return void
     */
    public static function register($autoload = null)
    {
        // 註冊系統自動加載
        spl_autoload_register($autoload ?: 'think\\Loader::autoload', true, true);

        // Composer 自動加載支持
        if (is_dir(VENDOR_PATH . 'composer')) {
            if (PHP_VERSION_ID >= 50600 && is_file(VENDOR_PATH . 'composer' . DS . 'autoload_static.php')) {
                require VENDOR_PATH . 'composer' . DS . 'autoload_static.php';

                $declaredClass = get_declared_classes();
                $composerClass = array_pop($declaredClass);

                foreach (['prefixLengthsPsr4', 'prefixDirsPsr4', 'fallbackDirsPsr4', 'prefixesPsr0', 'fallbackDirsPsr0', 'classMap', 'files'] as $attr) {
                    if (property_exists($composerClass, $attr)) {
                        self::${$attr} = $composerClass::${$attr};
                    }
                }
            } else {
                self::registerComposerLoader();
            }
        }

        // 註冊命名空間定義
        self::addNamespace([
            'think'    => LIB_PATH . 'think' . DS,
            'behavior' => LIB_PATH . 'behavior' . DS,
            'traits'   => LIB_PATH . 'traits' . DS,
        ]);

        // 加載類庫映射文件
        if (is_file(RUNTIME_PATH . 'classmap' . EXT)) {
            self::addClassMap(__include_file(RUNTIME_PATH . 'classmap' . EXT));
        }

        self::loadComposerAutoloadFiles();

        // 自動加載 extend 目錄
        self::$fallbackDirsPsr4[] = rtrim(EXTEND_PATH, DS);
    }

框架自動加載

/**
     * 自動加載
     * @access public
     * @param  string $class 類名
     * @return bool
     */
    public static function autoload($class)
    {
        // 檢測命名空間別名
        if (!empty(self::$namespaceAlias)) {
            $namespace = dirname($class);
            if (isset(self::$namespaceAlias[$namespace])) {
                $original = self::$namespaceAlias[$namespace] . '\\' . basename($class);
                if (class_exists($original)) {
                    return class_alias($original, $class, false);
                }
            }
        }

        if ($file = self::findFile($class)) {
            // 非 Win 環境不嚴格區分大小寫
            if (!IS_WIN || pathinfo($file, PATHINFO_FILENAME) == pathinfo(realpath($file), PATHINFO_FILENAME)) {
                __include_file($file);
                return true;
            }
        }

        return false;
    }

檢測命名空間別名

檢查是否添加了命名空間別名，經過別名尋找原命名空間。如：composer

//原
\App\Http\Controller\Index::class

//添加別名後
\Controller\Index::class

thinkphp經過 thinkLoader::addNamespaceAlias($namespace, $original) 添加命名空間別名。框架

//位置在thinkphp/library/think/Loader.php的260行
    /**
     * 註冊命名空間別名
     * @access public
     * @param  array|string $namespace 命名空間
     * @param  string       $original  源文件
     * @return void
     */
    public static function addNamespaceAlias($namespace, $original = '')
    {
        if (is_array($namespace)) {
            self::$namespaceAlias = array_merge(self::$namespaceAlias, $namespace);
        } else {
            self::$namespaceAlias[$namespace] = $original;
        }
    }

經過鍵爲別名，值爲原命名空間的數組，註冊到thinkLoader::$namespaceAlias的屬性。源碼分析

經過classmap，psr-4，psr-0查找文件

/**
     * 查找文件
     * @access private
     * @param  string $class 類名
     * @return bool|string
     */
    private static function findFile($class)
    {
        // 類庫映射
        if (!empty(self::$classMap[$class])) {
            return self::$classMap[$class];
        }

        // 查找 PSR-4
        $logicalPathPsr4 = strtr($class, '\\', DS) . EXT;
        $first           = $class[0];

        if (isset(self::$prefixLengthsPsr4[$first])) {
            foreach (self::$prefixLengthsPsr4[$first] as $prefix => $length) {
                if (0 === strpos($class, $prefix)) {
                    foreach (self::$prefixDirsPsr4[$prefix] as $dir) {
                        if (is_file($file = $dir . DS . substr($logicalPathPsr4, $length))) {
                            return $file;
                        }
                    }
                }
            }
        }

        // 查找 PSR-4 fallback dirs
        foreach (self::$fallbackDirsPsr4 as $dir) {
            if (is_file($file = $dir . DS . $logicalPathPsr4)) {
                return $file;
            }
        }

        // 查找 PSR-0
        if (false !== $pos = strrpos($class, '\\')) {
            // namespace class name
            $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
            . strtr(substr($logicalPathPsr4, $pos + 1), '_', DS);
        } else {
            // PEAR-like class name
            $logicalPathPsr0 = strtr($class, '_', DS) . EXT;
        }

        if (isset(self::$prefixesPsr0[$first])) {
            foreach (self::$prefixesPsr0[$first] as $prefix => $dirs) {
                if (0 === strpos($class, $prefix)) {
                    foreach ($dirs as $dir) {
                        if (is_file($file = $dir . DS . $logicalPathPsr0)) {
                            return $file;
                        }
                    }
                }
            }
        }

        // 查找 PSR-0 fallback dirs
        foreach (self::$fallbackDirsPsr0 as $dir) {
            if (is_file($file = $dir . DS . $logicalPathPsr0)) {
                return $file;
            }
        }

        // 找不到則設置映射爲 false 並返回
        return self::$classMap[$class] = false;
    }

thinkphp添加的自動加載是經過psr-4和classmap進行加載，方法分別是： thinkLoader::addClassMap($class, $map = '') 和 thinkLoader::addNamespace($namespace, $path = '')。ui

psr-4的加載方式是經過命名空間的首字母，查找對應的命名空間，再經過對應的命名空間拼接對應的文件目錄，判斷該文件是否存在，若是存在就加載文件，實現類的自動加載。spa

classmap的加載方式是經過composer du生成對應的類映射，經過直接查找class對應的文件，從而實現自動加載。code

其餘的加載方式須要深刻了解的能夠自行研究代碼。get

/**
     * 註冊自動加載機制
     * @access public
     * @param  callable $autoload 自動加載處理方法
     * @return void
     */
    public static function register($autoload = null)
    {
        ....
        
        // 註冊命名空間定義
        self::addNamespace([
            'think'    => LIB_PATH . 'think' . DS,
            'behavior' => LIB_PATH . 'behavior' . DS,
            'traits'   => LIB_PATH . 'traits' . DS,
        ]);

        // 加載類庫映射文件
        if (is_file(RUNTIME_PATH . 'classmap' . EXT)) {
            self::addClassMap(__include_file(RUNTIME_PATH . 'classmap' . EXT));
        }

        ....
    }

composer自動加載

thinkphp中的composer自動加載不是經過composer自帶的autoload.php進行自動加載的。是經過加載對應的psr文件進行註冊加載的。

/**
     * 註冊自動加載機制
     * @access public
     * @param  callable $autoload 自動加載處理方法
     * @return void
     */
    public static function register($autoload = null)
    {
        ....
        
        // Composer 自動加載支持
        if (is_dir(VENDOR_PATH . 'composer')) {
            if (PHP_VERSION_ID >= 50600 && is_file(VENDOR_PATH . 'composer' . DS . 'autoload_static.php')) {
                require VENDOR_PATH . 'composer' . DS . 'autoload_static.php';

                $declaredClass = get_declared_classes();
                $composerClass = array_pop($declaredClass);

                foreach (['prefixLengthsPsr4', 'prefixDirsPsr4', 'fallbackDirsPsr4', 'prefixesPsr0', 'fallbackDirsPsr0', 'classMap', 'files'] as $attr) {
                    if (property_exists($composerClass, $attr)) {
                        self::${$attr} = $composerClass::${$attr};
                    }
                }
            } else {
                self::registerComposerLoader();
            }
        }

        ....
    }