FIG-PHP PSR規範系列4-自動載入

1. PSR-4規範：自動載入

雖然在[PSR-4-Meta]中指出PSR-4是對PSR-0規範的補充而不是替換，但是在[PSR-0]中已經寫到PSR-0於2014.10.21被廢棄，並在[PSR-4-Meta]中詳細寫明了PSR-0的不足，已經不能滿足面向package的自動載入。

PSR-4規範能夠滿足面向package的自動載入，它規範了如何從檔案路徑自動載入類，同時規範了自動負載檔案的位置。

1.1 概述

這份PSR規範描述了從檔案路徑自動載入類。可以與PSR-0規範互操作，可以一起使用。這份PSR也描述了自動載入的檔案應當放在哪裡。

1.2 規範

1.2.1 術語"class"是指classes, interfaces, traits, 以及其他類似的結構.

1.2.2 一個完全合乎規格的類名（A fully qualified class name）格式如下：

\(\)*\

(1) 完全合規的類名必須（MUST）有一個頂級命名空間名稱，也就是通常所說的"vendor命名空間".

(2) 完全合規的類名可以（MAY）有一個或多個二級命名空間名稱（sub-namespace names）.

(3) 完全合規的類名必須（MUST）以類名來結尾。

(4) 在完全合規的類名的任意一個部分，底線都沒有特殊的含義。

(5) 在完全合規的類名中，可以（MAY）是任意大小寫字母混合。

(6) 所有的類名必須（MUST）按大小寫敏感方式來引用。

1.2.3 當載入完全合規的類名對應的檔案時...

(1) 在完全合規的類名中, 不包含前面的命名空間分隔字元，由一個頂級命名空間與一個或多個二級命名空間名稱組成的命名空間首碼，對應於至少一個“base目錄”.

(2) 在命名空間首碼後面的二級命名空間名稱對應於“base目錄”中的一個子目錄, 這裡命名空間分隔字元表示目錄分隔字元。子目錄名稱必須（MUST）匹配到二級命名空間名稱。

(3) 後面的類名對應於以.php為尾碼的檔案名稱，這個檔案名稱必須（MUST）匹配到後面的類名。

(4) 自動載入實現一定不能（MUST NOT）拋出異常，一定不能（MUST NOT）引發任何層級的錯誤, 並且不應當（SHOULD NOT）傳回值。

1.3. 舉例

下面的表展示了對一個完全合規的類名, 命名空間首碼以及base目錄對應的檔案路徑.

完全合規類名	命名空間首碼	base目錄	最終的檔案路徑
\Acme\Log\Writer\File_Writer	Acme\Log\Writer	./acme-log-writer/lib/	./acme-log-writer/lib/File_Writer.php
\Aura\Web\Response\Status	Aura\Web	/path/to/aura-web/src/	/path/to/aura-web/src/Response/Status.php
\Symfony\Core\Request	Symfony\Core	./vendor/Symfony/Core/	./vendor/Symfony/Core/Request.php

\Zend\Acl

Zend

/usr/includes/Zend/

/usr/includes/Zend/Acl.php

備忘：以第一行為例來說明，完全合規的類名是“\Acme\Log\Writer\File_Writer”， 去掉前面的命名空間分隔字元'\', 則命名空間首碼為"Acme\Log\Writer", 類名為"File_Writer"。這個命名空間首碼對應的base目錄為"./acme-log-writer/lib/", 因此最終載入的檔案名稱為：base目錄+類名+".php"， 即"./acme-log-writer/lib/File_Writer.php"

遵循本規範的自動載入器的實現舉例， 可參見下面的代碼範例。這些實現範例一定不能（MUST NOT）被視為本規範的內容，它們可能（MAY）隨時發生改變。

2. 代碼範例

以下代碼展示了遵循PSR-4的類定義，

閉包(Closure)舉例：

  
下面這個類處理多個命名空間：
  
