2. 程式人生 > >laravel框架原始碼分析（一）自動載入

laravel框架原始碼分析（一）自動載入

阿新 • • 發佈：2018-12-08

一、前言

　　使用php已有好幾年，laravel的使用也是有好長時間，但是一直對於框架原始碼的理解不深，原因很多，歸根到底還是php基礎不紮實，所以原始碼看起來也比較吃力。最近有時間，所以開啟第5、6遍的框架原始碼探索之旅，前面幾次都是看了一些就放棄，希望這次能夠看完。每一次看原始碼都會有新的收穫，因為框架用到的一些設計模式、高階特性，在平時的業務需求裡面根本用不到，或者說專案前期就把需要用到高階特性的地方都做好了，業務需求也就用到mvc。

　　本文及後續的“laravel框架原始碼分析“文章都是基於laravel框架5.7.16版本。“自動載入”是laravel框架啟動後做的第一件事，這裡要求對__autolad()、spl_autoload()、spl_autoload_register()等方法至少有初步瞭解。

二、自動載入的分析

1、先看下框架入口檔案index.php： 

<?php

define('LARAVEL_START', microtime(true));

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

... ...

 

2、require 載入 autoload.php檔案：

<?php

require_once __DIR__ . '/composer/autoload_real.php';

return ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3::getLoader();

【備註】：

1）ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3 這個類是在 autoload_real.php 檔案中定義的

2）ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3 這個類名是由 ComposerAutoloaderInit 加上雜湊值組成，如果你在你的專案中開啟這個檔案，你會看到你檔案中這個雜湊值跟我這裡的不一樣，這個是正常的。

參考了網上的資料，這麼做可能原因是：如果直接用ComposerAutoloaderInit，因為是全域性的一個類，怕會被開發人員自己寫的一個同名的類給覆蓋導致報錯。這是從網上查來的資訊，也不確定是不是就是這個原因，這裡可以不需要深究。

 

3、來看下 autoload_real.php 檔案：

<?php

// autoload_real.php @generated by Composer

class ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3
{
    private static $loader;

    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }

    public static function getLoader()
    {
        /*
         * 載入器最開始是null，後面例項化後是一個靜態變數會一直存在
         */
        if (null !== self::$loader) {
            return self::$loader;
        }

        /*
         * 註冊一個自動載入函式，就是本類鐘的 loadClassLoader 方法
         * 第二個引數為true表示註冊失敗的時候會丟擲異常
         * 第三個引數為true表示該自動載入函式是加入到佇列的頭部，自動載入函式是有很多的，可以認為是一個佇列，預設false值是往隊尾新增
         * 載入類的時候，會先從隊頭的自動載入函式去尋找類和例項化，這裡是true，就是作為第一個去執行的自動載入函式。
         */
        spl_autoload_register(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'), true, true);

        /*
         * 當前檔案中並沒有require下面這個ClassLoader類，那麼就剛好用到上面註冊的一個自動載入函式
         * 相當於是 require __DIR__ . '/ClassLoader.php'
         */
        self::$loader = $loader = new \Composer\Autoload\ClassLoader();

        /*
         * 註釋掉剛剛註冊的自動載入函式，因為這個自動載入函式只是對上面new的這個類有用。意思是當前類的自動載入函式對其他類不起作用，所以沒必要一直放在佇列中
         */
        spl_autoload_unregister(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'));

        /*
         * PHP_VERSION_ID 版本號，可以使用php artisan -V命令檢視，當前版本是5.7.16
         * HHVM_VERSION 是Facebook 的一個為php提高效能的一個開源專案，參考http://fex.baidu.com/blog/2014/03/hvvm-and-php
         * zend_loader_file_encoded 不清楚是啥東西
         *
         * $useStaticLoader 這個為true的話，是直接就載入autoload_static.php檔案，然後返回預定義的變數的值，比如files資訊，後續要預載入
         * 為false的話，會載入幾個php檔案，載入後的結果和直接載入autoload_statis.php的效果應該是一樣的
         * 就是說如果有autoload_static.php檔案，直接載入就好了，會更加快速
         * $useStaticLoader 就是根據條件來判斷是要靜態載入還是普通載入。兩者的結果是一致的。
         */
        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
        if ($useStaticLoader) {
            // 靜態載入
            require_once __DIR__ . '/autoload_static.php';
            /**
             * 返回files等資訊，是在ClassLoader.php中定義的屬性的值
             */
            call_user_func(\Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::getInitializer($loader));
        } else {
            $map = require __DIR__ . '/autoload_namespaces.php';
            foreach ($map as $namespace => $path) {
                $loader->set($namespace, $path);
            }

            $map = require __DIR__ . '/autoload_psr4.php';
            foreach ($map as $namespace => $path) {
                $loader->setPsr4($namespace, $path);
            }

            $classMap = require __DIR__ . '/autoload_classmap.php';
            if ($classMap) {
                $loader->addClassMap($classMap);
            }
        }

        /*
         * 預載入loader
         */
        $loader->register(true);

        /*
         * 要預載入的檔案
         */
        if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }
        foreach ($includeFiles as $fileIdentifier => $file) {
            composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file);
        }

        return $loader;
    }
}

