写在前面,写这些随笔是记录下自己看Yii2源码的过程,可能会有些流水账,大部分解析放在注释里说明,由于个人水平有限,有不正确的地方还望斧正。

以下源码版本基于Yii2的2.0.34版本,模板用的基础版。

  1. // 定义全局的常量,YII_DEBUG标识是够开启debug模式,YII_ENV标识出当前运行环境,默认env(开发), 上线后改成prod来表示正式环境。
  2. defined('YII_DEBUG') or define('YII_DEBUG', true);
  3. defined('YII_ENV') or define('YII_ENV', 'dev');
  4. // 加载composer vendor的autoload文件
  5. require(__DIR__ . '/../vendor/autoload.php');
  6. // 加载Yii框架
  7. require(__DIR__ . '/../vendor/yiisoft/yii2/Yii.php');

入口文件很简单,做了一些初始化工作,具体看注释。

接下来看加载的Yii文件代码:

  1. <?php
  2. /**
  3. * Yii bootstrap file.
  4. *
  5. * @link http://www.yiiframework.com/
  6. * @copyright Copyright (c) 2008 Yii Software LLC
  7. * @license http://www.yiiframework.com/license/
  8. */
  9.  
  10. require(__DIR__ . '/BaseYii.php');
  11. /**
  12. * Yii is a helper class serving common framework functionalities.
  13. *
  14. * It extends from [[\yii\BaseYii]] which provides the actual implementation.
  15. * By writing your own Yii class, you can customize some functionalities of [[\yii\BaseYii]].
  16. *
  17. * @author Qiang Xue <qiang.xue@gmail.com>
  18. * @since 2.0
  19. */
  20. class Yii extends \yii\BaseYii
  21. {
  22. }
  23. // 调用Yii::autoload来注册autoload, 而且是放到autoload队列之首。
  24. spl_autoload_register(['Yii', 'autoload'], true, true);
  25. // 包含class映射文件
  26. Yii::$classMap = require(__DIR__ . '/classes.php');
  27. // 初始化DI容器
  28. Yii::$container = new yii\di\Container();

PS:这边涉及到php的自动加载概念(https://www.php.net/manual/zh/function.spl-autoload-register)和设计模式-依赖注入(https://www.kancloud.cn/kancloud/yii-in-depth/50793)。

这个文件主要进行一些Yii源码的初始化操作,这里的class Yii只是继承了BaseYii,没有写任何代码,所以yii2的源码都是在BaseYii里面的,这里留空是为了给使用者自定义的。

  1. public static function autoload($className)
  2. {
  3. // 从classMap里寻找
  4. if (isset(static::$classMap[$className])) {
  5. $classFile = static::$classMap[$className];
  6. if ($classFile[0] === '@') {
  7. $classFile = static::getAlias($classFile);
  8. }
  9. } elseif (strpos($className, '\\') !== false) {
  10. // 命名空间访问,先把命名空间的格式转成路径别名,例如: yii\base\Component 转成 @yii/base/Component.php
  11. $classFile = static::getAlias('@' . str_replace('\\', '/', $className) . '.php', false);
  12. if ($classFile === false || !is_file($classFile)) {
  13. return;
  14. }
  15. } else {
  16. return;
  17. }
  18. include($classFile);
  19. if (YII_DEBUG && !class_exists($className, false) && !interface_exists($className, false) && !trait_exists($className, false)) {
  20. throw new UnknownClassException("Unable to find '$className' in file: $classFile. Namespace missing?");
  21. }
  22. }

​ 简单总结下,这个函数规定了一些规则让php在寻找未知class时候可以include对应的文件,规则如下:

​ (1) 在classMap里面找

​ (2)如果class是使用命名空间访问的(例如:yii\base\Component), 会按照@yii/base/Component.php这样的路径去加载。

规则1说从classMap里面,那么classMap是什么呢,在入口文件里能找到Yii::$classMap = require(__DIR__ . '/classes.php');,然后去看下classes.php是什么样子的:

  1. return [
  2. 'yii\base\Action' => YII2_PATH . '/base/Action.php',
  3. 'yii\base\ActionEvent' => YII2_PATH . '/base/ActionEvent.php',
  4. .....
  5. ]

只是返回一个数组,key是class的名字,value是对应php文件的路径(YII2_PATH是预定于的常量,表示当前目录)。

if (isset(static::$classMap[$className])) {

所以Yii::autoload会先判断是否在classMap里面。

  1. $classFile = static::getAlias('@' . str_replace('\\', '/', $className) . '.php', false);

函数会先把命名空间形式的调用转成对应的路径别名,再用getAlias函数转成对应的路径。

再来看看static::getAlias()这个函数是怎么把路径别名转成路径的。

  1. public static $aliases = ['@yii' => __DIR__]; // 预设的路径别名映射数组
  1. public static function getAlias($alias, $throwException = true)
  2. {
  3. // 检查是否有@前缀,没有的话直接返回。
  4. if (strncmp($alias, '@', 1)) {
  5. // not an alias
  6. return $alias;
  7. }
  8. // 取出@alias部分赋值给root
  9. $pos = strpos($alias, '/');
  10. $root = $pos === false ? $alias : substr($alias, 0, $pos);
  11. // 检查root是否在$aliases里是否有对应的alias
  12. if (isset(static::$aliases[$root])) {
  13. // 在$aliases里找到对应的@alias然后转化成实际的路径并返回
  14. if (is_string(static::$aliases[$root])) {
  15. return $pos === false ? static::$aliases[$root] : static::$aliases[$root] . substr($alias, $pos);
  16. }
  17. // 如果找到的不是对应的路径字符串,就变量这个数组,看看里面有没有对应的
  18. foreach (static::$aliases[$root] as $name => $path) {
  19. if (strpos($alias . '/', $name . '/') === 0) {
  20. return $path . substr($alias, strlen($name));
  21. }
  22. }
  23. }
  24. if ($throwException) {
  25. throw new InvalidParamException("Invalid path alias: $alias");
  26. }
  27. return false;
  28. }
  1. $config = require(__DIR__ . '/../config/web.php'); // 加载配置文件
  2. (new yii\web\Application($config))->run();

到这里就开始涉及config配置的解析了,下一篇才慢慢分析。

 

版权声明:本文为linzJo原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://www.cnblogs.com/linzJo/p/13265776.html