[李景山php]每天TP5-20161208|Loader.php

<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2016 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------

namespace think;
// 基于 最基础的 think 命名空间
use think\exception\ClassNotFoundException;
// think\exception\ClassNotFoundException
// 运行 未发现类 异常
class Loader
{// 类加载，类
    protected static $instance = [];// 受保护的 静态的 类名映射   也就是实例化了
    // 类名映射
    protected static $map = [];// 类映射 存储位置 映射 存储关系

    // 命名空间别名
    protected static $namespaceAlias = [];// 别名 命名空间 别名

    // PSR-4
    private static $prefixLengthsPsr4 = [];// PSR-4
    private static $prefixDirsPsr4    = [];// PSR-4
    private static $fallbackDirsPsr4  = [];// PSR-4

    // PSR-0
    private static $prefixesPsr0     = [];// PSR-0
    private static $fallbackDirsPsr0 = [];// PSR-0

    // 自动加载的文件
    private static $autoloadFiles = [];// 自动加载文件的 存储 仓库
    // 基础设置

    //类+类映射+命名空间+加载文件+标准头尾










    // 2016-09-28
    // 自动加载
    public static function autoload($class)// 这个就加载文件
    {// 自动加载 类 // 加载一个class
        // 检测命名空间别名
        if (!empty(self::$namespaceAlias)) {// 如果有命名空间
            $namespace = dirname($class);// 通过类名 的路径 来的 命名空间
            if (isset(self::$namespaceAlias[$namespace])) {// 如果有别名， 通过路径来 dirname
                $original = self::$namespaceAlias[$namespace] . '\\' . basename($class);
                //连接称为 最新的 的 original 类的
                if (class_exists($original)) {// 如果这个可以 存
                    return class_alias($original, $class, false);// just return the class_alias
                    // 如果存在这个 真实的 class_alias 别名： 然后 进入到对应到的 class
                }
            }
        }
// if this empty and this namespaceAlias also been said and this class has,
        //and return this class alias
        // else
        if ($file = self::findFile($class)) {// get file from the class name
            // 获取一个 在任何环境下 都能够兼容的 文件路径
// file self::findFiles
            // Win环境严格区分大小写
            if (IS_WIN && pathinfo($file, PATHINFO_FILENAME) != pathinfo(realpath($file), PATHINFO_FILENAME)) {
                return false;
            }// if IS_WIN in the this is  a  good type to make program so strong

            __include_file($file);// use a function to wrap a nomarl type
            return true;// then return true
        }
    }// 这个函数的意思，基本上就是 自动加载对应的文件 类文件

    /**
     * 查找文件
     * @param $class
     * @return bool
     */
    private static function findFile($class)
    {// 查找文件
        if (!empty(self::$map[$class])) {// 如果 文件存在  类映射
            // 类库映射
            return self::$map[$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) {// loop 目录
                        if (is_file($file = $dir . DS . substr($logicalPathPsr4, $length))) {
                            return $file;
                        }// 如果 文件 存在 就返回
                    }
                }
            }
        }// 如果 文件 存在  直接返回

        // 查找 PSR-4 fallback dirs
        foreach (self::$fallbackDirsPsr4 as $dir) {// 如果 有 fallback Dirs Psr4  循环展示
            if (is_file($file = $dir . DS . $logicalPathPsr4)) {
                return $file;
            }
        }