/*
 * 預載入檔案
 */
function composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;

        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
    }
}

【備註】我在上面加了我的理解，原始碼裡面是沒這些中文註釋的。

【說明】：

1）在上面第2點裡面是return 類名::getLoader()，所以我們來看這個getLoader()方法

if (null !== self::$loader) {
	return self::$loader;
}

這裡是先判斷$loader靜態變數是否已經設定了，如果設定了的話，直接就返回了，不往下處理。一開始這個變數是null，所以會往下執行。

 

2）註冊自動載入函式

spl_autoload_register(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'), true, true);

這一行程式碼的意思是註冊一個自動載入函式，並且放在註冊函式佇列的第一位，如果註冊失敗則丟擲異常。這裡如果不能理解，請看下spl_autoload_register相關方法。

註冊的自動載入函式是array裡面的，也就是當前類裡面的 loadClassLoader 方法：

    public static function loadClassLoader($class)
    {
        if ('Composer\Autoload\ClassLoader' === $class) {
            require __DIR__ . '/ClassLoader.php';
        }
    }　　

這裡的意思是如果new一個類的時候，找不到類定義的檔案，那麼會在autoload函式佇列裡面去找，比如這裡剛剛把loadClassLoader方法註冊為自動載入函式，而且是第一位。

 

3）例項化loader

self::$loader = $loader = new \Composer\Autoload\ClassLoader();

spl_autoload_unregister(array('ComposerAutoloaderInitf41aabc2816e3446178e95b11b3e78f3', 'loadClassLoader'));

第一行程式碼是new一個類，因為當前檔案並沒有直接require或者include，就是沒有載入該類的定義檔案，所以找不到該類，這個時候就從自動載入函式裡面去載入，看能否載入該類。

因為loadClassLoader這個自動載入函式是在佇列的第一位，所以先執行這個自動載入函式。從上面的程式碼看出，實際上就是 require __DIR__ . '/ClassLoader.php';

但是為何搞這麼複雜，不直接require，而是要通過註冊自動載入函式呢？ 這個原因後續再說。

那麼第一行的意思就是require一個檔案，第二行程式碼是登出掉剛剛註冊的這個自動載入函式，因為這個自動載入函式只對本來有效，其他類不會用到，所以沒有必要一直放在佇列裡。

 

4）判斷是靜態載入檔案還是普通載入：

        /*
         * PHP_VERSION_ID 版本號，可以使用php artisan -V命令檢視，當前版本是5.7.16
         * HHVM_VERSION 是Facebook 的一個為php提高效能的一個開源專案，參考http://fex.baidu.com/blog/2014/03/hvvm-and-php
         * zend_loader_file_encoded 不清楚是啥東西
         *
         * $useStaticLoader 這個為true的話，是直接就載入autoload_static.php檔案，然後返回預定義的變數的值，比如files資訊，後續要預載入
         * 為false的話，會載入幾個php檔案，載入後的結果和直接載入autoload_statis.php的效果應該是一樣的
         * 就是說如果有autoload_static.php檔案，直接載入就好了，會更加快速
         * $useStaticLoader 就是根據條件來判斷是要靜態載入還是普通載入。兩者的結果是一致的。
         */
        $useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());　　