register(); *       *      // register the base directories for the namespace prefix *      // 註冊命名空間首碼的多個base目錄 *      $loader->addNamespace('Foo\Bar', '/path/to/packages/foo-bar/src'); *      $loader->addNamespace('Foo\Bar', '/path/to/packages/foo-bar/tests'); *  * The following line would cause the autoloader to attempt to load the * \Foo\Bar\Qux\Quux class from /path/to/packages/foo-bar/src/Qux/Quux.php: * 下面代碼將用/path/to/packages/foo-bar/src/Qux/Quux.php檔案來載入\Foo\Bar\Qux\Quux類。 *  *      prefixes[$prefix]) === false) {            $this->prefixes[$prefix] = array();        }        // retain the base directory for the namespace prefix        // 綁定命名空間首碼對應的base目錄        if ($prepend) {            array_unshift($this->prefixes[$prefix], $base_dir);        } else {            array_push($this->prefixes[$prefix], $base_dir);        }    }    /**     * Loads the class file for a given class name.     * 根據類名來載入類檔案。     *     * @param string $class The fully-qualified class name.     * @return mixed The mapped file name on success, or boolean false on     * failure.     */    public function loadClass($class)    {        // the current namespace prefix        $prefix = $class;        // work backwards through the namespace names of the fully-qualified        // class name to find a mapped file name        // 從後面開始遍曆完全合格類名中的命名空間名稱, 來尋找映射的檔案名稱        while (false !== $pos = strrpos($prefix, '\\')) {            // retain the trailing namespace separator in the prefix            // 保留命名空間首碼中尾部的分隔字元            $prefix = substr($class, 0, $pos + 1);            // the rest is the relative class name            // 剩餘的就是相對類名稱            $relative_class = substr($class, $pos + 1);            // try to load a mapped file for the prefix and relative class            // 利用命名空間首碼和相對類名來載入對應檔            $mapped_file = $this->loadMappedFile($prefix, $relative_class);            if ($mapped_file) {                return $mapped_file;            }            // remove the trailing namespace separator for the next iteration            // of strrpos()            // 刪除命名空間首碼尾部的分隔字元，以便用於下一次strrpos()迭代            $prefix = rtrim($prefix, '\\');           }        // never found a mapped file        // 未找到對應檔        return false;    }    /**     * Load the mapped file for a namespace prefix and relative class.     * 根據命名空間首碼和相對類來載入對應檔     *      * @param string $prefix The namespace prefix.     * @param string $relative_class The relative class name.     * @return mixed Boolean false if no mapped file can be loaded, or the     * name of the mapped file that was loaded.     */    protected function loadMappedFile($prefix, $relative_class)    {        // are there any base directories for this namespace prefix?        // 命名空間首碼中有base目錄嗎？        if (isset($this->prefixes[$prefix]) === false) {            return false;        }        // look through base directories for this namespace prefix        // 遍曆命名空間首碼的base目錄        foreach ($this->prefixes[$prefix] as $base_dir) {            // replace the namespace prefix with the base directory,            // replace namespace separators with directory separators            // in the relative class name, append with .php            // 用base目錄替代命名空間首碼,             // 在相對類名中用目錄分隔字元'/'來替換命名空間分隔字元'\',             // 並在後面追加.php組成$file的絕對路徑            $file = $base_dir                  . str_replace('\\', '/', $relative_class)                  . '.php';            // if the mapped file exists, require it            // 若對應檔存在，則require該檔案            if ($this->requireFile($file)) {                // yes, we're done                return $file;            }        }        // never found it        return false;    }    /**     * If a file exists, require it from the file system.     *      * @param string $file The file to require.     * @return bool True if the file exists, false if not.     */    protected function requireFile($file)    {        if (file_exists($file)) {            require $file;            return true;        }        return false;    }}
 3. 單元測試  
    下面是對應的單元測試代碼：
  
