Yii2的整体结构概览

Yii2的整体结构概览

一、yii2内部中各类之间的关系

1.  各类之间的关系

yiiwebApplication->yiiaseApplication->yiiaseModule->yiidiServiceLocator->yiiaseComponent->yiiaseBaseObject->yiiaseConfigurable

SiteController -> yiiwebController -> yiiaseController -> yiiaseComponent->yiiaseBaseObject->yiiaseConfigurable

2.  目录以及文件

yiiase目录：框架的底层类

yiiaseModule:  子应用程序，debug、gii都是独立的module

yiidiServiceLocator:  服务定位器，主要负责组件component的管理

yiiaseComponent:  这个类非常重要，它所实现的属性、事件、行为功能贯穿yii2源码

yiiaseBaseObject:  该类中没有事件行为机制，自己实现的类可以继承该类

二、 预初始化

从入口脚本index.php着手：

我们看到这一段： (new yiiwebApplication($config))->run();  启动程序

它实际指的是父类 yiiaseApplication::run 方法，是启动整个应用程序的“钥匙”。在执行yiiaseApplication::run之前, yiiaseApplication 的构造方法__construct会先被执行。

下面截取 yiiaseApplication 中的一段代码：

<?php
namespace yiiase;

use Yii;
abstract class Application extends Module
{
    const EVENT_BEFORE_REQUEST = 'beforeRequest';
    const EVENT_AFTER_REQUEST = 'afterRequest';
    const STATE_BEGIN = 0;
    const STATE_INIT = 1;
    const STATE_BEFORE_REQUEST = 2;
    const STATE_HANDLING_REQUEST = 3;
    const STATE_AFTER_REQUEST = 4;
    const STATE_SENDING_RESPONSE = 5;
    const STATE_END = 6;
    ...
    public function __construct($config = [])
    {
        Yii::$app = $this;
        static::setInstance($this);

        $this->state = self::STATE_BEGIN;

        $this->preInit($config); // 预初始化

        $this->registerErrorHandler($config);

        Component::__construct($config);
    }
}

Component::__construct实际指的是 yiiaseBaseObject::__construct，这个方法的作用是什么呢？

顺便提下：

1） Object是php7.2中的保留类名，不可以使用Object作为类的名称。

2） 从 Yii2 2.0.13版本开始，已经弃用了 Object类，此前版本中的yiiaseObject使用 yiiaseBaseObject 进行代替

接下来，我们来看下yiiaseBaseObject::__construct( )

<?php
namespace yiiase;

use Yii;
class BaseObject implements Configurable
{
    ...
    // 该方法有两个重点含义：
    // 1.调用 yiiBaseYii::configure 方法，初始化 yiiwebApplication 类的属性
    // 2.调用 yiiwebApplication::init 方法完成初始化操作
    public function __construct($config = [])
    {
        if (!empty($config)) {
            // $this 自然指的是 yiiwebApplication，$config 指的是我们的配置数组。
            Yii::configure($this, $config);
        }
        $this->init();
    }  
}

说明：

    yiiaseBaseObject::__construct 方法内执行 $this->init()，也就是说，但凡是继承 yiiaseBaseObject 的类，init方法都是在 __construct 方法运行后调用。这在继承复杂的类时，很重要也很方便。前提是一旦重写父类的 __construct 方法，记得调用 parent::__construct哦。

    这里 $this->init 方法的调用，实际是调用 yiiaseApplication::init 方法。该方法则会带入我们进入下一阶段：应用的初始化。

    从应用的角度来说，$this 指的就是 yiiwebApplication 类的实例 Yii::$app，这里调用的自然就是 yiiwebApplication 的init方法，但是在yiiwebApplication中并没有找到 init 方法，不过我们在其父类 yiiaseApplication 中找

到对应的init方法，代码如下：

<?php
namespace yiiase;

use Yii;
abstract class Application extends Module
{
    ...
    public function init()
    {
        $this->state = self::STATE_INIT;
        $this->bootstrap();
    }

}

 yiiaseApplication::bootstrap 方法主要是初始化扩展和执行component 的 bootstrap方法，该方法主要用于一些component的启动工作。

三、执行请求

上面讲的内容其实都是在为运行应用而做的准备，应用的运行，可能要分为几个步骤，我们先从 yiiaseApplication::run 方法说起

<?php
namespace yiiase;

