Laravel 執行原理分析與原始碼分析,底層看這篇足矣

Laravel00發表於2021-02-23
Laravel原始碼

一、執行原理概述

laravel的入口檔案 index.php

1、引入自動載入 autoload.php
2、建立應用例項，並同時完成了

基本繫結($this、容器類Container等等)、

基本服務提供者的註冊（Event、log、routing）、

核心類別名的註冊(比如db、auth、config、router等)

3、開始Http請求的處理
make方法從容器中解析指定的值為實際的類，比如$app->make(Illuminate\Contracts\Http\Kernel::class) 解析出 App\Http\Http.php handle方法對http請求進行處理

實際上是handle中的sendRequestThroughRouter處理的http請求

首先，將request繫結到共享例項

然後執行bootstarp方法，執行給定的引導類陣列$bootstrappers，這裡很關鍵，包括了載入配置檔案、環境變數、服務提供者（config/app.php中的providers）、門面、異常處理、引導提供者

之後，進入管道模式，經過中介軟體的處理過濾後，再進行使用者請求的分發

在請求分發時，首先，查詢與給定請求匹配的路由，然後執行runRoute方法，實際處理請求的是runRoute 方法中的runRouteWithinStack

然後，經過runRouteWithinStack中的run方法，將請求分配到實際的控制器中，並得到響應結果

4、將處理結果返回

 
 

二、詳細原始碼分析

1、註冊自動載入器，實現檔案的自動載入

require __dir__.'/../vendor/autoload.php';

2、建立應用容器例項Application（該例項繼承自容器類Container）,並繫結核心（web、命令列、異常），以便在需要時解析它們

$app = require_once __DIR__.'/../bootstrap/app.php';

app.php檔案如下：

<?php
// 建立Laravel例項 【3】
$app = new Illuminate\Foundation\Application(
    $_ENV['APP_BASE_PATH'] ?? dirname(__DIR__)
);
// 繫結Web端kernel
$app->singleton(
    Illuminate\Contracts\Http\Kernel::class,
    App\Http\Kernel::class
);
// 繫結命令列kernel
$app->singleton(
    Illuminate\Contracts\Console\Kernel::class,
    App\Console\Kernel::class
);
// 繫結異常處理kernel
$app->singleton(
    Illuminate\Contracts\Debug\ExceptionHandler::class,
    App\Exceptions\Handler::class
);
// 返回應用例項
return $app;

3、在建立應用例項（Application.php）的建構函式中，將基本繫結註冊到容器中，並註冊了所有的基本服務提供者，以及在容器中註冊核心類別名

public function __construct($basePath = null)
{   
    // 將基本繫結註冊到容器中【3.1】
    $this->registerBaseBindings();
    // 註冊所有基本服務提供者【3.2】
    $this->registerBaseServiceProviders();
    // 在容器中註冊核心類別名【3.3】
    $this->registerCoreContainerAliases();
}

3.1、將基本繫結註冊到容器中

 static::setInstance($this);
 $this->instance('app', $this);
 $this->instance(Container::class, $this);
 $this->singleton(Mix::class);
 $this->instance(PackageManifest::class, new PackageManifest(
     new Filesystem, $this->basePath(), $this->getCachedPackagesPath()
 ));
 # 注：instance方法為將...註冊為共享例項，singleton方法為將...註冊為共享繫結

3.2、註冊所有基本服務提供者(事件、日誌、路由)

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

3.3、在容器中註冊核心類別名

4、上面完成了類的自動載入、服務提供者註冊、核心類的繫結、以及基本註冊的繫結　
5、開始解析http請求

index.php
// 5.1
$kernel = $app->make(Illuminate\Contracts\Http\Kernel::class);
// 5.2
$response = $kernel->handle(
    $request = Illuminate\Http\Request::capture()
);

5.1 make方法是從容器解析給定值

$kernel = $app->make(Illuminate\Contracts\Http\Kernel::class);

中的Illuminate\Contracts\Http\Kernel::class 是在index.php 中的$app = require_once __DIR__.'/../bootstrap/app.php';這裡面進行繫結的，實際指向的就是App\Http\Kernel::class這個類

5.2 這裡對http請求進行處理

$response = $kernel->handle(
    $request = Illuminate\Http\Request::capture()
);

進入$kernel所代表的類App\Http\Kernel.php中，我們可以看到其實裡面只是定義了一些中介軟體相關的內容，並沒有handle方法

我們再到它的父類use Illuminate\Foundation\Http\Kernel as HttpKernel;中找handle方法，可以看到handle方法是這樣的

public function handle($request)
{
    try {
        // 方法欺騙，不用關注這裡
        $request->enableHttpMethodParameterOverride();
        // 最核心的處理http請求的地方【6】
        $response = $this->sendRequestThroughRouter($request);
    } catch (Exception $e) {
        $this->reportException($e);
        $response = $this->renderException($request, $e);
    } catch (Throwable $e) {
        $this->reportException($e = new FatalThrowableError($e));
        $response = $this->renderException($request, $e);
    }
    $this->app['events']->dispatch(
        new Events\RequestHandled($request, $response)
    );
    return $response;
}