files = $files;    }    protected function requireFile($file)    {        return in_array($file, $this->files);    }}class Psr4AutoloaderClassTest extends \PHPUnit_Framework_TestCase{    protected $loader;    protected function setUp()    {        $this->loader = new MockPsr4AutoloaderClass;        $this->loader->setFiles(array(            '/vendor/foo.bar/src/ClassName.php',            '/vendor/foo.bar/src/DoomClassName.php',            '/vendor/foo.bar/tests/ClassNameTest.php',            '/vendor/foo.bardoom/src/ClassName.php',            '/vendor/foo.bar.baz.dib/src/ClassName.php',            '/vendor/foo.bar.baz.dib.zim.gir/src/ClassName.php',        ));        $this->loader->addNamespace(            'Foo\Bar',            '/vendor/foo.bar/src'        );        $this->loader->addNamespace(            'Foo\Bar',            '/vendor/foo.bar/tests'        );        $this->loader->addNamespace(            'Foo\BarDoom',            '/vendor/foo.bardoom/src'        );        $this->loader->addNamespace(            'Foo\Bar\Baz\Dib',            '/vendor/foo.bar.baz.dib/src'        );        $this->loader->addNamespace(            'Foo\Bar\Baz\Dib\Zim\Gir',            '/vendor/foo.bar.baz.dib.zim.gir/src'        );    }    public function testExistingFile()    {        $actual = $this->loader->loadClass('Foo\Bar\ClassName');        $expect = '/vendor/foo.bar/src/ClassName.php';        $this->assertSame($expect, $actual);        $actual = $this->loader->loadClass('Foo\Bar\ClassNameTest');        $expect = '/vendor/foo.bar/tests/ClassNameTest.php';        $this->assertSame($expect, $actual);    }    public function testMissingFile()    {        $actual = $this->loader->loadClass('No_Vendor\No_Package\NoClass');        $this->assertFalse($actual);    }    public function testDeepFile()    {        $actual = $this->loader->loadClass('Foo\Bar\Baz\Dib\Zim\Gir\ClassName');        $expect = '/vendor/foo.bar.baz.dib.zim.gir/src/ClassName.php';        $this->assertSame($expect, $actual);    }    public function testConfusion()    {        $actual = $this->loader->loadClass('Foo\Bar\DoomClassName');        $expect = '/vendor/foo.bar/src/DoomClassName.php';        $this->assertSame($expect, $actual);        $actual = $this->loader->loadClass('Foo\BarDoom\ClassName');        $expect = '/vendor/foo.bardoom/src/ClassName.php';        $this->assertSame($expect, $actual);    }}
 4. PSR-4應用  
  
    PHP的包管理系統Composer已經支援PSR-4，同時也允許在composer.json中定義不同的prefix使用不同的自動載入機制。
  
Composer使用PSR-0風格
  
vendor/    vendor_name/        package_name/            src/                Vendor_Name/                    Package_Name/                        ClassName.php       # Vendor_Name\Package_Name\ClassName            tests/                Vendor_Name/                    Package_Name/                        ClassNameTest.php   # Vendor_Name\Package_Name\ClassName
  
Composer使用PSR-4風格
  
vendor/    vendor_name/        package_name/            src/                ClassName.php       # Vendor_Name\Package_Name\ClassName            tests/                ClassNameTest.php   # Vendor_Name\Package_Name\ClassNameTest
  
     對比以上兩種結構，明顯可以看出PSR-4帶來更簡潔的檔案結構。
 5. 參考資料  
  
[PHP-FIG] php-fig, http://www.php-fig.org/ 
  
[PSR-0] Autoloading Standard, http://www.php-fig.org/psr/psr-0/ 
  
[PSR-4] Autoloader, http://www.php-fig.org/psr/psr-4/
  
[PSR-4-Meta] PSR-4 Meta Document, http://www.php-fig.org/psr/psr-4/meta/
  
[PSR-4-Example] Example Implementations of PSR-4, http://www.php-fig.org/psr/psr-4/examples/
