Yii2中的代码自动加载机制

最新推荐文章于 2023-09-07 23:42:33 发布
最新推荐文章于 2023-09-07 23:42:33 发布
阅读量222 收藏
点赞数
文章标签： php
原文链接：https://segmentfault.com/a/1190000010508018
版权

1.基本知识

  • Include与require 的作用：
    当一个文件被包含时，其中所包含的代码继承了 include 所在行的变量范围。从该处开始，调用文件在该行处可用的任何变量在被调用的文件中也都可用。不过所有在包含文件中定义的函数和类都具有全局作用域。
  • Include与require的区别：
    未找到文件则 include 结构会发出一条警告；require 会发出一个致命错误。
  • 如何实现类的自动加载：
    bool spl_autoload_register ([ callable $autoload_function [, bool $throw = true [, bool $prepend = false ]]] )
    （__autoload() 已被弃用）
    可以注册任意数量的自动加载器
    注意：自动加载不可用于 PHP 的 CLI 交互模式

2.Yii2中代码自动加载的机制

在Yii2.0的运行过程中主要由以下两个方法来实现代码的自动加载：
1.path_to_your_project/vendor/composer/ClassLoader.php中的ClassLoader::loadClass()方法，这个方法是由composer提供的。

2.类\yii\BaseYii的autoload()方法，这个方法是由Yii2框架提供的。

Yii2中是如何实现代码的自动加载的?
入口脚本的以下两行代码：

require(__DIR__ . '/../vendor/autoload.php');
require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

3.其中autoload.php的作用：

1.注册ComposerAutoloaderInit06ca19902d5e5679bb4a73b919aadb2a::loadClassLoader($class)为自动加载函数。这个loader负责引入了一个类：ClassLoader.php中的\Composer\Autoload\ClassLoader()，随后立即解除注册。

2.注册vendor/composer/ClassLoader.php中的ClassLoader::loadClass($class)为自动加载函数，并利用配置文件（即vendor/composer目录下的autoload_*.php文件）对这个自动加载函数进行了初始化。这个函数实现了PSR-0，PSR-4，classmap等方式来自动加载。

3.Require “vendor/composer/autoload_static.php”中的$files（作为全局函数使用）

4.将2中的loader返回到入口脚本

注意：
1.正如前面所提到的ClassLoader::loadClass($class)这个方法是由composer提供的，而配置文件（即vendor/composer目录下的autoload_*.php文件）则是在执行composer命令update/install的时候生成的。更多关于composer自动加载的内容参考composer自动加载，深入学习composer自动加载机制

对vendor/composer/ClassLoader.php中的ClassLoader::loadClass($class)详细分析:
1.该loader有4个配置文件 : autoload_namespaces.php，autoload_psr4.php，autoload_classmap.php，autoload_files.php（这4个文件都是由composer生成的）,还有一个比较特殊的文件autoload_static(也是由composer生成的，主要是为了提高效率，相当于缓存)

2.autoload_namespaces.php：（对应的是一些符合PSR-0的目录或文件）

return array(
            'HTMLPurifier' => array($vendorDir . '/ezyang/htmlpurifier/library'),
            'Diff' => array($vendorDir . '/phpspec/php-diff/lib'),
        );

如何处理上面的配置数组? 答：将数据配置到数组prefixesPsr0中

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


ClassLoader::set()
public function set($prefix, $paths)
{
    if (!$prefix) { //若为空串，则设置一个目录作为任何命名空间的备用目录（相当于默认目录）
        $this->fallbackDirsPsr0 = (array) $paths;
    } else {
        //prefixesPsr0数组，参考autoload_static.php文件
        $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
    }
}

3.autoload_psr4.php：
a)包含的命名空间目录：vendor/yiisoft下满足psr-4的目录（包括yii命名空间，即yii api 中包含的类)

如何处理上面的配置数组？ 答 ： 将数据配置到数组prefixLengthsPsr4，prefixDirsPsr4中

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