這裡是各種條件的判斷，$useStaticLoader為true則是靜態載入，為false則是普通載入。

 

5）靜態載入

require_once __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::getInitializer($loader));　　

首先是載入autoload_static.php檔案，然後呼叫該檔案定義的類的getInitializer方法，並且把剛剛例項化的$loader作為引數傳遞過去。

來看下這個getInitializer方法：

    public static function getInitializer(ClassLoader $loader)
    {
        /*
         * Closure::bind 繫結一個匿名函式到一個物件，參考：http://php.net/manual/zh/closure.bind.php
         * Closure::bind 這個方法返回值就是繫結的這個匿名函式。這裡$loader是ClassLoader的一個例項
         * 為何以這種方式來設定$loader的屬性呢？原因是這幾個屬性都是private，而現在把匿名函式（bind中定義的匿名函式）繫結到
         * ClassLoader類，也就是$loader的一個方法，那麼就可以直接設定內部私有的屬性（成員變數）
         * 可以這麼理解：
         * 1）function A(ClassLoader $loader)
         * {
         *      $loader->屬性 = ....
         * }
         * 2) 繫結function A 到 ClassLoader類
         * 3) return A(); 那麼也就是這個時候，把$loader的各個成員屬性的值都設定了
         */
        return \Closure::bind(function () use ($loader) {
            $loader->prefixLengthsPsr4 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$prefixLengthsPsr4;
            $loader->prefixDirsPsr4 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$prefixDirsPsr4;
            $loader->fallbackDirsPsr4 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$fallbackDirsPsr4;
            $loader->prefixesPsr0 = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$prefixesPsr0;
            $loader->classMap = ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$classMap;
        }, null, ClassLoader::class);
    }　　

這裡的意思是把autoload_static.php檔案中定義好的一些變數賦值給$loader物件。

 

6）普通載入

普通載入和靜態載入的過程不一樣，但是結果是一樣的，都是設定$loader的成員屬性。就不細說了。

 

7）預載入loader【重點】

$loader->register(true);　　

 這個register的程式碼：

    public function register($prepend = false)
    {
        spl_autoload_register(array($this, 'loadClass'), true, $prepend);
    }　　

這裡是註冊自動載入函式，loadClass方法：

    public function loadClass($class)
    {
        if ($file = $this->findFile($class)) {
            includeFile($file);

            return true;
        }
    }　　

這個自動載入函式的功能就是去查詢檔案並且include檔案。就不往下細說了。

【備註】：

這裡是最重要的一個地方，以後所有new 一個類，或者需要載入類但是沒有require的時候，就會去呼叫這個自動載入函式然後include對應檔案。

 

8）設定要載入的檔案

　　　　　if ($useStaticLoader) {
            $includeFiles = Composer\Autoload\ComposerStaticInitf41aabc2816e3446178e95b11b3e78f3::$files;
        } else {
            $includeFiles = require __DIR__ . '/autoload_files.php';
        }　　

這裡是把要載入的檔案放入$includeFiles變數

 

9）載入檔案

foreach ($includeFiles as $fileIdentifier => $file) {
     composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file);
}
/*
 * 預載入檔案
 */
function composerRequiref41aabc2816e3446178e95b11b3e78f3($fileIdentifier, $file)
{
    if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
        require $file;

        $GLOBALS['__composer_autoload_files'][$fileIdentifier] = true;
    }
}

