Thinkphp5类的自动加载机制分析

最新推荐文章于 2024-07-16 11:14:25 发布
最新推荐文章于 2024-07-16 11:14:25 发布
阅读量683 收藏 2
点赞数
文章标签： php 经验分享 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Hou_guang/article/details/114031974
版权

TP5类的自动加载机制核心主要由Loader类完成，所以我们主要围绕该类来分析。

1、Loader类的属性列表
/**
     * 类名映射信息
     * @var array
     */
    protected static $classMap = []; 

    /**
     * 类库别名
     * @var array
     */
    protected static $classAlias = [];

    /**
     * PSR-4
     * @var array
     */
    private static $prefixLengthsPsr4 = [];
    private static $prefixDirsPsr4    = [];
    private static $fallbackDirsPsr4  = [];

    /**
     * PSR-0
     * @var array
     */
    private static $prefixesPsr0     = [];
    private static $fallbackDirsPsr0 = [];

    /**
     * 需要加载的文件
     * @var array
     */
    private static $files = [];

    /**
     * Composer安装路径
     * @var string
     */
    private static $composerPath;
重要属性

$classMap：类库映射关系命名空间对应相应类文件路径
$prefixLengthsPsr4：类库命名空间对应命名空间字符长度
$prefixDirsPsr4：类库命名空间对应的类库文件所在的文件目录位置
$fallbackDirsPsr4：自动加载类库目录

2、注册自动加载机制流程

自动加载机制流程主要由Loader类的静态方法register来实现的，方法代码如下

2.1 注册系统自动加载
spl_autoload_register($autoload ?: 'think\\Loader::autoload', true, true);

实例化找不到的类时将调用 think\Loader::autoload 方法

2.1.2 Composer自动加载支持

引入composer目录（\vendor\composer\）下的autoload_static.php文件

	public static $prefixLengthsPsr4 = array (  // 类库文件的命名空间以及字符长度
        't' =>
        array (
            'think\\composer\\' => 15, 
        ),
        'a' => 
        array (
            'app\\' => 4,
        ),
    );

    public static $prefixDirsPsr4 = array ( // 命名空间对应的类库文件所在的文件目录位置
        'think\\composer\\' => 
        array (
            0 => __DIR__ . '/..' . '/topthink/think-installer/src',  
        ),
        'app\\' => 
        array (
            0 => __DIR__ . '/../..' . '/application',
        ),
    );

    public static $classMap = array (
        'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php',
    );

当我们通过composer方式下载插件到项目的时候，composer命令会修改autoload_static.php中的prefixLengthsPsr4，prefixDirsPsr4这两个属性，指定该扩展的命名空间和对应目录。所以如果我们直接复制扩展到verdon目录的时候，需要修改这两个属性值，不然框架加载不到这个扩展。但是建议用composer命令来下载扩展，让命令自动帮我们修改。

2.1.3 将属性prefixLengthsPsr4、prefixDirsPsr4、classMap属性赋值给Loader::$property对应属性
		// 项目的根目录 $rootPath  = D:\phpstudy_pro\WWW\thinkphpStudy\
        $rootPath = self::getRootPath();

        // Composer目录 self::$composerPath = D:\...\thinkphpStudy\vendor\composer\
        self::$composerPath = $rootPath . 'vendor' . DIRECTORY_SEPARATOR . 'composer' . DIRECTORY_SEPARATOR;

        // Composer自动加载支持
        if (is_dir(self::$composerPath)) {
            if (is_file(self::$composerPath . 'autoload_static.php')) {
                require self::$composerPath . 'autoload_static.php';

                // 返回由当前运行脚本中已定义类的名字组成的数组 
                // $declaredClass = array(151) { 
                //	[0] => string(9) "Exception" ... 
                //  [149] => string(12) "think\Loader" 
                //  [150] => string(68) "Composer\Autoload\ComposerStaticInitaa210877af5760b863ea566b06fb95ca" 	
                //  }
                $declaredClass = get_declared_classes();
                // $composerClass  = Composer\Autoload\ComposerStaticInitaa210877af5760b863ea566b06fb95ca
                $composerClass = array_pop($declaredClass); 

                foreach (['prefixLengthsPsr4', 'prefixDirsPsr4', 'fallbackDirsPsr4', 'prefixesPsr0', 'fallbackDirsPsr0', 'classMap', 'files'] as $attr) {
                    // property_exists函数判断Composer的autoload_static类是否包含以上属性
                    // 包含则把属性赋值给Loader类
                    if (property_exists($composerClass, $attr)) {
                        self::${$attr} = $composerClass::${$attr};
                    }
                }
            } else {
                self::registerComposerLoader(self::$composerPath);
            }
        }