6、處理http請求（將request繫結到共享例項，並使用管道模式處理使用者請求）

vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php的handle方法
// 最核心的處理http請求的地方
$response = $this->sendRequestThroughRouter($request);

進入sendRequestThroughRouter方法

protected function sendRequestThroughRouter($request)
{
    // 將請求$request繫結到共享例項
    $this->app->instance('request', $request);
    // 將請求request從已解析的門面例項中清除（因為已經繫結到共享例項中了，沒必要再浪費資源了）
    Facade::clearResolvedInstance('request');
    // 引導應用程式進行HTTP請求
    $this->bootstrap();【7、8】
    // 進入管道模式，經過中介軟體，然後處理使用者的請求【9、10】
    return (new Pipeline($this->app))
                ->send($request)
                ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
                ->then($this->dispatchToRouter());
}

7、在bootstrap方法中，執行給定的引導類陣列$bootstrappers，載入配置檔案、環境變數、服務提供者、門面、異常處理、引導提供者，非常重要的一步
位置在vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php

/**
 * Bootstrap the application for HTTP requests.
 *
 * @return void
 */
public function bootstrap()
{
    if (! $this->app->hasBeenBootstrapped()) {
        $this->app->bootstrapWith($this->bootstrappers());
    }
}
/**
 * 執行給定的引導類陣列
 *
 * @param  string[]  $bootstrappers
 * @return void
 */
public function bootstrapWith(array $bootstrappers)
{
    $this->hasBeenBootstrapped = true;
    foreach ($bootstrappers as $bootstrapper) {
        $this['events']->dispatch('bootstrapping: '.$bootstrapper, [$this]);
        $this->make($bootstrapper)->bootstrap($this);
        $this['events']->dispatch('bootstrapped: '.$bootstrapper, [$this]);
    }
}
/**
 * Get the bootstrap classes for the application.
 *
 * @return array
 */
protected function bootstrappers()
{
    return $this->bootstrappers;
}
/**
 * 應用程式的引導類
 *
 * @var array
 */
protected $bootstrappers = [
    // 載入環境變數
    \Illuminate\Foundation\Bootstrap\LoadEnvironmentVariables::class,
    // 載入config配置檔案【重點】
    \Illuminate\Foundation\Bootstrap\LoadConfiguration::class,
    // 載入異常處理
    \Illuminate\Foundation\Bootstrap\HandleExceptions::class,
    // 載入門面註冊
    \Illuminate\Foundation\Bootstrap\RegisterFacades::class,
    // 載入在config/app.php中的providers陣列裡所定義的服務【8 重點】
    \Illuminate\Foundation\Bootstrap\RegisterProviders::class,
    // 記載引導提供者
    \Illuminate\Foundation\Bootstrap\BootProviders::class,
];

8、載入config/app.php中的providers陣列裡所定義的服務

Illuminate\Auth\AuthServiceProvider::class,
Illuminate\Broadcasting\BroadcastServiceProvider::class,
Illuminate\Bus\BusServiceProvider::class,
Illuminate\Cache\CacheServiceProvider::class,
Illuminate\Foundation\Providers\ConsoleSupportServiceProvider::class,
Illuminate\Cookie\CookieServiceProvider::class,
Illuminate\Database\DatabaseServiceProvider::class,
Illuminate\Encryption\EncryptionServiceProvider::class,
Illuminate\Filesystem\FilesystemServiceProvider::class,
Illuminate\Foundation\Providers\FoundationServiceProvider::class,
Illuminate\Hashing\HashServiceProvider::class,
Illuminate\Mail\MailServiceProvider::class,
Illuminate\Notifications\NotificationServiceProvider::class,
Illuminate\Pagination\PaginationServiceProvider::class,
Illuminate\Pipeline\PipelineServiceProvider::class,
Illuminate\Queue\QueueServiceProvider::class,
Illuminate\Redis\RedisServiceProvider::class,
Illuminate\Auth\Passwords\PasswordResetServiceProvider::class,
Illuminate\Session\SessionServiceProvider::class,
Illuminate\Translation\TranslationServiceProvider::class,
Illuminate\Validation\ValidationServiceProvider::class,
Illuminate\View\ViewServiceProvider::class,
App\Providers\AppServiceProvider::class,
App\Providers\AuthServiceProvider::class,
App\Providers\EventServiceProvider::class,
App\Providers\RouteServiceProvider::class,
/**
 * 自己新增的服務提供者
 */
\App\Providers\HelperServiceProvider::class,

可以看到，關於常用的 Redis、session、queue、auth、database、Route 等服務都是在這裡進行載入的

　