use Yii;
abstract class Application extends Module
{
    ...
    public function run()
    {
        try {
            $this->state = self::STATE_BEFORE_REQUEST;
            $this->trigger(self::EVENT_BEFORE_REQUEST);

            $this->state = self::STATE_HANDLING_REQUEST;
            // 非常重要：捕获路由，处理路由以及根据路由规则调用对应的方法
            $response = $this->handleRequest($this->getRequest());

            $this->state = self::STATE_AFTER_REQUEST;
            $this->trigger(self::EVENT_AFTER_REQUEST);

            $this->state = self::STATE_SENDING_RESPONSE;
            $response->send();

            $this->state = self::STATE_END;

            return $response->exitStatus;
        } catch (ExitException $e) {
            $this->end($e->statusCode, isset($response) ? $response : null);
            return $e->statusCode;
        }
    }
    
    // 由yiiwebApplication实现了该抽象方法
    abstract public function handleRequest($request);

}

精华部分：

yiiwebApplication::handleRequest 相关代码如下：

主要分为三部分：

1.  解析路由
2.  运行路由指定的控制器操作
3.  响应客户端请求

<?php
namespace yiiweb;

use Yii;
use yiiaseInvalidRouteException;
use yiihelpersUrl;

class Application extends yiiaseApplication
{
    ...
    public function handleRequest($request)
    {
        // 解析路由
        if (empty($this->catchAll)) {
            try {
                list($route, $params) = $request->resolve();
            } catch (UrlNormalizerRedirectException $e) {
                $url = $e->url;
                if (is_array($url)) {
                    if (isset($url[0])) {
                        // ensure the route is absolute
                        $url[0] = '/' . ltrim($url[0], '/');
                    }
                    $url += $request->getQueryParams();
                }

                return $this->getResponse()->redirect(Url::to($url, $e->scheme), $e->statusCode);
            }
        } else {
            $route = $this->catchAll[0];
            $params = $this->catchAll;
            unset($params[0]);
        }
        try {
            // 运行路由指定的控制器操作
            Yii::debug("Route requested: '$route'", __METHOD__);
            $this->requestedRoute = $route;
            $result = $this->runAction($route, $params);

            // 响应客户端请求
            if ($result instanceof Response) {
                return $result;
            }

            $response = $this->getResponse();
            if ($result !== null) {
                $response->data = $result;
            }

            return $response;
        } catch (InvalidRouteException $e) {
            throw new NotFoundHttpException(Yii::t('yii', 'Page not found.'), $e->getCode(), $e);
        }
    }
}

重点放在第二部分：

yiiaseModule::runAction

分为两部分：
1.   创建controller实例：yiiaseModule::createController
1） 注意里面有一个controllerMap优先的原则
2） yiiaseModule::createControllerByID
3） gii/debug没有被解析到giiController/debugController的原因
4） 控制器必须是SiteController的原因
5） controller都得是yiiaseController的子类

yiiaseModule中相关代码如下：

<?php
namespace yiiase;

use Yii;
use yiidiServiceLocator;

class Module extends ServiceLocator
{
    const EVENT_BEFORE_ACTION = 'beforeAction';
    const EVENT_AFTER_ACTION = 'afterAction';
    ...
    public function runAction($route, $params = [])
    {
        // 1. 创建controller实例
        $parts = $this->createController($route);
        if (is_array($parts)) {
            /* @var $controller Controller */
            list($controller, $actionID) = $parts;
            $oldController = Yii::$app->controller;
            Yii::$app->controller = $controller;
            // 运行controller的action
            $result = $controller->runAction($actionID, $params);
            if ($oldController !== null) {
                Yii::$app->controller = $oldController;
            }

            return $result;
        }

        $id = $this->getUniqueId();
        throw new InvalidRouteException('Unable to resolve the request "' . ($id === '' ? $route : $id . '/' . $route) . '".');
    }

    ....
    public function createController($route)
    {
        // 访问省略路由的时候，默认就是site
        if ($route === '') {
            $route = $this->defaultRoute;
        }
        ...  

        // module and controller map take precedence(controllerMap优先的原则)  
        if (isset($this->controllerMap[$id])) {
            $controller = Yii::createObject($this->controllerMap[$id], [$id, $this]);
            return [$controller, $route];
        }

        // 这段代码可以用来解释：在地址栏输入 index.php?r=gii,这个路由就被解析到gii模块了，而不是giiController
        // 不过像gii这种的module，它既然也是一个独立的module，所以势必最终还是会重新走createController方法，即我们还是可以通过controllerMap映射阻断他的这种解析。
        $module = $this->getModule($id);
        if ($module !== null) {
            return $module->createController($route);
        }

        if (($pos = strrpos($route, '/')) !== false) {
            $id .= '/' . substr($route, 0, $pos);
            $route = substr($route, $pos + 1);
        }

        $controller = $this->createControllerByID($id);
        if ($controller === null && $route !== '') {
            $controller = $this->createControllerByID($id . '/' . $route);
            $route = '';
        }
       
        // 返回yiiaseController的实例和操作ID
        return $controller === null ? false : [$controller, $route];
    }