public function setPsr4($prefix, $paths)
{
    if (!$prefix) {//若为空串，则设置一个目录作为任何命名空间的备用目录（相当于默认目录）
        $this->fallbackDirsPsr4 = (array) $paths;
    } else {
        $length = strlen($prefix);
        if ('\\' !== $prefix[$length - 1]) {
            throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
        }
        $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
        $this->prefixDirsPsr4[$prefix] = (array) $paths;
    }
}

4.autoload_classmap.php
a)命令"composer dump-autoload -o"会生成这么一个文件，通过classmap方式，可以提高自动加载的效率
（相比使用PSR-0或PSR-4自动加载，可以减少计算量和IO，后面会详细分析）

如何处理上面的配置数组？ 答：将数据配置到数组classMap中


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



public function addClassMap(array $classMap)
{
    if ($this->classMap) {
        $this->classMap = array_merge($this->classMap, $classMap);
    } else {
        $this->classMap = $classMap;
    }
}

5.autoload_files.php
a)主要包括了需要立即require的文件( 通常是库文件，也可以是自定义的，引入作为全局函数使用)
如何处理：直接require

6.autoload_static.php
当满足以下条件：
1.PHP_VERSION_ID >= 50600
2.&& !defined('HHVM_VERSION')
3.&& (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
则直接使用autoload_static文件而不采用上面的4个文件。

require_once __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit06ca19902d5e5679bb4a73b919aadb2a::getInitializer($loader));
                                
                                
//上面的getInitializer()具体做什么？
//其实就是直接把已经生成好的prefixLengthsPsr4，prefixDirsPsr4，prefixesPsr0，classMap一一赋值给loader,而不是像上面提到的那样一个一个配置
public static function getInitializer(ClassLoader $loader)
{
    return \Closure::bind(function () use ($loader) {
        $loader->prefixLengthsPsr4 = ComposerStaticInit06ca19902d5e5679bb4a73b919aadb2a::$prefixLengthsPsr4;
        $loader->prefixDirsPsr4 = ComposerStaticInit06ca19902d5e5679bb4a73b919aadb2a::$prefixDirsPsr4;
        $loader->prefixesPsr0 = ComposerStaticInit06ca19902d5e5679bb4a73b919aadb2a::$prefixesPsr0;
        $loader->classMap = ComposerStaticInit06ca19902d5e5679bb4a73b919aadb2a::$classMap;
    }, null, ClassLoader::class);
}

上面关于Closure::bind()的使用参考http://www.cnblogs.com/iforev...

7.总结：（对应关系）

prefixLengthsPsr4  <=>  autoload_psr4.php
prefixDirsPsr4  <=>  autoload_psr4.php
prefixesPsr0  <=>  autoload_namespaces.php(lib或src目录，使用psr0)
classMap  <=>  autoload_classmap

使用ComposerAutoloadClassLoader::loadClass()加载文件的顺序：

  • 1.先从classMap中找（时间复杂度O(1)）
  • 2.查看是否文件之前已经查找过，证实不存在（$missingClasses）
  • 3.如果有使用apc缓存的话从缓存中取

  • 4.查找文件名后缀为”.php”的文件

    - a)PSR-4 lookup：格式化类名，通过prefixLengthsPsr4，prefixDirsPsr4找到文件的绝对路径
- b)PSR-4 fallback：根据$fallbackDirsPsr4查找根命名空间下的目录
- c)PSR-0 lookup：分纯pear格式，pear+命名空间格式，根据prefixesPsr0找到文件的绝对路径
- d)PSR-0 lookup：根据fallbackDirsPsr0查找根命名空间下的目录
- e)PSR-0 include:如果允许使用include path方式的话，使用stream_resolve_include_path()返回绝对路径
- f)找不到，返回false
  • 5.如果有使用HHVM的话，找后缀为”.hh”的文件，回到4下的具体查找（即a，b，c..）
  • 6.如果有使用apc缓存的话，将找到的文件的绝对路径存储到apc缓存中

