laravel5.5源碼筆記（四、路由）

今天這篇博文來探索一下laravel的路由。在第一篇講laravel入口文件的博文里，我們就提到過laravel的路由是在application對象的初始化階段，通過provider來載入的。這個路由服務提供者註冊於vendor\laravel\framework\src\Illuminate\Foundation\Application.php的registerBaseServiceProviders方法

protected function registerBaseServiceProviders()
    {
        $this->register(new EventServiceProvider($this));

        $this->register(new LogServiceProvider($this));

        $this->register(new RoutingServiceProvider($this));
    }

可以看到這個方法對路由provider進行了註冊，我們最開始的博文也提到過，這個register方法實際上是運行了provider內部的register方法，現在來看一下這個provider都提供了些什麼vendor\laravel\framework\src\Illuminate\Routing\RoutingServiceProvider.php

    public function register()
    {
        $this->registerRouter();

        $this->registerUrlGenerator();

        $this->registerRedirector();

        $this->registerPsrRequest();

        $this->registerPsrResponse();

        $this->registerResponseFactory();

        $this->registerControllerDispatcher();
    }

 這個服務提供者類中將許多對象都添加到了laravel的容器中，其中最重要的就是第一個註冊的Router類了。Router中包含了我們寫在路由文件中的get、post等各種方法，我們在路由文件中所使用的Route::any()方法也是一個門面類，它所代理的對象便是Router。

看過了路由的初始化，再來看一下我們在路由文件中所書寫的路由是在什麼時候載入到系統中的。在config/app.php文件中的privders數組中有一個名為RouteServiceProvider的服務提供者會跟隨laravel系統在載入配置的時候一起載入。這個文件位於\app\Providers\RouteServiceProvider.php剛剛的Routing對路由服務進行了註冊，這裡的RouteServiceProvider就要通過剛剛載入的系統類來載入我們寫在routes路由文件夾中的路由了。

至於這個provider是何時開始啟動的，還記得我們第一篇博客中介紹的Illuminate\Foundation\Bootstrap\BootProviders這個provider嗎？這個provider在註冊時便會將已經註冊過的provider，通過application中的boot方法，轉發到它們自身的boot方法來啟動了。

而RouteServiceProvider這個類的boot方法通過它父類boot方法繞了一圈後又運行了自己的mapWebRoutes方法。

//Illuminate\Foundation\Support\Providers\RouteServiceProvider.php

public function boot()
    {
        //設置路由中控制器的命名空間
        $this->setRootControllerNamespace();
        //若路由已有緩存則載入緩存
        if ($this->app->routesAreCached()) {
            $this->loadCachedRoutes();
        } else {
            //這個方法啟動了子類中的map方法來載入路由
            $this->loadRoutes();

            $this->app->booted(function () {
                $this->app['router']->getRoutes()->refreshNameLookups();
                $this->app['router']->getRoutes()->refreshActionLookups();
            });
        }
    }

    protected function loadRoutes()
    {
        if (method_exists($this, 'map')) {
            //這裡又把視線拉回了子類，執行了子類中的map方法
            $this->app->call([$this, 'map']);
        }
    }    

這裡這個mapWebRoutes方法有點繞，它先是通過門面類將Route變成了Router對象，接著又調用了Router中不存在的方法middleware，通過php的魔術方法__call將執行對象變成了RouteRegistrar對象(\Illuminate\Routing\RouteRegistrar.php)在第三句調用group方法時，又將路由文件的地址傳入了Router方法的group方法中。

    protected function mapWebRoutes()
    {
        //這裡的route門面指向依舊是router，middleware方法通過__call重載將對象指向了RouteRegistrar對象
        Route::middleware('web')
            //RouteRegistrar對象也載入了命名空間
             ->namespace($this->namespace)
            //這裡RouteRegistrar對象中的group方法又將對象方法指向了Router中的group方法
             ->group(base_path('routes/web.php'));
    }

//Router類

    public function __call($method, $parameters)
    {
        if (static::hasMacro($method)) {
            return $this->macroCall($method, $parameters);
        }
        //在這裡通過重載實例化對象
        if ($method == 'middleware') {
            return (new RouteRegistrar($this))->attribute($method, is_array($parameters[0]) ? $parameters[0] : $parameters);
        }

        return (new RouteRegistrar($this))->attribute($method, $parameters[0]);
    }

//\Illuminate\Routing\RouteRegistrar.php
    public function group($callback)
    {
        $this->router->group($this->attributes, $callback);
    }

//Router類
    public function group(array $attributes, $routes)
    {
        //更新路由棧這個數組
        $this->updateGroupStack($attributes);

        // Once we have updated the group stack, we'll load the provided routes and
        // merge in the group's attributes when the routes are created. After we
        // have created the routes, we will pop the attributes off the stack.
        $this->loadRoutes($routes);
        //出棧
        array_pop($this->groupStack);
    }

    protected function loadRoutes($routes)
    {
        //這裡判斷閉包是因為laravel的路由文件中也允許我們使用group對路由進行分組
        if ($routes instanceof Closure) {
            $routes($this);
        } else {
            $router = $this;
            //傳入的$routes是一個文件路徑，在這裡將其引入執行，在這裡就開始一條一條的導入路由了
            require $routes;
        }
    }

繞了這麼一大圈終於把寫在routes文件夾中的路由文件載入進laravel系統了。接下來的操作就比較簡單了。

先來看一下我的路由文件中寫了些什麼。

路由文件中只寫了兩個路由，在Route載入後通過dd(app()->router);列印出來看一下吧。