Yii2 完整框架分析（詳細）

spademan 發(fā)布于2019-06-28 14:20 / 1735人閱讀

摘要：行為是如何注冊到組件的呢通過注冊行為之后，實際上是添加到了的屬性中那么行為中的屬性，就添加到了，中進行直接調(diào)用行為里面的方法的時候，實際上觸發(fā)了里面的魔術(shù)方法繼承鏈圖解

Yii2 框架Trace 準備

了解composer的autoload psr0 psr4 加載機制

了解spl_autoload_register

了解依賴注入的實現(xiàn)原理反射

了解常用魔術(shù)方法__set,__get,__call

熱情與專注

入口分析

加載composer 的自動加載器，支持了PSR-0 PSR-4

require(__DIR__ . "/../vendor/autoload.php");

進行常量的定義，并且聲明了最基本的方法例如getVersion

require __DIR__ . "/BaseYii.php";

加載Yii自己的autoload加載器，從classmap中尋找，指定的類，如果沒有找到，會解析名稱到路徑。

spl_autoload_register(["Yii", "autoload"], true, true);
Yii::$classMap = require __DIR__ . "/classes.php";

todo 容器生成

Yii::$container = new yiidiContainer();

開始生成一個應(yīng)用主體，并且加載了config配置，直接運行

(new yiiwebApplication($config))->run();

主體生成

application is the base class for all web application classes.

Yii::$app 是應(yīng)用主體的實例，一個請求只會生成一個應(yīng)用主體
在Application類中，定義了初始的defaultRoute，以及coreComponent核心組件的列表，還有一些請求和相應(yīng)相關(guān)的方法

繼承鏈

web/application=>base/application=>base/Model=>id/ServiceLocator=>base/component=>base/object=>base/configurable

初始化主體的配置

public function __construct($config = [])
    {
        Yii::$app = $this; // 這樣在任何地方都可以通過靜態(tài)方法的方式，來調(diào)用應(yīng)用主體
        static::setInstance($this); // 將請求過來的的類實力，進行保存

        $this->state = self::STATE_BEGIN;

        $this->preInit($config); // 進行config的初始化，給路徑起別名，設(shè)置時區(qū)等，并且最后加載了核心組件

        $this->registerErrorHandler($config); // 注冊錯誤句柄，用來捕捉和處理錯誤的方法

        Component::__construct($config); // 
    }

其中preInit會進行一個注冊核心組件，這里web的入口進行了擴展，包含了request等

public function coreComponents()
    {
        return array_merge(parent::coreComponents(), [
            "request" => ["class" => "yiiwebRequest"],
            "response" => ["class" => "yiiwebResponse"],
            "session" => ["class" => "yiiwebSession"],
            "user" => ["class" => "yiiwebUser"],
            "errorHandler" => ["class" => "yiiwebErrorHandler"],
        ]);
    }

講configure格式為對象，存儲到應(yīng)用主體中

public function __construct($config = [])
    {
        if (!empty($config)) {
            Yii::configure($this, $config);
        }
        $this->init();
    }

組件注冊

這里我們來看下組件是如何注冊到應(yīng)用主體中的，這個-> 實際上調(diào)用的是__Set魔術(shù)方法，
那我們再看這個$this是什么，很明顯是指yiiwebapplication

public static function configure($object, $properties)
    {
        foreach ($properties as $name => $value) {
            $object->$name = $value;
        }

        return $object;
    }

我們從webapplication向parent一層一層的找，找到了__set 的定義，在basecomponent

public function __set($name, $value)
    {
        $setter = "set" . $name;
        if (method_exists($this, $setter)) {
            // set property
            $this->$setter($value);

            return;
        } elseif (strncmp($name, "on ", 3) === 0) {
            // on event: attach event handler
            $this->on(trim(substr($name, 3)), $value);

            return;
        } elseif (strncmp($name, "as ", 3) === 0) {
            // as behavior: attach behavior
            $name = trim(substr($name, 3));
            $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));

            return;
        }

        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = $value;
                return;
            }
        }

        if (method_exists($this, "get" . $name)) {
            throw new InvalidCallException("Setting read-only property: " . get_class($this) . "::" . $name);
        }

        throw new UnknownPropertyException("Setting unknown property: " . get_class($this) . "::" . $name);
    }

上面的set方法，會遍歷config的屬性，來交給不同的set方法處理，果然恰好存在了一個setComponents，用來處理組件

public function setComponents($components)
    {
        foreach ($components as $id => $component) {
            $this->set($id, $component);
        }
    }

最終組件配置就這樣被注冊到了$this->_definitions里面，后面我們可以通過$this->get($id) 來獲取組件配置

public function set($id, $definition)
    { 
        unset($this->_components[$id]);

        if ($definition === null) {
            unset($this->_definitions[$id]);
            return;
        }

        if (is_object($definition) || is_callable($definition, true)) {
            // an object, a class name, or a PHP callable
            $this->_definitions[$id] = $definition;
        } elseif (is_array($definition)) {
            // a configuration array
            if (isset($definition["class"])) {
                $this->_definitions[$id] = $definition;
            } else {
                throw new InvalidConfigException("The configuration for the "$id" component must contain a "class" element.");
            }
        } else {
            throw new InvalidConfigException("Unexpected configuration type for the "$id" component: " . gettype($definition));
        }

    }