可以看到這裡就是去require檔案。

 

三、小結

在框架啟動後，會去設定自動載入函式，而且預載入了部分指定要載入的檔案。自動載入的好處是不需要到處去require檔案，用到的時候再require。另外就是如果類依賴其他類過多，每次都要require，也不好維護。

關於自動載入函式的說明先講到這裡，後續會有用到的地方再做解釋，先埋個伏筆。

相關推薦

laravel框架原始碼分析（一）自動載入

一、前言 　　使用php已有好幾年，laravel的使用也是有好長時間，但是一直對於框架原始碼的理解不深，原因很多，歸根到底還是php基礎不紮實，所以原始碼看起來也比較吃力。最近有時間，所以開啟第5、6遍的框架原始碼探索之旅，前面幾次都是看了一些就放棄，希望這次能夠看完。每一次看原始碼都會有新的收穫，因為框

新手解讀：laravel 框架原始碼分析（一）

眾所周知，php的框架數不勝數，近幾年，一個以優雅著稱的框架，漸漸被國內phper所知道，並且開始使用，但是larave有一個很明顯的缺點就是，他的文件內容少的可憐。而且國內的社群也不是很活躍。所以對使用這款框架的新書造成了很大困難。 作者作為一個入門也沒多久的新手，

Executor執行框架原始碼分析（一）——executor、threadFactory、ThreadPoolExecutor 、Future元件的關係及作用

       executor執行框架是JDK1.5新增的，用於專注於任務執行的框架。其最大的特點就是將任務的建立和任務的執行分離，鬆耦合，已達到最大限度的利用計算機資源（執行緒和記憶體等）。在併發程式設計中，executor是一個必備的工具。     在分析原始碼之前，首先

物件池commons-pool框架的研究以及原始碼分析（一）

    物件池是一個物件集合，用於將建立好的物件存在該集合中，當需要使用池中的物件時，再從池中取出，恰當地使用物件池可以有效減少物件生成和初始化時的消耗，提高系統的執行效率。另外，利用物件池還可以對物件的狀態做一定的維護，確保物件是可用的，提高程式的健壯性。注意：物件池技術

AFNetworking3.1.0原始碼分析（一）整體框架和功能模組

簡介 1:基於系統NSURLSession類族封裝完成HPPT/HPPTS(GET,PUT,PSOT,DELEATE,HEAD)網路請求 2:擴充套件部分UIKit控制元件，比如擴充套件UIIMag

Apache Arrow原始碼分析（一）——簡介和框架

背景 列儲存在資料庫領域中早已被提出，列儲存資料結構在分析型事務上表現優異，大資料分析引擎，諸如Spark-SQL，Impala 均採用列儲存作為其中間資料表示形式，那麼Apache Arrow就是這樣一種記憶體列式資料結構。 在眾多分散式系統中，每

mybatis 原始碼分析（一）框架結構概覽

本篇部落格將主要對 mybatis 整體介紹，包括 mybatis 的專案結構，執行的主要流程，初始化流程，API 等各模組進行簡單的串聯，讓你能夠對 mybatis 有一個整體的把握。另外在 mybatis 原始碼的閱讀過程中，如果不想寫 demo 可以直接使用專案中的單元測試； 一、mybatis 結構介

Flume NG原始碼分析（一）基於靜態properties檔案的配置模組

日誌收集是網際網路公司的一個重要服務，Flume NG是Apache的頂級專案，是分散式日誌收集服務的一個開源實現，具有良好的擴充套件性，與其他很多開源元件可以無縫整合。搜了一圈發現介紹Flume NG的文章有不少，但是深入分析Flume NG原始碼的卻沒有。準備寫一個系列分析一下Flume NG的

GCC原始碼分析（一）——介紹與安裝

原文連結：http://blog.csdn.net/sonicling/article/details/6702031     上半年一直在做有關GCC和LD的專案，到現在還沒做完。最近幾天程式設計的那臺電腦壞了，所以趁此間隙寫一點相關的分析和

