摘要: FIG-PHP工作組推出的PSR-4規範能夠滿足面向package的自動載入，它規範瞭如何從檔案路徑自動載入類，同時規範了自動載入檔案的位置。

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）格式如下：

        \<NamespaceName>(\<SubNamespaceNames>)*\<ClassName>

        (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目錄對應的檔案路徑.

    備註：以第一行為例來說明，完全合規的類名是“\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)舉例：

<?php
/**
 * An example of a project-specific implementation.
 * 
 * After registering this autoload function with SPL, the following line
 * would cause the function to attempt to load the \Foo\Bar\Baz\Qux class
 * from /path/to/project/src/Baz/Qux.php:
 * 
 *      new \Foo\Bar\Baz\Qux;
 *      
 * @param string $class The fully-qualified class name.
 * @return void
 */
spl_autoload_register(function ($class) {

    // project-specific namespace prefix
    // 專案的名稱空間字首
    $prefix = 'Foo\\Bar\\';

    // base directory for the namespace prefix
    // 名稱空間字首對應的base目錄
    $base_dir = __DIR__ . '/src/';

    // does the class use the namespace prefix?
    // 檢查$class中是否包含名稱空間字首
    $len = strlen($prefix);
    if (strncmp($prefix, $class, $len) !== 0) {
        // no, move to the next registered autoloader
        // 未包含，立即返回
        return;
    }

    // get the relative class name
    // 獲取相對類名
    $relative_class = substr($class, $len);

    // 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 file exists, require it
    // 如果檔案存在，則通過require關鍵字包含檔案
    if (file_exists($file)) {
        require $file;
    }
});

下面這個類處理多個名稱空間：

<?php
namespace Example;

/**
 * An example of a general-purpose implementation that includes the optional
 * functionality of allowing multiple base directories for a single namespace
 * prefix.
 * 下面例子中在一個名稱空間字首下有多個base目錄。
 * 
 * Given a foo-bar package of classes in the file system at the following
 * paths ...
 * 在下面路徑中foo-bar包中存在以下類：
 * 
 *     /path/to/packages/foo-bar/
 *         src/
 *             Baz.php             # Foo\Bar\Baz
 *             Qux/
 *                 Quux.php        # Foo\Bar\Qux\Quux
 *         tests/
 *             BazTest.php         # Foo\Bar\BazTest
 *             Qux/
 *                 QuuxTest.php    # Foo\Bar\Qux\QuuxTest
 * 
 * ... add the path to the class files for the \Foo\Bar\ namespace prefix
 * as follows:
 * ...對\Foo\Bar\名稱空間字首，新增類檔案的路徑
 * 
 *      <?php
 *      // instantiate the loader
 *      // 初始化loader 
 *      $loader = new \Example\Psr4AutoloaderClass;
 *      
 *      // register the autoloader
 *      // 註冊autoloader
 *      $loader->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類。
 * 
 *      <?php
 *      new \Foo\Bar\Qux\Quux;
 * 
 * The following line would cause the autoloader to attempt to load the 
 * \Foo\Bar\Qux\QuuxTest class from /path/to/packages/foo-bar/tests/Qux/QuuxTest.php:
 * 下面程式碼將用/path/to/packages/foo-bar/tests/Qux/QuuxTest.php檔案來載入
 * \Foo\Bar\Qux\QuuxTest類。
 * 
 *      <?php
 *      new \Foo\Bar\Qux\QuuxTest;
 */
class Psr4AutoloaderClass
{
    /**
     * An associative array where the key is a namespace prefix and the value
     * is an array of base directories for classes in that namespace.
     * 定義一個數組：key為名稱空間字首，value為一個數組，每一項表示名稱空間中類對應的base目錄.
     *
     * @var array
     */
    protected $prefixes = array();

    /**
     * Register loader with SPL autoloader stack.
     * 利用SPL自動載入器來註冊loader
     * 
     * @return void
     */
    public function register()
    {
        spl_autoload_register(array($this, 'loadClass'));
    }

    /**
     * Adds a base directory for a namespace prefix.
     * 為一個名稱空間字首新增對應的base目錄
     *
     * @param string $prefix The namespace prefix.
     * @param string $base_dir A base directory for class files in the
     * namespace.
     * @param bool $prepend If true, prepend the base directory to the stack
     * instead of appending it; this causes it to be searched first rather
     * than last.
     * @return void
     */
    public function addNamespace($prefix, $base_dir, $prepend = false)
    {
        // normalize namespace prefix
        // 規範名稱空間字首
        $prefix = trim($prefix, '\\') . '\\';

        // normalize the base directory with a trailing separator
        // 用'/'字元來規範base目錄
        $base_dir = rtrim($base_dir, DIRECTORY_SEPARATOR) . '/';

        // initialize the namespace prefix array
        // 初始化名稱空間字首陣列
        if (isset($this->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. 單元測試

    下面是對應的單元測試程式碼：

<?php
namespace Example\Tests;

class MockPsr4AutoloaderClass extends Psr4AutoloaderClass
{
    protected $files = array();

    public function setFiles(array $files)
    {
        $this->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風格

Composer使用PSR-4風格

     對比以上兩種結構，明顯可以看出PSR-4帶來更簡潔的檔案結構。

http://www.cnblogs.com/huanxiyun/articles/6555942.html