相当于Loader::prefixLengthsPsr4, Loader::prefixDirsPsr4包含了Composer autoload_static 类下面的命名空间和对应的类库目录路径

2.1.4 命名空间think,traits加载支持
	self::addNamespace([
        'think'  => __DIR__,
        'traits' => dirname(__DIR__) . DIRECTORY_SEPARATOR . 'traits'
    ]);

在Loader类的prefixLengthsPsr4、prefixDirsPsr4属性中添加think、traits命名空间及对应的类库文件目录路径

2.1.5 加载类库映射文件
	if (is_file($rootPath . 'runtime' . DIRECTORY_SEPARATOR . 'classmap.php')) {
		self::addClassMap(__include_file($rootPath . 'runtime' . DIRECTORY_SEPARATOR . 'classmap.php'));
	}

可使用 php think optimize:autoload命令生成类库映射文件 提高系统自动加载的性能 （每次有添加文件或者修改文件路径或名称需要重新生成该文件）

2.1.6 自动加载类库目录
	self::addAutoLoadDir($rootPath . 'extend');

Loader::addAutoLoadDir()方法将extend目录加入$fallbackDirsPsr4中，当实例化找不到的类会在自动加载类库目录中查找是否存在该类

2.2 自动加载函数Loader::autoload()
2.2.1 autoload方法代码
	public static function autoload($class)
    {
        // 类是否设置别名
        if (isset(self::$classAlias[$class])) {
            return class_alias(self::$classAlias[$class], $class);
        }

        if ($file = self::findFile($class)) {

            // Win环境严格区分大小写
            if (strpos(PHP_OS, 'WIN') !== false && pathinfo($file, PATHINFO_FILENAME) != pathinfo(realpath($file), PATHINFO_FILENAME)) {
                return false;
            }

            __include_file($file);
            return true;
        }
    }

首先在Loader::$classAlias类别名属性中是否存在该类，如果存在则使用class_alias重新new这个类，正常情况将调用findFile方法查找类库文件路径include引入文件

2.2.2 findFile过程

Loader::findFile()主要根据prefixLengthsPsr4、prefixDirsPsr4、fallbackDirsPsr4、classMap属性来确定加载类库的文件路径，明白这些属性的作用就能够理解TP框架类的自动加载核心思想

/ Loader::$classMap 打印结果
array(1) {
  ["Composer\InstalledVersions"]=>
  string(83) "F:\phpstudy_pro\WWW\thinkphpStudy\vendor\composer/../composer/InstalledVersions.php"
}