注意：
1.在ClassLoader::findFileWithExtension($class, $ext)中实现了PSR-0和PSR-4的自动加载，其时间复杂度均为O（n2），相比于classmap的方式而言(时间复杂度为O（1）)是低效的，因此在生产环境中可以采用composer命令"composer dump-autoload -o"进行优化。

4.其中Yii.php 的作用:

1.定义类Yii（需要手动引入其父类的文件，而不是靠自动加载）
2.注册Yii::autoload()为自动加载函数
3.赋值Yii::$classMap (其值即yii2 api 中介绍的所有类,对应文件vendor\yiisoft\yii2\classes.php)
4.生成依赖注入容器：Yii::$container = new yiidiContainer();

相对于ComposerAutoloadClassLoader::loadClass()，Yii.php所做的就简单明了许多了，如果所需加载的类在Yii::$classMap中有定义则直接通过它加载，没有的话就解析别名，然后加载。如果解析别名后依然找不到相应的文件路径，则使用composer提供的自动加载函数来加载(即ClassLoader::loadClass($class))

Yii::autoload()主要能引入什么类？
1.Yii::$classMap中定义的yii2核心类
2.引入我们的应用中自己创建的类（依靠命名空间和别名,遵循PSR-4）

最终注册了的自动加载方法以及顺序：
1.Yii::autoload()
2.vendor\composer\ClassLoader.php中的ClassLoader::loadClass($class)

注意 :
1.通过上面的两个方法都可以引入Yii2.0框架自身的所有类，在顺序上会优先使用Yii::autoload()（主要是利用了Yii::classMap）
2.Yii::autoload()是由Yii框架提供的，而ClassLoader->loadClass($class)是由composer提供的。

5.YII2.0自动加载第三方扩展

准备：通过composer require安装yii上的第三方扩展。
例如
$ php composer.phar require kartik-v/yii2-markdown "dev-master"

1.安装完成之后可以发现vendor/yiisoft/extensions.php文件中多了以下内容：