// 如果有这个标准下 的 文件  返回文件
        // 查找 PSR-0
        if (false !== $pos = strrpos($class, '\\')) {// 如果这里
            // namespaced 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])) {// 如果 含这个  first 就是 class 里面的 第一个
            foreach (self::$prefixesPsr0[$first] as $prefix => $dirs) {// 循环 这里的 dir
                if (0 === strpos($class, $prefix)) {// 如果 开始就是 这个 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;
            }
        }// 如果文件有

        return self::$map[$class] = false;// 否则， 返回数据
    }
















    //2016-10-05
    // 注册classmap
    public static function addClassMap($class, $map = '')
    {// 如果 addClassMap  类文件映射，支持 数组，或者 key value 两种方式
        if (is_array($class)) {
            self::$map = array_merge(self::$map, $class);
        } else {
            self::$map[$class] = $map;
        }
    }

    // 注册命名空间
    public static function addNamespace($namespace, $path = '')
    {// 新增 命名空间注册
        // 特点：就是 支持 key value 跟 数组 赋值方式
        if (is_array($namespace)) {// if array 如果是数组
            foreach ($namespace as $prefix => $paths) {
                self::addPsr4($prefix . '\\', rtrim($paths, DS), true);
            }
        } else {// 选择 单笔 外包
            self::addPsr4($namespace . '\\', rtrim($path, DS), true);
        }
    }

    // 添加Ps0空间
    private static function addPsr0($prefix, $paths, $prepend = false)
    {// 添加 PS0 空间，
        // 如果 没存在 prefix 里面
        // 把数据给 fallbackDirsPsr0
        // prepend 代表：是配置大于约定，还是约定大于配置，这个是个常用的手法，不错，good job！
        if (!$prefix) {// 如果没有 对应的 namespace 或者 前缀
            if ($prepend) {// 默认是  false ,传入的是 true 正常调用就是执行这个
                self::$fallbackDirsPsr0 = array_merge(
                    (array) $paths,
                    self::$fallbackDirsPsr0
                );// 充分使用了 array_merge 对于 不同位置 的 覆盖方向不一样，导致的。
            } else {
                self::$fallbackDirsPsr0 = array_merge(
                    self::$fallbackDirsPsr0,
                    (array) $paths
                );
            }

            return;// 直接返回了 不会向下执行了
            // 同样深层次支持
        }
// 如果存在 first
        // 配置 到 对应的 prefix
        $first = $prefix[0];// 如果有这个 first
        if (!isset(self::$prefixesPsr0[$first][$prefix])) {// 如果没有这个
            self::$prefixesPsr0[$first][$prefix] = (array) $paths;// 设置，然后返回

            return;// 结束
        }
        // 默认 有设置的 进行合并
        if ($prepend) {// 覆盖 or 约定
            self::$prefixesPsr0[$first][$prefix] = array_merge(
                (array) $paths,
                self::$prefixesPsr0[$first][$prefix]
            );
        } else {
            self::$prefixesPsr0[$first][$prefix] = array_merge(
                self::$prefixesPsr0[$first][$prefix],
                (array) $paths
            );
        }
    }// 就是个空间的添加

    // 添加Psr4空间
    private static function addPsr4($prefix, $paths, $prepend = false)
    {// 同样的 代码
        if (!$prefix) {
            // Register directories for the root namespace.
            // 老刘啊，这个你都抄袭的，我也是醉了，哈哈，
            if ($prepend) {
                self::$fallbackDirsPsr4 = array_merge(
                    (array) $paths,
                    self::$fallbackDirsPsr4
                );
            } else {
                self::$fallbackDirsPsr4 = array_merge(
                    self::$fallbackDirsPsr4,
                    (array) $paths
                );
            }
        } elseif (!isset(self::$prefixDirsPsr4[$prefix])) {// 注册 如果没有设置 这些
            // Register directories for a new namespace.
            $length = strlen($prefix);// 长度
            if ('\\' !== $prefix[$length - 1]) {// 如果 尾部 不是这个
                throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
            }
            self::$prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
            self::$prefixDirsPsr4[$prefix]                = (array) $paths;
            // same like Ps0
        } elseif ($prepend) {// in this word,they said prepend or append
            // Prepend directories for an already registered namespace.
            self::$prefixDirsPsr4[$prefix] = array_merge(
                (array) $paths,
                self::$prefixDirsPsr4[$prefix]
            );
        } else {
            // Append directories for an already registered namespace.
            self::$prefixDirsPsr4[$prefix] = array_merge(
                self::$prefixDirsPsr4[$prefix],
                (array) $paths
            );
        }
    }

    // 注册命名空间别名
    public static function addNamespaceAlias($namespace, $original = '')
    {// 这个英文命名 感觉 当不当 洋不洋 啊，哈哈， 应该是register Name space Alias
        if (is_array($namespace)) {
            self::$namespaceAlias = array_merge(self::$namespaceAlias, $namespace);
        } else {
            self::$namespaceAlias[$namespace] = $original;
        }
    }
    /**
     * 使用这个自动加载函数
     * @param string $autoload
     */
    // 注册自动加载机制
    public static function register($autoload = '')
    {// 重点！重点！重点！重点！重点！重点！重点！重点！重点！重点！重点！
        // 重要的事情 说
        // 注册系统自动加载
        spl_autoload_register($autoload ?: 'think\\Loader::autoload', true, true);
        // 进行 系统加载 函数 自动注册
        // 自动 加载文件 // 特点，就是 用的时候，自动加载， 优于当年的 全部加载，这个也是他宣传的按需加载！
// 如果没有 对应需要 提前加载的东西，默认的 就是 检测文件是否正确，
        // 直接使用 return include 进行
        // 通过 class 名字，按照 不同的 标准 进行 加载， 更多的国际化了，你进步了

        // 其实这个里面的 核心 技术应该是 对应  不同标准的 Ps0 跟 Ps4 标准的 路径的获取
        // 实现不同 标准下的 类文件加载
        // 这个挺关键

        // 注册命名空间定义
        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));
        }// 加载 类 映射
        // 如果没有这个，这个是用户修改的，
        // addClassMap 合并数字

        // Composer自动加载支持
        if (is_dir(VENDOR_PATH . 'composer')) {
            self::registerComposerLoader();// 调用 composer
        }// 注册 各种 composerLoader 默认这个，也没有这个， 如果用户不做修改的话，默认就没有了

        // 自动加载extend目录
        self::$fallbackDirsPsr4[] = rtrim(EXTEND_PATH, DS);// 加载对应的目录 加载对应的
    }

























    // 2016-10-06
    // 注册composer自动加载
    private static function registerComposerLoader()
    {// 默认没有 ，不会执行
        if (is_file(VENDOR_PATH . 'composer/autoload_namespaces.php')) {
            $map = require VENDOR_PATH . 'composer/autoload_namespaces.php';
            foreach ($map as $namespace => $path) {
                self::addPsr0($namespace, $path);
            }
        }// 加载命名空间

        if (is_file(VENDOR_PATH . 'composer/autoload_psr4.php')) {
            $map = require VENDOR_PATH . 'composer/autoload_psr4.php';
            foreach ($map as $namespace => $path) {
                self::addPsr4($namespace, $path);
            }
        }// 加载 Psr4 标准

        if (is_file(VENDOR_PATH . 'composer/autoload_classmap.php')) {
            $classMap = require VENDOR_PATH . 'composer/autoload_classmap.php';
            if ($classMap) {
                self::addClassMap($classMap);
            }
        }// 加载 classmap

        if (is_file(VENDOR_PATH . 'composer/autoload_files.php')) {
            $includeFiles = require VENDOR_PATH . 'composer/autoload_files.php';
            foreach ($includeFiles as $fileIdentifier => $file) {
                if (empty(self::$autoloadFiles[$fileIdentifier])) {
                    __require_file($file);
                    self::$autoloadFiles[$fileIdentifier] = true;
                }
            }
        }// 加载 文件
    }

    /**
     * 导入所需的类库 同java的Import 本函数有缓存功能
     * @param string $class   类库命名空间字符串
     * @param string $baseUrl 起始路径
     * @param string $ext     导入的文件扩展名
     * @return boolean
     */
    public static function import($class, $baseUrl = '', $ext = EXT)
    {// 导入 类文件
        static $_file = [];// 静态文件 仓库
        $key          = $class . $baseUrl;// key 文件
        $class        = str_replace(['.', '#'], [DS, '.'], $class);//处理 class
        if (isset($_file[$key])) {
            return true;
        }// 如果 加载过了 这个 文件， 就直接
        if (empty($baseUrl)) {// 如果起始路径 为空，就是默认值
            list($name, $class) = explode(DS, $class, 2);// 返回 类的 前面两个数组

            if (isset(self::$prefixDirsPsr4[$name . '\\'])) {// 如果存在这个 Psr4
                // 注册的命名空间
                $baseUrl = self::$prefixDirsPsr4[$name . '\\'];
            } elseif ('@' == $name) {
                //加载当前模块应用类库
                $baseUrl = App::$modulePath;// 获取 @ 方式
            } elseif (is_dir(EXTEND_PATH . $name)) {
                $baseUrl = EXTEND_PATH;// 获取 基础 地址
            } else {
                // 加载其它模块的类库
                $baseUrl = APP_PATH . $name . DS;
            }
        } elseif (substr($baseUrl, -1) != DS) {
            $baseUrl .= DS;
        }// 获取 baseUrl


        // 如果类存在 则导入类库文件
        if (is_array($baseUrl)) {// 如果 基础地址 为 baseUrl
            foreach ($baseUrl as $path) {
                $filename = $path . DS . $class . $ext;// baseUrl
                if (is_file($filename)) {
                    break;// 找到了 文件 就退出
                }
            }
        } else {
            $filename = $baseUrl . $class . $ext;
        }// 获取 了 filename

        if (!empty($filename) && is_file($filename)) {// 如果 没有 文件， 如果有这个文件
            // 开启调试模式Win环境严格区分大小写
            if (IS_WIN && pathinfo($filename, PATHINFO_FILENAME) != pathinfo(realpath($filename), PATHINFO_FILENAME)) {
                return false;
            }// 如果路径 不行
            __include_file($filename);// 加载文件
            $_file[$key] = true;// 执行 状态
            return true;
        }
        return false;
    }















    //2016-10-07
    /**
     * 实例化（分层）模型
     * @param string $name         Model名称
     * @param string $layer        业务层名称
     * @param bool   $appendSuffix 是否添加类名后缀
     * @param string $common       公共模块名
     * @return Object
     * @throws ClassNotFoundException
     */
    public static function model($name = '', $layer = 'model', $appendSuffix = false, $common = 'common')
    {// this is get model
        // 获取对应的信息
        if (isset(self::$instance[$name . $layer])) {
            return self::$instance[$name . $layer];
        }// 不同的 层 跟 不同的 名字 就可以确定 不同的 model
        // 对应到 不同的 key
        if (strpos($name, '/')) {// 如果你的名字不纯洁 那么就要处理你
            list($module, $name) = explode('/', $name, 2);//默认给到的 就是 list 方式
        } else {
            $module = Request::instance()->module();// 否则 应该会自动加载了，这个位置，不是初始化调用的地方
        }
        $class = self::parseClass($module, $layer, $name, $appendSuffix);// 获取到对应的 类 名 ， this class name
        if (class_exists($class)) {// 找到的这个class变量，如果是个 class 的话，就使用他
            $model = new $class(); // 好用法
        } else {
            $class = str_replace('\\' . $module . '\\', '\\' . $common . '\\', $class);// 再次处理 这个 class
            if (class_exists($class)) {// 如果可以了
                $model = new $class();// 执行他
            } else {// 否则的话 抛出 类 异常
                // 这里可以补充一下， 其实应该是 model class not exists:
                throw new ClassNotFoundException('class not exists:' . $class, $class);
            }
        }
        self::$instance[$name . $layer] = $model;// 存入 key value 关键字
        return $model;// 返回 数据
    }

    /**
     * 实例化（分层）控制器 格式：[模块名/]控制器名
     * @param string $name         资源地址
     * @param string $layer        控制层名称
     * @param bool   $appendSuffix 是否添加类名后缀
     * @param string $empty        空控制器名称
     * @return Object|false
     * @throws ClassNotFoundException
     */
    public static function controller($name, $layer = 'controller', $appendSuffix = false, $empty = '')
    {
        // 第一步： 获取对应的 model
            // 通过 不同的 方式 1
            // 方式2
        if (strpos($name, '/')) {
            list($module, $name) = explode('/', $name);
        } else {
            $module = Request::instance()->module();
        }
        // 第二步： 获取 class
        $class = self::parseClass($module, $layer, $name, $appendSuffix);

        // 第三步：对获取的class 进行 验证，存在，就
        if (class_exists($class)) {
            return new $class(Request::instance());// 返回
        } elseif ($empty && class_exists($emptyClass = self::parseClass($module, $layer, $empty, $appendSuffix))) {
            return new $emptyClass(Request::instance());// 返回空的
            // 看来进步了，没有报错，哈哈
        }
    }

    /**
     * 实例化验证类 格式：[模块名/]验证器名
     * @param string $name         资源地址
     * @param string $layer        验证层名称
     * @param bool   $appendSuffix 是否添加类名后缀
     * @param string $common       公共模块名
     * @return Object|false
     * @throws ClassNotFoundException
     */
    public static function validate($name = '', $layer = 'validate', $appendSuffix = false, $common = 'common')
    {// 进行验证，验证类型：
        // 名字 层名字 前缀
        $name = $name ?: Config::get('default_validate');// 获取验证规则 地址
        if (empty($name)) {// empty $name 如果文件为空，直接返回
            return new Validate;// 新的 验证类 Validate 新的验证类
        }

        if (isset(self::$instance[$name . $layer])) {// 存在就直接返回
            return self::$instance[$name . $layer];
        }// 如果已经 验证了
        if (strpos($name, '/')) {//
            list($module, $name) = explode('/', $name);
        } else {
            $module = Request::instance()->module();
        }
        // 获取类
        $class = self::parseClass($module, $layer, $name, $appendSuffix);
        if (class_exists($class)) {// 如果类存在
            $validate = new $class;// 生成 新类
        } else {
            $class = str_replace('\\' . $module . '\\', '\\' . $common . '\\', $class);// 如果 获取类
            if (class_exists($class)) {
                $validate = new $class;// 返回新 类
            } else {
                throw new ClassNotFoundException('class not exists:' . $class, $class);
            }
        }// 你懂的 类不存在了
        self::$instance[$name . $layer] = $validate;// 存档 备查询
        return $validate;
    }

    /**
     * 数据库初始化 并取得数据库类实例
     * @param mixed         $config 数据库配置
     * @param bool|string   $name 连接标识 true 强制重新连接
     * @return \think\db\Connection
     */
    public static function db($config = [], $name = false)
    {
        return Db::connect($config, $name);
    }// 数据库 初始化 并取得 数据库 实例

    /**
     * 远程调用模块的操作方法 参数格式 [模块/控制器/]操作
     * @param string       $url          调用地址
     * @param string|array $vars         调用参数 支持字符串和数组
     * @param string       $layer        要调用的控制层名称
     * @param bool         $appendSuffix 是否添加类名后缀
     * @return mixed
     */
    public static function action($url, $vars = [], $layer = 'controller', $appendSuffix = false)
    {
        $info   = pathinfo($url);// 获取 url 地址信息
        $action = $info['basename'];// 获取 action 方式
        $module = '.' != $info['dirname'] ? $info['dirname'] : Request::instance()->controller();
        // 获取 中间值 module
        $class  = self::controller($module, $layer, $appendSuffix);// 获取 class 名称
        if ($class) {// 如果存在 class
            if (is_scalar($vars)) {// 如果是标准量
                if (strpos($vars, '=')) {// strpos
                    parse_str($vars, $vars);// 解析字符串
                } else {
                    $vars = [$vars];// 这个强转换 漂亮
                }
            }
            return App::invokeMethod([$class, $action . Config::get('action_suffix')], $vars);
        }//return App:: 验证文件是否存在
    }

    /**
     * 字符串命名风格转换
     * type 0 将Java风格转换为C的风格 1 将C风格转换为Java的风格
     * @param string  $name 字符串
     * @param integer $type 转换类型
     * @return string
     */
    public static function parseName($name, $type = 0)
    {// 转换字符串 风格的 一个小函数，如果1 就大写，否则就小写
        if ($type) {
            return ucfirst(preg_replace_callback('/_([a-zA-Z])/', function ($match) {
                return strtoupper($match[1]);
            }, $name));
        } else {
            return strtolower(trim(preg_replace("/[A-Z]/", "_\\0", $name), "_"));
        }
    }

    /**
     * 解析应用类的类名
     * @param string $module 模块名
     * @param string $layer  层名 controller model ...
     * @param string $name   类名
     * @param bool   $appendSuffix
     * @return string
     */
    public static function parseClass($module, $layer, $name, $appendSuffix = false)
    {// 解析 Class 类名
        $name  = str_replace(['/', '.'], '\\', $name);// 替换类名
        $array = explode('\\', $name);// 解析类资源
        $class = self::parseName(array_pop($array), 1) . (App::$suffix || $appendSuffix ? ucfirst($layer) : '');
        $path  = $array ? implode('\\', $array) . '\\' : '';
        return App::$namespace . '\\' . ($module ? $module . '\\' : '') . $layer . '\\' . $path . $class;
    }// 解析 类名

    /**
     * 初始化类的实例
     * @return void
     */
    public static function clearInstance()
    {
        self::$instance = [];
    }// 初始化，就是 清空实例
}

/**
 * 作用范围隔离
 *
 * @param $file
 * @return mixed
 */
function __include_file($file)
{
    return include $file;
}// 封装，暂时不用加载那个 commons.php

function __require_file($file)
{
    return require $file;
}// 封装，默认加载