【thinkphp5分析三】ThinkPHP自动注册分析 - 深入了解ThinkPHP框架的自动注册机制

sockstack / 505 / 2023-07-28 22:09:10

ThinkPHP5 源码分析

ChatGPT 可用网址，仅供交流学习使用，如对您有所帮助，请收藏并推荐给需要的朋友。 <a href="https://ckai.xyz/?sockstack&section=detail" target="__blank">https://ckai.xyz</a> ## 源码分析
### 自动加载
系统会调用 Loader::register()方法注册自动加载，在这一步完成后，所有符合规范的类库（包括Composer依赖加载的第三方类库）都将自动加载。

系统的自动加载由下面主要部分组成：

```
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;
    }

```

#### 检测命名空间别名

检查是否添加了命名空间别名，通过别名寻找原命名空间。如：

```

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

//添加别名后
\Controller\Index::class

```

thinkphp通过 \think\Loader::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;
        }
    }
    
    
```

通过键为别名，值为原命名空间的数组，注册到\think\Loader::$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进行加载，方法分别是： \think\Loader::addClassMap($class, $map = '') 和 \think\Loader::addNamespace($namespace, $path = '')。

psr-4的加载方式是通过命名空间的首字母，查找对应的命名空间，再通过对应的命名空间拼接对应的文件目录，判断该文件是否存在，如果存在就加载文件，实现类的自动加载。

classmap的加载方式是通过composer du生成对应的类映射，通过直接查找class对应的文件，从而实现自动加载。

其他的加载方式需要深入了解的可以自行研究代码。

```

/**
     * 注册自动加载机制
     * @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);

....
    }

```

【thinkphp5分析三】ThinkPHP自动注册分析 - 深入了解ThinkPHP框架的自动注册机制

作者

sockstack

许可协议

CC BY 4.0

发布于

2023-07-28

修改于

2024-10-11

上一篇：百度快速收录下一篇：【thinkphp5分析二】ThinkPHP应用入口分析 - 深入研究ThinkPHP框架的应用入口

尚未登录

【thinkphp5分析三】ThinkPHP自动注册分析 - 深入了解ThinkPHP框架的自动注册机制

文章分类

博客重构之路

Spring Boot简单入门

k8s 入门教程

MySQL 知识

NSQ 消息队列

ThinkPHP5 源码分析

使用 Docker 从零开始搭建私人代码仓库

日常开发汇总

标签列表

springboot

hyperf

swoole

webman

php

多线程

数据结构

docker

k8s

thinkphp

mysql

tailwindcss

flowbite

css

前端