ThinkPHP6 原始碼閱讀(三):應用程式初始化

tsin 發表於2019-08-13
PHP

runWithRequest()方法

Http類的run()方法中,得到think\Request類的例項後,程式接著執行$response = $this->runWithRequest($request);。其中,runWithRequest()方法前面幾行如下:

protected function runWithRequest(Request $request)
{
    $this->initialize();

    // 載入全域性中介軟體
    if (is_file($this->app->getBasePath() . 'middleware.php')) {
        $this->app->middleware->import(include $this->app->getBasePath() . 'middleware.php');
    }
.
.
.

該方法第一行執行$this->initialize();,對應用進行初始化,接下來詳細分析這一初始化操作。

Http類的initialize()方法:

protected function initialize()
{
    //如果還未初始化,則初始化之
    if (!$this->app->initialized()) {
        $this->app->initialize();
    }
}

實際上是呼叫App類的initialize()方法。該方法程式碼:

public function initialize()
{
    // 設定應用狀態為已經初始化
    $this->initialized = true;

    //記錄開始時間
    $this->beginTime = microtime(true);
    //記錄起始記憶體使用量
    $this->beginMem  = memory_get_usage();

    // ==( A )== 載入環境變數
    // $this->env跟前面的(new App())->http和$this->config都是同樣的套路
    if (is_file($this->rootPath . '.env')) {
        $this->env->load($this->rootPath . '.env');
    }
    //設定配置檔案字尾
    //這裡有個問題是,每次呼叫$this->env,都會重新例項化一次,
    //環境變數會改變,可能這種每次例項化是必要的
    $this->configExt = $this->env->get('config_ext', '.php');
    // ==( B )== 設定除錯模式
    $this->debugModeInit();

    // ==( C )== 載入應用檔案和配置等操作
    $this->load();

    // 載入框架預設語言包
    $langSet = $this->lang->defaultLangSet();
    // 框架目錄下對應的語言包
    // 比如:D:\dev\tp6\vendor\topthink\framework\src\lang\zh-cn.php
    $this->lang->load($this->thinkPath . 'lang' . DIRECTORY_SEPARATOR . $langSet . '.php');

    // 載入應用預設語言包
    // 這個會掃描「app/lang」裡面,對應語言包資料夾的所有「.php」檔案
    // 比如,app/lang/zh-cn/* 下的所有檔案
    // 然後載入解析
    $this->loadLangPack($langSet);

    // 監聽AppInit
    $this->event->trigger('AppInit');

    // 設定時區
    date_default_timezone_set($this->config->get('app.default_timezone', 'Asia/Shanghai'));

    // ==( D )== 初始化
    // 初始化錯誤和異常處理、註冊系統服務和初始化系統服務
    foreach ($this->initializers as $initializer) {
        $this->make($initializer)->init($this);
    }

    return $this;
}

應用的初始化做了大量的操作,其主要的操作有:載入環境變數、載入配置檔案,載入語言包、監聽AppInit、initializers陣列包含的類的初始化。

(A) 載入環境變數

對應語句:$this->env->load($this->rootPath . '.env');,其中,$this->env,與前面的(new App())->http原理是一樣的(參見第一篇),它可以取得\think\Env類的例項。取得Env類例項後,呼叫load()方法,傳入的引數是.env檔案所在地址。load()方法實現如下:

public function load(string $file): void
{
    $env = parse_ini_file($file, true) ?: [];
    $this->set($env);
}

該方法讀取.env檔案的值後,呼叫set()方法,將配置儲存在Env類的$data成員變數。set()方法程式碼:

public function set($env, $value = null): void
{
    if (is_array($env)) {
        //全部KEY轉為大寫字母
        $env = array_change_key_case($env, CASE_UPPER);

        foreach ($env as $key => $val) {
            //有二級配置的,轉為KEY1_KEY2 => $v 的形式
            if (is_array($val)) {
                foreach ($val as $k => $v) {
                    $this->data[$key . '_' . strtoupper($k)] = $v;
                }
            } else {
                $this->data[$key] = $val;
            }
        }
        //ENV的值不是陣列的情況
    } else {
        $name = strtoupper(str_replace('.', '_', $env));

        $this->data[$name] = $value;
    }
}

.env讀取到的值大概是這樣的:

ThinkPHP6 原始碼閱讀(三):應用程式初始化

$this->set($env)之後得到的大概是這樣的:

ThinkPHP6 原始碼閱讀(三):應用程式初始化

(B) 除錯模式設定

$this->debugModeInit()執行原理詳見註釋。

protected function debugModeInit(): void
{
    // 應用除錯模式
    // 「$appDebug」預設為false
    // 沒有發現別的地方修改了「$appDebug」,程式好像永遠關閉除錯模式
    // 這應該是一個Bug
    // 正確的做法應該是先從Env類獲取「app_debug」的值來判斷是否是除錯模式
    if (!$this->appDebug) {
        $this->appDebug = $this->env->get('app_debug') ? true : false;
        // 關閉錯誤顯示
        ini_set('display_errors', 'Off');
    }
    // 如果不是命令列模式
    if (!$this->runningInConsole()) {
        // 重新申請一塊比較大的buffer
        // php緩衝控制
        // 參考:https://www.php.net/manual/en/ref.outcontrol.php
        // https://www.cnblogs.com/saw2012/archive/2013/01/30/2882451.html
        // 新版PHP預設開啟緩衝區ob_start(),ob_get_level() == 1
        if (ob_get_level() > 0) {
            // 相當於ob_get_contents() 和 ob_clean()
            // 獲取緩衝區內容並刪除緩衝區內容
            $output = ob_get_clean();
        }
        // 開啟新的緩衝區控制
        ob_start();
        if (!empty($output)) {
            // 由於開啟了新的緩衝區控制,
            // 這裡不會直接輸出$output
            // 而是等到依次執行了ob_flush()和flash()之後才將內容輸出到瀏覽器
            echo $output;
        }
    }
}

需要注意的是,這裡貌似有個Bug,應該先執行$this->appDebug = $this->env->get('app_debug') ? true : false;獲取是否是除錯模式的配置,然後再判斷:if (!$this->appDebug)

(C) 載入應用檔案和配置等操作

接下來執行$this->load();,「load」方法具體實現如下:

protected function load(): void
{
    $appPath = $this->getAppPath();

    // 載入「app」目錄下的「common.php」檔案
    if (is_file($appPath . 'common.php')) {
        include_once $appPath . 'common.php';
    }
    // 載入核心目錄下的「helper.php」檔案
    // 可以看到,這裡的載入順序:先「common.php」,後「helper.php」
    // 且「helper.php」中的函式包裹在「if (!function_exists('abort'))」下
    // 所以可以在「common.php」檔案中覆蓋系統定義的助手函式
    include_once $this->thinkPath . 'helper.php';

    $configPath = $this->getConfigPath();

    $files = [];

    // glob的作用是掃描給定路徑模式下的檔案,非常好用
    // 這裡掃描「config」目錄下的所有「.php」檔案
    if (is_dir($configPath)) {
        $files = glob($configPath . '*' . $this->configExt);
    }

    foreach ($files as $file) {
        // $this->config 還是同樣的套路獲得了「Config」類的例項
        // 「load」的第二個引數為一級配置名,這裡傳入一個檔名,所有檔名作為一級配置
        // 比如「app.php」配置檔案,一級配置為「app」
        // 在 「Config」類作用域下的操作:
        // 「load」載入檔案後,通過「parse」方法解析檔案內容
        // 最後,通過「set」方法將所有配置合併了「config」成員變數
        $this->config->load($file, pathinfo($file, PATHINFO_FILENAME));
    }

    // 載入「app」目錄下的「event.php」檔案
    if (is_file($appPath . 'event.php')) {
        $this->loadEvent(include $appPath . 'event.php');
    }
    // 註冊自定義的服務
    if (is_file($appPath . 'service.php')) {
        $services = include $appPath . 'service.php';
        foreach ($services as $service) {
            $this->register($service);
        }
    }
}

值得一提的是,程式先載入「common.php」,後載入「helper.php」,而「helper.php」中的函式包裹在「if (!function_exists('abort'))」下,所以我們如果有需要,可以在「common.php」檔案中覆蓋系統定義的助手函式。

除了載入這兩個檔案,該方法還掃描了「config」目錄下的所有配置檔案,並將其載入到Config類的$config成員變數,載入了「app」目錄下的「event.php」檔案,以及載入並註冊自定義的服務。

(D) 初始化錯誤和異常處理、註冊系統服務和初始化系統服務

接著,看初始化函式的最後一段:

foreach ($this->initializers as $initializer) {
    $this->make($initializer)->init($this);
}

這幾行程式碼做了比較多的操作:分別例項化包含在裡面的類,然後呼叫其「init」方法。initializers陣列的值如下:

protected $initializers = [
    Error::class,  //錯誤處理類
    RegisterService::class, //註冊系統服務類
    BootService::class,  //啟動系統服務
];

略過系統錯誤處理類,先看註冊系統服務類。值得注意的是,這個類有一個成員變數:

protected $services = [
    PaginatorService::class,
    ValidateService::class,
    ModelService::class,
];

包含了三個系統核心服務。在其init方法中,這些服務被註冊到系統服務,與前面的自定義服務合併起來,其主要實現程式碼:

foreach ($services as $service) {
    if (class_exists($service)) {
        // 註冊到系統服務
        $app->register($service);
    }
}

最後例項化的是啟動系統服務類,該類的init方法僅呼叫了App類的boot方法,該方法的作用是初始化每個系統服務,也就是呼叫每個服務的boot方法。
啟動系統服務類實現如下:

class BootService
{
    public function init(App $app)
    {
        $app->boot();
    }
}

App類的boot方法:

public function boot(): void
{
    array_walk($this->services, function ($service) {
        $this->bootService($service);
    });
}

其中關鍵是bootService方法:

public function bootService($service)
{
    if (method_exists($service, 'boot')) {
        return $this->invoke([$service, 'boot']);
    }
}

該方法分別呼叫了每個服務的boot方法,從而初始化已註冊的服務。

從以上程式碼可以看到,系統註冊的服務的來源有三個地方:1. 系統自帶的,如PaginatorServiceValidateServiceModelService;2. app目錄下,在「service.php」檔案中自定義的;3. vendor目錄下的「service.php」檔案定義的。

初始化之後,「App」類的例項大概是這樣子的:

ThinkPHP6 原始碼閱讀(三):應用程式初始化

Was mich nicht umbringt, macht mich stärker