    public function createControllerByID($id)
    {
        ...
        
        // 这段代码可以解释：类文件不是class Site而是class SiteController
        $className = preg_replace_callback('%-([a-z0-9_])%i', function ($matches) {
                return ucfirst($matches[1]);
            }, ucfirst($className)) . 'Controller';
        $className = ltrim($this->controllerNamespace . '\' . str_replace('/', '\', $prefix) . $className, '\');
        if (strpos($className, '-') !== false || !class_exists($className)) {
            return null;
        }
        
        // 必须是yiiaseController的子类
        if (is_subclass_of($className, 'yiiaseController')) {
            $controller = Yii::createObject($className, [$id, $this]);
            return get_class($controller) === $className ? $controller : null;
        } elseif (YII_DEBUG) {
            throw new InvalidConfigException('Controller class must extend from \yii\base\Controller.');
        }

        return null;
    }
}

2.  运行controller的action：yiiaseController::runAction

下面是yiiaseController的相关部分代码：

<?php
namespace yiiase;

use Yii;
use yiidiInstance;
use yiidiNotInstantiableException;

class Controller extends Component implements ViewContextInterface
{
    const EVENT_BEFORE_ACTION = 'beforeAction';
    const EVENT_AFTER_ACTION = 'afterAction';
    ...
    public function runAction($id, $params = [])
    {
        $action = $this->createAction($id);
        ...

        // call beforeAction on modules
        // yii::$app就是一个独立的module,由于这里的 $module 指的是 yiiwebApplication，所以 yiiwebApplication::beforeAction先被调起
        // 其含义指的是先发起对应用级别的 beforeAction 事件调用。yiiwebApplication::beforeAction 这里指的是 yiiaseModule::beforeAction
        foreach ($this->getModules() as $module) {
            if ($module->beforeAction($action)) {
                array_unshift($modules, $module);
            } else {
                $runAction = false;
                break;
            }
        }

        $result = null;
        // 确认runAction为true(应用级别的beforeAction事件返回结果都是true)
        // 再调用 controller 级别的 beforeAction 事件。这里指的是 yiiwebApplication::beforeAction方法
        if ($runAction && $this->beforeAction($action)) {
            // run the action
            $result = $action->runWithParams($params);
            
            // 将返回结果交给afterAction处理，这是预留的另外一个事件，方便大家使用  
            $result = $this->afterAction($action, $result);

            // call afterAction on modules
            // 继续调用 module的afterAction，处理一些应用级别的afterAction事件
            foreach ($modules as $module) {
                /* @var $module Module */
                $result = $module->afterAction($action, $result);
            }
        }
        ...
    }

    public function createAction($id)
    {
        // 判断actionID，如果是空，则使用默认的action
        if ($id === '') {
            $id = $this->defaultAction;
        }
        
        // action的映射关系，跟controller有点像,如果actions方法中有配置，则执行actions方法配置的优先策略
        $actionMap = $this->actions();
        if (isset($actionMap[$id])) {
            return Yii::createObject($actionMap[$id], [$id, $this]);
        }

        if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
            $methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
            if (method_exists($this, $methodName)) {
                // 通过反射，严格要求此方法是public可访问的
                $method = new ReflectionMethod($this, $methodName);
                if ($method->isPublic() && $method->getName() === $methodName) {
                    //  yiiaseInlineAction 的实例
                    return new InlineAction($id, $this, $methodName);
                }
            }
        }

        return null;
    }
}

总结：

1） yiiaseController::createAction: 返回yiiaseInlineAction 的实例
2） 同创建controller实例类似，注意里面有一个controllerMap优先的原则
3） yiiaseModule::beforeAction
4）yiiaseInlineAction::runWithParams 代码如下：

<?php
namespace yiiase;

use Yii;

class InlineAction extends Action
{
    ...
    public function runWithParams($params)
    {
        $args = $this->controller->bindActionParams($this, $params);
        Yii::debug('Running action: ' . get_class($this->controller) . '::' . $this->actionMethod . '()', __METHOD__);
        if (Yii::$app->requestedParams === null) {
            Yii::$app->requestedParams = $args;
        }
        // 调用 controller::action方法
        return call_user_func_array([$this->controller, $this->actionMethod], $args);
    }
}

 action执行完了之后，这一切的结果，交由yiiaseModule::runAction方法处理，当然，这个方法也只是一个过程，这个方法的调用，源于最初的运行应用的方法 yiiwebApplication::handleRequest 方法。

参考链接：

http://www.manks.top/yii2-analysis-prev-init.html

http://www.manks.top/yii2-analysis-run-action.html