/ Loader::$prefixLengthsPsr4 打印结果
array(2) {
  ["t"]=>
  array(3) {
    ["think\composer\"]=>
    int(15)
    ["think\"]=>
    int(6)
    ["traits\"]=>
    int(7)
  }
  ["a"]=>
  array(1) {
    ["app\"]=>
    int(4)
  }
}

/ Loader::$prefixDirsPsr4 打印结果
array(4) {
  ["think\composer\"]=>
  array(1) {
    [0]=>
    string(81) "F:\phpstudy_pro\WWW\thinkphpStudy\vendor\composer/../topthink/think-installer/src"
  }
  ["app\"]=>
  array(1) {
    [0]=>
    string(67) "F:\phpstudy_pro\WWW\thinkphpStudy\vendor\composer/../../application"
  }
  ["think\"]=>
  array(1) {
    [0]=>
    string(56) "F:\phpstudy_pro\WWW\thinkphpStudy\thinkphp\library\think"
  }
  ["traits\"]=>
  array(1) {
    [0]=>
    string(57) "F:\phpstudy_pro\WWW\thinkphpStudy\thinkphp\library\traits"
  }
}

/ Loader::$fallbackDirsPsr4 打印结果
array(1) {
  [0]=>
  string(40) "F:\phpstudy_pro\WWW\thinkphpStudy\extend"
}


	private static function findFile($class)  
    {
    	//$class = think\Error
        if (!empty(self::$classMap[$class])) {
            // 类库映射
            return self::$classMap[$class];
        }
        // 查找 PSR-4  $logicalPathPsr4 = think/Error.php
        $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . '.php';  

        $first = $class[0]; // t 
        if (isset(self::$prefixLengthsPsr4[$first])) {
            // $prefix $length = think\composer 15 | think 6 | traits 7
            foreach (self::$prefixLengthsPsr4[$first] as $prefix => $length) {
                if (0 === strpos($class, $prefix)) {
                    // $dir = .../thinkphp/library/think
                    foreach (self::$prefixDirsPsr4[$prefix] as $dir) { 
                    	// substr($logicalPathPsr4, $length) 获取类文件名称 Error.php
                        // $file = .../thinkphp/library/think/Error.php  
                        if (is_file($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
                            return $file;
                        }
                    }
                }
            }
        }

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

主要查找方式 (从上往下查找)
1、classMap类库映射属性中是否存在加载类。
2、获取加载类库的命名空间首字母在prefixLengthsPsr4属性中查询对应的类库的命名空间，循环在命名空间映射的类文件路径属性prefixDirsPsr4数组中寻找是否有对应的类有则返回。
3、fallbackDirsPsr4自动加载类库属性循环遍历在映射目录中是否存在加载类文件有则返回。

3、实战练习巩固

在TP项目中新增util文件目录用来存放软件工具代码类库，使得项目中可以直接实例化调用工具类库使用。
util目录下Game.php

<?php

class Game
{
    public function show()
    {
        echo 'util\Game.php Class Method show';
    }
}

util\spl目录下User.php

<?php
namespace spl;

class User
{
    public function show()
    {
        echo 'util\spl\User.php Class Method show';
    }
}

在app控制器Index下直接调用Game、User类访问方法

<?php
namespace app\index\controller;

use Di\Container;

class Index
{
	public function study()
    {
        $gameClass = new \Game();
        dump($gameClass->show());
        $userClass = new \spl\User();
        dump($userClass->show());
    }
}

浏览器访问
在这里插入图片描述

3.1 方法一

在Loader::$fallbackDirsPsr4属性中将util文件目录路径加入

	// 自动加载extend目录
	self::addAutoLoadDir($rootPath . 'extend');
	self::addAutoLoadDir($rootPath . 'util');
	// 打印fallbackDirsPsr4属性
	array(2) { 
		[0]=> string(40) "D:\phpstudy_pro\WWW\thinkphpStudy\extend" 
		[1]=> string(38) "D:\phpstudy_pro\WWW\thinkphpStudy\util" 
	}

再次浏览器访问
在这里插入图片描述
声明：使用该方式创建的类文件命名空间namespace 无需定义util，因为类的自动加载机制是遍历$fallbackDirsPsr4属性存放的类库目录查找是否存在加载的类。

3.1 方法二

在Loader类的prefixLengthsPsr4、prefixDirsPsr4属性中将util的命名空间以及对应的文件目录路径加入

	// 注册命名空间定义
    self::addNamespace([
        'think'  => __DIR__,
        'traits' => dirname(__DIR__) . DIRECTORY_SEPARATOR . 'traits',
        'util' => $rootPath . 'util',
    ]);
    // 打印prefixLengthsPsr4属性
	array(3) {
	  ["t"]=>
	  array(3) {
	    ["think\composer\"]=>
	    int(15)
	    ["think\"]=>
	    int(6)
	    ["traits\"]=>
	    int(7)
	  }
	  ["a"]=>
	  array(1) {
	    ["app\"]=>
	    int(4)
	  }
	  ["u"]=>
	  array(1) {
	    ["util\"]=>
	    int(5)
	  }
	}
	// 打印prefixDirsPsr4属性
	array(5) {
	  ["think\composer\"]=>
	  array(1) {
	    [0]=>
	    string(81) "D:\phpstudy_pro\WWW\thinkphpStudy\vendor\composer/../topthink/think-installer/src"
	  }
	  ["app\"]=>
	  array(1) {
	    [0]=>
	    string(67) "D:\phpstudy_pro\WWW\thinkphpStudy\vendor\composer/../../application"
	  }
	  ["think\"]=>
	  array(1) {
	    [0]=>
	    string(56) "D:\phpstudy_pro\WWW\thinkphpStudy\thinkphp\library\think"
	  }
	  ["traits\"]=>
	  array(1) {
	    [0]=>
	    string(57) "D:\phpstudy_pro\WWW\thinkphpStudy\thinkphp\library\traits"
	  }
	  ["util\"]=>
	  array(1) {
	    [0]=>
	    string(38) "D:\phpstudy_pro\WWW\thinkphpStudy\util"
	  }
	}

Index.php

	public function study()
    {
        $gameClass = new \util\Game(); // 实例化也需加上 util
        dump($gameClass->show());
        $userClass = new \util\spl\User();
        dump($userClass->show());
    }

声明：使用该方式定义Game.php和User.php类的时命名空间namespace需加上util。

本文是自己需要提升一下自己对php框架的知识储备，从而对thinkphp5框架类的类的自动加载机制进行学习分析并分享学习心得顺便巩固所学，如有问题或者更好的意见和建议欢迎指出，共同进步~~~

侯光
关注
Thinkphp5类加载机制
予怀
03-05 5328
Thinkphp5类加载机制 PS：本文适用于熟悉Thinkphp框架或其他MVC框架，对于命名空间及自动加载类，有一定理解的程序工作者观看(其实是写给自己看的>_ 我一直对于thinkphp5的加载运行的时候做了什么，他是怎么自动加载类的，是和composer一样的吗—能否实现运行时再加载类，于是做了一下测试，追踪了整个加载流程。   以文件为单位进行讲解： 入口文件i
thinkphp 框架自动加载原理_thinkPHP5.0框架自动加载机制分析
weixin_30278943的博客
02-11 568
本文实例讲述了thinkPHP5.0框架自动加载机制。分享给大家供大家参考，具体如下：概述ThinkPHP5.0 真正实现了按需加载，所有类库采用自动加载机制，并且支持类库映射和composer类库的自动加载。自动加载的实现由think\Loader类库完成，自动加载规范符合PHP的PSR-4。自动加载由于新版ThinkPHP完全采用了命名空间的特性，因此只需要给类库正确定义所在的命名空间，而命名...
Thinkphp5.1类自动加载机制
littlexiaoshuishui的博客
11-24 1459
tp5.1类加载功能都封装到Loader类当中，所以我们主要分析这个类的主要功能。 1.几个重要属性 Loader::$prefixLengthsPsr4, Loader::$prefixDirsPsr4, Loader::$fallbackDirsPsr4, Loader::$classMap 2.自动加载流程 2.1自动加载整个流程是通过Loader::register来实现...
ThinkPHP5 被 classmap.php 文件挂马的防范与处理
最新发布
xxxPHP_er的博客
07-16 577
近期访问一个ThinkPHP5.0.24的网站，发现无论访问什么页面返回的都是一样的内容，企业微信分享链接的标题和简介也变成了灰色产业的广告信息。ThinkPHP5 被文件挂马是一个严重的安全问题，需要引起足够的重视。可通过及时更新框架版本、加强代码审计、严格权限管理等措施，可以有效防范挂马攻击。同时，在遭遇挂马事件时，需要迅速响应并采取相应的处理流程，以尽快恢复网站的正常运行。
Thinkphp5.1自动加载机制
weixin_30627381的博客
03-30 247
Thinkphp5.1自动加载机制 自动加载机制 注册自动加载 引入静态自动加载映射文件，autoload_static.php 根据首字母前缀将不同的加载类归类-$prefixLengthsPsr4 将命令空间映射到指定文件目录下-$prefixDirsPsr4 compose下载的包文件，需要加载的文件-$files 类映射关系-$classMap 检测是...
thinkphp 5.1 自动加载总结
chp_woAIdan的博客
03-13 358
主要的执行工作的属性和函数参考上图带说明的部分 针对自动加载可以简要分成4个场景： 1.加载vendor下面的topthink组件库 2.加载自身核心类库 3.加载字典类库，这种类库大全保存了所使用到的全部类库，这样加载的时候不用再寻找映射的文件提升性能。 4.加载项目根目录的类库，例如extend目录下的类库，你也可以自行再创建自定义目录存放自己的库 PS：autoload中别名属性的使用场景是在自身类库加载完成后使用的，这样自动加载不会对别名属性进行加载，节省性能，还有一个好处就是...
thinkPHP5.0框架自动加载机制分析
01-20
ThinkPHP5.0 真正实现了按需加载，所有类库采用自动加载机制，并且支持类库映射和composer类库的自动加载。 自动加载的实现由think\Loader类库完成，自动加载规范符合PHP的PSR-4。 自动加载 由于新版ThinkPHP完全...
thinkPHP线上自动加载异常与修复方法实例分析
10-21
首先，要理解ThinkPHP框架中的自动加载机制。ThinkPHP的自动加载功能依赖于PHP的魔术方法__autoload，但更推荐使用ThinkPHP提供的自动加载配置来管理类的自动加载。默认情况下，ThinkPHP的类库文件是通过命名空间和...
分析ThinkPHP5的源码(1) : 类的自动加载
黎明强的博客
10-15 1706
Composer 下载的源码，每个框架它都必须都有一个“类的自动加载”机制 ，我们都知道PHP引入文件是需要 、 才能使用别的类文件中的方法。比如我需要写一个公共文件 model.php 但是！如何当公共类库文件很多的时候，每次都需要手动引入，就显得非常麻烦，不利于/不方便维护管理。 所以PHP引入了一个 的类自动加载，TP框架就是借助了 来完成类的自动加载。学习框架源码的第一步，先找到入口文件 ，然后一步步跟进流程，看下代码执行的过程。 打开Base.php ，第16行就会去加载 文件 （就是
thinkPHP自定义类实现方法详解
10-21
此外，ThinkPHP的自动加载机制（Composer的自动加载）在使用第三方类库时非常方便，可以有效减少代码冗余。 读者可以通过学习《ThinkPHP入门教程》、《thinkPHP模板操作技巧总结》、《ThinkPHP常用方法总结》、...
thinkphp5.1框架源码学习——自动加载
wz12013的博客
06-27 497
第一节、类的自动加载 访问请求从入口文件进入，进入base.php 首先进行类的注册加载，执行这一步骤是在 thinkphp/library/think/Loader.php 中的register方法 3. 在register方法中首先会看到spl_autoload_register函数，这个函数和__autoload魔术方法类似，将函数注册到spl__autoload函数队列中，使用这个函...
运行tp时报loader.php,tp5中的composer自动加载
weixin_36212400的博客
03-29 294
今天需要用到http请求数据，于是使用composer装了一个GuzzleHttp：composerrequireguzzlehttp/guzzle装完后直接把在laravel的代码直接拷过来了，发现报错，以为是tp5中的composer.json没配置好的原因，但随后发现是没use，-_-||，use之后发现竟然可以直接使用了，感觉很神奇，于是稍微看了下Tp5的源码：首先是index.php...
thinkphp5.1引入第三方类
weixin_45209325的博客
04-07 664
thinkphp5.1已经取消了vendor引入方式,除了使用composer方式引入外只能使用原生require引入,在引入的时候发现一个特别坑的问题,就是如果你通过相对路径引用的话会引用失败,所以正确的引用方法是 require Env::get(‘ROOT_PATH’).“extend/phpqrcode/phpqrcode.php”; ...
thinkPHP5模型中的修改器和自动完成
yixu0534的博客
10-16 699
一、修改器 实际开发过程中，一些字段在存储到表中时需要做些修改，如用户注册时填写的密码在表中存储时需要加密，修改器因此产生。 修改器同获取器类似，需要写在模型中，其命名规则为set + 字段名（按驼峰法） + Attr。 实例：添加用户时，用户的密码需要加密 创建用户表 CREATE TABLE `tp_user` ( `id` int(10) un...
利用composer给自己的类库加上自动加载功能
Wenco的博客
04-11 1989
最近在搞api架构设计，要与之前的代码隔离开来，之前的代码种种原因没有不是用的类似的自动加载，用了composer发现真的做的非常方便，自动加载功能及其好用，所以在想能不能直接利用composer的自动加载来为自己写的类库提供自动加载功能！ 百度谷歌StackOverflow，该有的答案总是会有的！ 假设你已经会composer的基本使用。 方法： 在composer.json中添加类似代码： ...
ThinkPHP5.1框架之Loader加载基础文件
蒙强的博客
05-09 1899
Loader加载基础文件
Loader.php --- ThinkPHP5源码分析
水滴穿石
06-29 1956
Loader.php — ThinkPHP5源码分析 最近开始了解ThinkPHP5框架，有很多基础知识需要学习，所以打算将自己学习笔记记录下来，即可以和大家分享，也可以方便自己以后回顾知识。由于只是个人笔记，便不是详细的教程，有不懂的地方还请自行百度。 调试工具 PHPStorm 2018.1.1 Xdebug 2.6.0 开发环境 ThinkPHP ‌5.0.16 P...
tp5完整加载执行流程——thinkphp5 框架
m0_37866091的博客
05-23 969
框架运行流程 入口文件–》定义常量–》引入函数库–》自动加载类–》启动框架–》路由解析–》加载控制器–》返回结果 1,入口文件(tp5\public\index.php) 作用: 1)定义目录常量 2)加载框架引导目录 2.加载框架引导文件(tp5\thinkphp\start.php) 作用: 1)引导基础文件 2)对应用进行运转 3.加载框架基础引导文件(tp5\thinkphp\base.php) 作用: 1)加载系统常量 2)引入loader类(tp5\thinkphp\library\t
thinkphp5——验证与杂项
shaonian1996
01-23 478
一 验证 ThinkPHP5.0验证使用独立的\think\Validate类或者验证器进行验证 独立验证 $data = [ 'name'=&gt;'thinkphp', ]; $validate = Loader::validate('User'); // 使用助手函数实例化验证器 $validate = validate('User'); if...
ThinkPHP5：API开发神器，性能与效率提升
- **惰性加载**：V5.0引入了真正的惰性加载机制，只有在实际使用时才会加载相关类，提高了性能。 - **核心组件化**：框架采用了模块化的结构，将核心类库拆分成可复用的组件，便于维护和扩展。 - **框架引导文件*...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值