9、使用管道模式處理使用者請求，先經過中介軟體進行處理

return (new Pipeline($this->app))
    ->send($request)
    // 如果沒有為程式禁用中介軟體，則載入中介軟體（位置在app/Http/Kernel.php的$middleware屬性）
    ->through($this->app->shouldSkipMiddleware() ? [] : $this->middleware)
    ->then($this->dispatchToRouter());
}

app/Http/Kernel.php

/**
 * 應用程式的全域性HTTP中介軟體
 *
 * These middleware are run during every request to your application.
 *
 * @var array
 */
protected $middleware = [
    \App\Http\Middleware\TrustProxies::class,
    \App\Http\Middleware\CheckForMaintenanceMode::class,
    \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
    \App\Http\Middleware\TrimStrings::class,
    \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
];

10、經過中介軟體處理後，再進行請求分發（包括查詢匹配路由）

/**
 * 10.1 通過中介軟體/路由器傳送給定的請求
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Http\Response
 */
 protected function sendRequestThroughRouter($request)
{
    ...
    return (new Pipeline($this->app))
        ...
        // 進行請求分發
        ->then($this->dispatchToRouter());
}
/**
 * 10.2 獲取路由排程程式回撥
 *
 * @return \Closure
 */
protected function dispatchToRouter()
{
    return function ($request) {
        $this->app->instance('request', $request);
        // 將請求傳送到應用程式
        return $this->router->dispatch($request);
    };
}
/**
 * 10.3 將請求傳送到應用程式
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
 */
 public function dispatch(Request $request)
{
    $this->currentRequest = $request;
    return $this->dispatchToRoute($request);
}
 /**
 * 10.4 將請求分派到路由並返回響應【重點在runRoute方法】
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
 */
public function dispatchToRoute(Request $request)
{   
    // 
    return $this->runRoute($request, $this->findRoute($request));
}
/**
 * 10.5 查詢與給定請求匹配的路由
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Routing\Route
 */
protected function findRoute($request)
{
    $this->current = $route = $this->routes->match($request);
    $this->container->instance(Route::class, $route);
    return $route;
}
/**
 * 10.6 查詢與給定請求匹配的第一條路由
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Routing\Route
 *
 * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
 */
public function match(Request $request)
{
    // 獲取使用者的請求型別（get、post、delete、put），然後根據請求型別選擇對應的路由
    $routes = $this->get($request->getMethod());
    // 匹配路由
    $route = $this->matchAgainstRoutes($routes, $request);
    if (! is_null($route)) {
        return $route->bind($request);
    }
    $others = $this->checkForAlternateVerbs($request);
    if (count($others) > 0) {
        return $this->getRouteForMethods($request, $others);
    }
    throw new NotFoundHttpException;
}

到現在，已經找到與請求相匹配的路由了，之後將執行了，也就是10.4 中的runRoute 方法

/**
 * 10.4 將請求分派到路由並返回響應
 *
 * @param  \Illuminate\Http\Request  $request
 * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
 */
public function dispatchToRoute(Request $request)
{   
    return $this->runRoute($request, $this->findRoute($request));
}
/**
 * 10.7 返回給定路線的響應
 *
 * @param  \Illuminate\Http\Request  $request
 * @param  \Illuminate\Routing\Route  $route
 * @return \Illuminate\Http\Response|\Illuminate\Http\JsonResponse
 */
protected function runRoute(Request $request, Route $route)
{
    $request->setRouteResolver(function () use ($route) {
        return $route;
    });
    $this->events->dispatch(new Events\RouteMatched($route, $request));
    return $this->prepareResponse($request,
        $this->runRouteWithinStack($route, $request)
    );
}
/**
 * Run the given route within a Stack "onion" instance.
 * 10.8 在棧中執行路由
 *
 * @param  \Illuminate\Routing\Route  $route
 * @param  \Illuminate\Http\Request  $request
 * @return mixed
 */
protected function runRouteWithinStack(Route $route, Request $request)
{
    $shouldSkipMiddleware = $this->container->bound('middleware.disable') &&
                            $this->container->make('middleware.disable') === true;
    $middleware = $shouldSkipMiddleware ? [] : $this->gatherRouteMiddleware($route);
    return (new Pipeline($this->container))
        ->send($request)
        ->through($middleware)
        ->then(function ($request) use ($route) {
            return $this->prepareResponse(
                $request, $route->run()
            );
        });
}

11、執行路由並返回響應[重點]
可以看到，10.7 中有一個方法是prepareResponse，該方法是從給定值建立響應例項，而 runRouteWithinStack 方法則是在棧中執行路由，也就是說，http的請求和響應都將在這裡完成。

 
 
文章來源：www.haveyb.com/article/298
好記性不如爛筆頭，學習php開發也不能懶，作筆記是一種學習的好習慣！
Laravel筆記

本作品採用《CC 協議》，轉載必須註明作者和本文連結

相關文章