Glide原始碼分析（一）從用法來看之with方法

繼續啃原始碼，用過Glide的人，肯定都覺得它好好用，我們一般只需要幾行程式碼，就可以達到我們想要的效果，可以在這個背後是什麼呢？就需要我們來看了。 我一般看原始碼，我喜歡先從用法來看，然後一步一步的再細扣，所以就先從用法來看Glide的整體流程。 用過Glide的人，用下面這段

zigbee 之ZStack-2.5.1a原始碼分析（一）

先看main， 在檔案Zmain.c裡面 main osal_init_system(); osalInitTasks(); ... ... SampleApp_Init( taskID ); // 使用者定義的任務

Docker Client原始碼分析（一）

主要內容： Docker Client在Docker中的定位，以及Docker Client原始碼的初步分析。 本文選取Docker拆分為DockerCE（社群版）和DockerEE（企業版）之後的Docker-CE的第一個穩定版本v17.06.0-ce。 https://github.com/docker

Hibernate使用及原始碼分析（一）

Hibernate使用及原始碼分析（一） 本篇文章主要通過hibernate初級使用分析一下原始碼，只是給初學者一點小小的建議，不喜勿噴，謝謝！ hibernate環境搭建 簡單使用 原始碼走讀 一 hibernate環境搭建 這裡直接

SpringCloud原始碼分析（一）--客戶端搭建

一、前言 上一節的註冊中心搭建完成了，本節開始搭建客戶端，其實對於springcloud的Eureka註冊中心而言，他本身就是服務端也是客戶端，我們上節待見服務端註冊中心的時候，已經通過配置來設定其不向自己註冊，和不去檢索服務的功能，保持了其作為服務註冊中心的相對的功能單一性。 二、pom檔案

Vue原始碼分析（一）：入口檔案

Vue原始碼分析（一）：入口檔案   首先開啟命令列，從github下載原始碼，下載到自己的工作目錄。 git clone https://github.com/vuejs/vue.git   這裡我下載的是2.5.17版本的，vue 原始碼是由各種模組用 rollup 工具

okhttp原始碼分析（一）——基本流程（超詳細）

1.okhttp原始碼分析（一）——基本流程（超詳細） 2.okhttp原始碼分析（二）——RetryAndFollowUpInterceptor過濾器 3.okhttp原始碼分析（三）——CacheInterceptor過濾器 4.okhttp原始碼分析（四）——Conn

spring事務管理原始碼分析（一）配置和事務增強代理的生成流程

在本篇文章中，將會介紹如何在spring中進行事務管理，之後對其內部原理進行分析。主要涉及 @EnableTransactionManagement註解為我們做了什麼？ 為什麼標註了@Transactional註解的方法就可以具有事務的特性，保持了資料的ACID特性？spring到底是如何具有這樣

Android系統播放器MediaPlayer原始碼分析（一）

前言 對於MediaPlayer播放器的原始碼分析內容相對來說比較多，會從Java->JNI->C/C++慢慢分析，後面會慢慢更新。另外，部落格只作為自己學習記錄的一種方式，對於其他的不過多的評論。 MediaPlayerDemo public class MainA

Android7.1 [Camera] Camera Hal 原始碼分析（一）

原始碼平臺：rk3399   命令列ls看下原始碼的結構 hardware/rockchip/camera/CameraHal： lib目錄 原始碼的檔案看起來有點多，我們看看Android.mk檔案， 這些檔案最終編譯成camera.rk30bo

Cat原始碼分析（一）：Client端

前言 cat的Client端所做的工作就是收集埋點資訊，將埋點資訊處理成messageTree，放到傳送佇列中，在啟動另一個執行緒，非同步消費佇列，進行訊息的傳送。 本文涉及到三個內容： 客戶端初始化：做了哪些準備工作 message的建立過程 客戶端的傳