注意這個init，并不是當前類下面的init方法，而是被webapplication 覆蓋

public function init()
    {
        $this->state = self::STATE_INIT;
        $this->bootstrap();
    }

同樣bootstrap方法也被覆蓋

protected function bootstrap()
    {
        $request = $this->getRequest();
        Yii::setAlias("@webroot", dirname($request->getScriptFile()));
        Yii::setAlias("@web", $request->getBaseUrl());

        parent::bootstrap();
    }

看下getRequest是怎么回事，跟蹤代碼，它通過get方法，來從_definitions中獲取request對應(yīng)的配置
然后根據(jù)配置中的yiiwebrequest 來進行創(chuàng)建對象，其中$type 就是配置

public static function createObject($type, array $params = [])
    {
        if (is_string($type)) {
            return static::$container->get($type, $params);
        } elseif (is_array($type) && isset($type["class"])) {
            $class = $type["class"];
            unset($type["class"]);
            return static::$container->get($class, $params, $type); // request 走的是這里
        } elseif (is_callable($type, true)) {
            return static::$container->invoke($type, $params);
        } elseif (is_array($type)) {
            throw new InvalidConfigException("Object configuration must be an array containing a "class" element.");
        }

        throw new InvalidConfigException("Unsupported configuration type: " . gettype($type));
    }

進行完web層的引導(dǎo)之后，繼續(xù)進行base層的引導(dǎo)，包括對配置中bootstrap的引導(dǎo)注冊，會直接通過容器得到實例。（具體不詳）

小結(jié)

在上面的new的過程中，完成了組件的注冊，配置的初始化，并且學到了get是createObject通過依賴注入的方法，獲取組件對象

請求的處理

前面所有的配置和準備都初始化完畢之后，要進行請求處理了。

這一句的run方法，就是處理請求的整個啟動入口

$application->run();

使用handleRequest方法來處理請求，并且參數(shù)是request實例，其中handleRequest方法要看webapplication層的封裝

$response = $this->handleRequest($this->getRequest());

調(diào)用resolve進行解析

list($route, $params) = $request->resolve();

我們再看Urlmanager的時候，發(fā)現(xiàn)里面定義的routeParam是r也就是默認接受參數(shù)的值（重要）
實際上下面這段代碼完成的就是解析了$_GET的值，從里面尋找routeParam 定義的值（r）所代表的內(nèi)容

$result = Yii::$app->getUrlManager()->parseRequest($this);

這里要調(diào)用action方法了

$this->requestedRoute = $route;
$result = $this->runAction($route, $params);

創(chuàng)建控制器+調(diào)用action

實際上runAction中的主要內(nèi)容就是createController的實現(xiàn)：

// parts 分為兩部分，0 是controller的實例，1 是實例里面的方法名稱
$parts = $this->createController($route);
...
...

/* @var $controller Controller */ // 這是一個跟蹤優(yōu)化，不然controller->runaction 就定位不了了
list($controller, $actionID) = $parts;
$oldController = Yii::$app->controller;
Yii::$app->controller = $controller;
$result = $controller->runAction($actionID, $params);

如果遇到了控制器，那么直接返回控制器對象和方法route的名稱，這里route類似于action方法名稱，代碼略微繁瑣，但是很清晰，具體實現(xiàn)就是

路由解析規(guī)則

例如r=site

尋找controller，找到site控制器，直接實例化

例如r=site/index

構(gòu)造控制器，并且id為site、route為index

例如r=site/index/test

發(fā)現(xiàn)沒有找到控制器，那么從模塊中獲取，這里是重新構(gòu)造id為site/index route為test，然后調(diào)用createControllerById 方法來獲取控制器（具體不詳，不過應(yīng)該是通過namespace定位了）

而且createController直接返回了controller的實例

然后我們在createAction中找到解析action方法名稱的代碼
例如r=site/index-test 那么下面對應(yīng)的methodName就是actionIndexTest

$methodName = "action" . str_replace(" ", "", ucwords(implode(" ", explode("-", $id))));

內(nèi)容輸出

將調(diào)用action方法的值，進行返回，然后直接交給yiiwebResponse作為data屬性的一部分。最后調(diào)用send方法，進行輸出。

public function send()
    {
        if ($this->isSent) {
            return;
        }
        $this->trigger(self::EVENT_BEFORE_SEND);
        $this->prepare();
        $this->trigger(self::EVENT_AFTER_PREPARE);
        $this->sendHeaders();
        $this->sendContent();
        $this->trigger(self::EVENT_AFTER_SEND);
        $this->isSent = true;
    }

行為是如何注冊到組件的呢？

通過attacheBehavior注冊行為之后，實際上是添加到了$this的_behaviors屬性中

那么行為中的屬性，就添加到了，_behaviors中

進行直接調(diào)用行為里面的方法的時候，實際上觸發(fā)了yiiaseComponent里面的__call魔術(shù)方法

繼承鏈圖解

END