Composer 實現自動載入原理-新手也能看懂

kuibatian發表於2020-04-08

一般在框架中都會用到composer工具,用它來管理依賴。其中composer有類的自動載入機制,可以載入composer下載的庫中的所有的類檔案。那麼composer的自動載入機制是怎麼實現的呢?

composer 自動載入原理

以在Laravel框架中為例:

1. 首先在入口檔案(/public/index.php)中引入了autoload.php

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

```

2. 我們看看autoload.php的內容

```
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInit1215780529014c2b50a6fca7ce889273::getLoader();

```

3. 我們再看看 autoload_real.php的內容

```
<?php

// autoload_real.php @generated by Composer

class ComposerAutoloaderInit1215780529014c2b50a6fca7ce889273
{
    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('ComposerAutoloaderInit1215780529014c2b50a6fca7ce889273', 'loadClassLoader'), true, true);
        self::$loader = $loader = new \Composer\Autoload\ClassLoader();
        spl_autoload_unregister(array('ComposerAutoloaderInit1215780529014c2b50a6fca7ce889273', '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\ComposerStaticInit1215780529014c2b50a6fca7ce889273::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\ComposerStaticInit1215780529014c2b50a6fca7ce889273::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequire1215780529014c2b50a6fca7ce889273($fileIdentifier, $file);
        }

        return $loader;
    }
}

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

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

```

可以看出這一段是composer自動載入的重點,首先在 autoload.php中呼叫ComposerAutoloaderInit1215780529014c2b50a6fca7ce889273::getLoader()方法,getLoader()首先判斷當前??????是不是????,如果不為????就直接返回,否則就初始化一個???????????類給賦值給loader是不是null,如果不為null就直接返回,否則就初始化一個ClassLoader類給賦值給loader,接著將autoload_namespaces.php、autoload_psr4.php、autoload_classmap.php檔案中的內容加入到$loader中對應的陣列中,然後給註冊loadClass函式,將autoload_files.php中的所有路徑所示的檔案都包含進來,當在new一個類的時候如果沒有找到相關的類就會觸發這個loadClass函式,在loadClass()又呼叫了findFile()去查詢相應的檔案,找到相應檔案後就會返回該檔案,然後loadClass呼叫includeFile()方法將該檔案include進去,否則findFile返回false,這樣就完成了自動載入

4. 下面來看一下 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;
        }

         private function findFileWithExtension($class, $ext)
        {
            // PSR-4 lookup
            $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;

            $first = $class[0];
            if (isset($this->prefixLengthsPsr4[$first])) {
                $subPath = $class;
                while (false !== $lastPos = strrpos($subPath, '\\')) {
                    $subPath = substr($subPath, 0, $lastPos);
                    $search = $subPath.'\\';
                    if (isset($this->prefixDirsPsr4[$search])) {
                        $pathEnd = DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $lastPos + 1);
                        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
            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) {
                    if (0 === strpos($class, $prefix)) {
                        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.
            if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
                return $file;
            }

            return false;
        }

4. findFile()函式先在classMap中查詢,如果找不到的話就會嘗試在apcu快取中查詢,如果還是找不到的話就會呼叫findFileWithExtension()函式查詢,如果找到了就會將該檔案加到apcu快取,如果找不到的話就會在missingClasses陣列中設一個標記表示識這個類找不到

findFileWithExtension()方法根據之前通過??????−>???(loader−>set(namespace, ???ℎ)和path)和loader->setPsr4(?????????,namespace,path)方法設定的資訊找出類檔案的路徑資訊

5. 在上面有的地方用到了 spl_autoload_registerspl_autoload_unregister函式

1. spl_autoload_register函式

spl_autoload_register — 註冊給定的函式作為 __autoload 的實現,

  1. bool spl_autoload_register ([ callable ????????????????[,????autoloadfunction[,boolthrow = true [, bool $prepend = false ]]] )

  2. prepend
    如果是 true,spl_autoload_register() 會新增函式到佇列之首,而不是佇列尾部。

  3. 如果在你的程式中已經實現了autoload()函式,它必須顯式註冊到autoload()佇列中。因為 spl_autoload_register()函式會將Zend Engine中的__autoload()函式取代為spl_autoload()或spl_autoload_call()
    例:

    function __autoload($name) { require  'class/'.$name.'.php'; echo  '1'; } function autoload_test($name) { echo  '2'; } spl_autoload_register('autoload_test'); spl_autoload_register('__autoload'); $ca=new Ca();

2. spl_autoload_unregister函式

spl_autoload_unregister — 登出已註冊的autoload()函式,如果該函式佇列處於啟用狀態,並且在給定函式登出後該佇列變為空,則該函式佇列將會變為無效。如果該函式登出後使得自動裝載函式佇列無效,即使存在有autoload函式它也不會自動啟用。

  1. bool spl_autoload_unregister ( mixed $autoload_function )
本作品採用《CC 協議》,轉載必須註明作者和本文連結

每天5分鐘,與你一起蛻變!上海php自學中心,目前專注於php,python,golang~撒花!
S3d25uqwht.png!large
公眾號7Dn78VKKcW.jpg!large

相關文章