'kartik-v/yii2-markdown' => 
  array (
    'name' => 'kartik-v/yii2-markdown',
    'version' => '9999999-dev',
    'alias' => 
    array (
      '@kartik/markdown' => $vendorDir . '/kartik-v/yii2-markdown',
    ),

2.在应用的启动过程中，会执行方法yii\base\Application::bootstrap()

/**
     * Initializes extensions and executes bootstrap components.
     * This method is called by [[init()]] after the application has been fully configured.
     * If you override this method, make sure you also call the parent implementation.
     */
    protected function bootstrap()
    {
        if ($this->extensions === null) {
            $file = Yii::getAlias('@vendor/yiisoft/extensions.php');
            $this->extensions = is_file($file) ? include($file) : [];
        }
        foreach ($this->extensions as $extension) {
            if (!empty($extension['alias'])) {
                foreach ($extension['alias'] as $name => $path) {
                    Yii::setAlias($name, $path);
                }
            }
            if (isset($extension['bootstrap'])) {
                $component = Yii::createObject($extension['bootstrap']);
                if ($component instanceof BootstrapInterface) {
                    Yii::trace('Bootstrap with ' . get_class($component) . '::bootstrap()', __METHOD__);
                    $component->bootstrap($this);
                } else {
                    Yii::trace('Bootstrap with ' . get_class($component), __METHOD__);
                }
            }
        }

        foreach ($this->bootstrap as $class) {
            $component = null;
            if (is_string($class)) {
                if ($this->has($class)) {
                    $component = $this->get($class);
                } elseif ($this->hasModule($class)) {
                    $component = $this->getModule($class);
                } elseif (strpos($class, '\\') === false) {
                    throw new InvalidConfigException("Unknown bootstrapping component ID: $class");
                }
            }
            if (!isset($component)) {
                $component = Yii::createObject($class);
            }

            if ($component instanceof BootstrapInterface) {
                Yii::trace('Bootstrap with ' . get_class($component) . '::bootstrap()', __METHOD__);
                $component->bootstrap($this);
            } else {
                Yii::trace('Bootstrap with ' . get_class($component), __METHOD__);
            }
        }
    }

根据上面的代码可以知道：

  • yii2.0框架会根据'@vendor/yiisoft/extensions.php'为所有第三方扩展设置别名，同时这个别名与扩展代码所在的目录相对应。

3.在需要的时候使用Yii::autoload()加载

/**
     * Class autoload loader.
     * This method is invoked automatically when PHP sees an unknown class.
     * The method will attempt to include the class file according to the following procedure:
     *
     * 1. Search in [[classMap]];
     * 2. If the class is namespaced (e.g. `yii\base\Component`), it will attempt
     *    to include the file associated with the corresponding path alias
     *    (e.g. `@yii/base/Component.php`);
     *
     * This autoloader allows loading classes that follow the [PSR-4 standard](http://www.php-fig.org/psr/psr-4/)
     * and have its top-level namespace or sub-namespaces defined as path aliases.
     *
     * Example: When aliases `@yii` and `@yii/bootstrap` are defined, classes in the `yii\bootstrap` namespace
     * will be loaded using the `@yii/bootstrap` alias which points to the directory where bootstrap extension
     * files are installed and all classes from other `yii` namespaces will be loaded from the yii framework directory.
     *
     * Also the [guide section on autoloading](guide:concept-autoloading).
     *
     * @param string $className the fully qualified class name without a leading backslash "\"
     * @throws UnknownClassException if the class does not exist in the class file
     */
    public static function autoload($className)
    {
        if (isset(static::$classMap[$className])) {
            $classFile = static::$classMap[$className];
            if ($classFile[0] === '@') {
                $classFile = static::getAlias($classFile);
            }
        } elseif (strpos($className, '\\') !== false) {
            $classFile = static::getAlias('@' . str_replace('\\', '/', $className) . '.php', false);
            if ($classFile === false || !is_file($classFile)) {
                return;
            }
        } else {
            return;
        }

        include($classFile);

        if (YII_DEBUG && !class_exists($className, false) && !interface_exists($className, false) && !trait_exists($className, false)) {
            throw new UnknownClassException("Unable to find '$className' in file: $classFile. Namespace missing?");
        }
    }

4.总结：可以认为说第三方扩展的自动加载其实就是使用了别名解析和PSR-4

6.扩展：Yii1.1中的自动加载机制

1.在index.php中加载 yii.php

2.Yii.php实际上是引入了文件 YiiBase.php

3.在YiiBase.php文件中有如下代码：

spl_autoload_register(array('YiiBase','autoload'));

4.自动加载器YiiBase::autoload()

  • a）先从静态变量$classMap中找（从代码中看，这个貌似貌似没有用到）
  • b）再从静态变量$_coreClasses中找 (这个写死在YiiBase文件中了,包含了所有api)
  • c）如果允许 include_path,则直接include
  • d）不允许 include_path,根据self::$_includePaths 逐一查找文件，找到的话就include
  • e）按照类psr-4的方式查找（ 与 .）(注意：这里这里需要用到一些常见的别名)
/**
     * Class autoload loader.
     * This method is provided to be invoked within an __autoload() magic method.
     * @param string $className class name
     * @return boolean whether the class has been loaded successfully
     */
    public static function autoload($className)
    {
        // use include so that the error PHP file may appear
        if(isset(self::$classMap[$className]))
            include(self::$classMap[$className]);
        elseif(isset(self::$_coreClasses[$className]))//这个数组是写死在YiiBase中的，包含所有yii api
            include(YII_PATH.self::$_coreClasses[$className]);
        else
        {
            // include class file relying on include_path
            if(strpos($className,'\\')===false)  // class without namespace
            {
                if(self::$enableIncludePath===false)
                {
                    foreach(self::$_includePaths as $path)
                    {
                        $classFile=$path.DIRECTORY_SEPARATOR.$className.'.php';
                        if(is_file($classFile))
                        {
                            include($classFile);
                            if(YII_DEBUG && basename(realpath($classFile))!==$className.'.php')
                                throw new CException(Yii::t('yii','Class name "{class}" does not match class file "{file}".', array(
                                    '{class}'=>$className,
                                    '{file}'=>$classFile,
                                )));
                            break;
                        }
                    }
                }
                else
                    include($className.'.php');
            }
            else  // class name with namespace in PHP 5.3
            {
                $namespace=str_replace('\\','.',ltrim($className,'\\'));
                if(($path=self::getPathOfAlias($namespace))!==false)
                    include($path.'.php');
                else
                    return false;
            }
            return class_exists($className,false) || interface_exists($className,false);
        }
        return true;
    }
weixin_34174132
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
YII2框架代码
05-26
2. Composer依赖管理：虽然描述中提到在中国可能需要其他方式，但Composer是PHP的标准依赖管理工具，用于自动加载类库，管理和更新项目依赖。 3. 视图渲染：YII2使用模板引擎进行视图渲染，支持嵌套视图和布局，...
php autoload静态,Composer 中自动加载 autoload_static 问题
weixin_29178069的博客
03-19 651
看来不是我一个人遇到这个问题。IDE 报语法错误，$loader 在别的类里面使用了私有成员。但是这个代码可以运行。先说一下为什么会有autoload_static.php 这个文件，代码里面其实有说明。$useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION');if ($useStaticLo...
PHP Composer 的自动加载
最新发布
菜皮日记
09-07 798
答案就在 composer 的源码中：https://github.com/composer/composer/blob/d0aac44ed210e13ec4a4370908a5b36553a2f16c/src/Composer/Autoload/AutoloadGenerator.php。和 PSR-4 的命名空间规范，可以想象，我们可以通过类的命名空间，来找到具体类的存放位置，然后通过 require 将其加载进来生效，composer 就是这么干的。如果取不到，则将目标类名追加 .php 后缀，去。
__autoload()不执行的解决办法spl_autoload_register();
聪聪_李的专栏
10-23 4768
在php5之后已经有了类的自动加载机制，可以定义__autoload函数，在使用到某个未定义的类，执行php会出错，但是在此时php引擎在返回失败之前会去check下是否有定义__autoload去加载需要的类。
yii2初始化详解 – 深究yii2 autoload机制
lhorse003的博客
03-10 2123
yii2初始化详解 – 深究yii2 autoload机制 yii2采用的基于namespace的autoload机制，我们从初始化来参看yii2的autoload机制的整个过程，详解yii的初始化过程 1.在入口文件index.php我们可以看到代码： require(__DIR__ . '/../../vendor/autoload.php'); 2.我们打开这
php yii2框架 普查平台
10-30
最后，Yii2的命令行工具Gii可以自动生成代码，如模型、控制器和视图，极大地提高了开发效率。在"普查平台"项目中，开发者可能使用Gii来快速生成基础框架，然后根据需求进行定制。 综上所述，"php yii2框架 普查平台...
php yii2框架初始项目 源码
03-21
1. **性能优化**：Yii2通过缓存、数据库查询优化和自动代码生成等手段，确保了高效的运行速度。 2. **MVC设计模式**：Model-View-Controller架构让开发者能够清晰地分离业务逻辑、数据展示和用户交互。 3. **活跃...
Yii2框架中使用PHPExcel导出Excel文件的示例
10-19
接下来，我们需要对PHPExcel的自动加载机制做一些调整。在`vendor/phpoffice/phpexcel/Classes/PHPExcel/Autoloader.php`文件中，找到`Register`方法，将原有的代码注释掉，然后替换为： ```php public static ...
PHP Yii2框架开发
07-12
2. **ActiveRecord**：Yii2中的ActiveRecord实现了ORM（对象关系映射），使得数据库操作变得简单，通过面向对象的方式与数据库交互。 3. **组件化**：Yii2框架基于组件，允许开发者自定义和重用组件，提高代码复用...
你所不知道的 PHP - 自动加载
杨森源的博客
11-10 2274
前言很多的小伙伴在，学习 PHP 的时候最早面对的问题之一就是 require 、 include 和 require_once 、include_once 的相爱相杀。在了解了它们相爱相杀的故事后，往往就开始使用起了框架。框架固然是干活的好工具，但是你知道你平时 new 一个新类的时候，发生了什么吗？有想过为什么我们 遵循规范 就会自动的帮我们做好一切的加载吗？ 让我们一切来探索发现其中的奥秘。时
解决Composer安装的Yii2.0运行资源无法加载的问题：
wj86611199的博客
07-06 533
把 DIRECTORY_SEPARATOR.'bower-asset'粘贴到bower后面就可以了
autoload_classmap.php
diaowojian9497的博客
10-30 377
开发中，所以我们不需要使用类映射来载入文件。所以我们为类映射自动载入器提供了一个空数组，在Module/Album目录中创建一个名为autoload_classmap.php的文件，代码如下： <?php return array(); 由于这是一个空数组，所以当不论何时自动载入器在Album名称空间中查找一个类时，它都将为我们转到StandardAutoload...
yii2 php init,yii2初始化详解 – 深究yii2 autoload机制
weixin_33328836的博客
03-26 465
yii2采用的基于namespace的autoload机制，我们从初始化来参看yii2的autoload机制的整个过程，详解yii的初始化过程1.在入口文件index.php我们可以看到代码：require(__DIR__ . '/../../vendor/autoload.php');2.我们打开这个文件:// autoload.php @generated by Composerrequire...
Yii2与Composer中的autoload
Coder Liu的博客
12-09 1469
Yii2中的实现Yii2中的autoloader是通过spl_autoload_register(['Yii', 'autoload'], true, true);函数实现自动加载，就是将app中要使用的类回调到Yii类中的autoload方法中去.对于Yii系统中的类，会有映射表(其实说白了就是个数组，叫这个名字显得专业),会更快的查找到. 动态的话需要将命名空间转换为类所在的路径，这就是为什么
教你如何学会Yii的自动加载！！
yyc199825的博客
11-29 579
Yii的类自动加载机制 在Yii中，所有类、接口、Traits都可以使用类的自动加载机制实现在调用前自动加载。Yii借助了PHP的类自动加载机制高效实现了类的定位、导入，这一机制兼容 PSR-4 的标准。在Yii中，类仅在调用时才会被加载，特别是核心类，其定位非常快，这也是Yii高效高性能的一个重要体现。 自动加载机制的实现 Yii的类自动加载，依赖于PHP的 spl_autol
yii2服务器无法加载文件夹,用Yii2做的项目在部署到云服务器后访问无反应，也没有任何数据响应...
weixin_35039377的博客
08-05 344
输入地址后一直在等待响应经过检查，代码在跑到\vendor\yiisoft\yii2\base\View.phppublic function renderFile($viewFile, $params = [], $context = null){$viewFile = Yii::getAlias($viewFile);if ($this->theme !== null) {$viewFi...
【yii2调试神器】yii2-debug能力分析和配置项解析
weixin_33778544的博客
06-05 791
2019独角兽企业重金招聘Python工程师标准>>> ...
yii2的bootstrap配置字段理解
weixin_34080571的博客
03-20 1764
2019独角兽企业重金招聘Python工程师标准>>> ...
Yii2的View中JS代码添加
05-26
在Yii2的View中添加JS代码可以通过以下几种方法实现： 1. 直接在View文件中使用`<script>`标签嵌入JS代码，例如： ```php $this->beginBlock('js') ?> // JS代码 $this->endBlock() ?> ``` 这种方法的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值