PSR-4

以你之姓@ 2022-07-14 08:43 168阅读 0赞

# Autoloader #

关键词 “必须”("MUST")、“一定不可/一定不能”("MUST NOT")、“需要”("REQUIRED")、 “将会”("SHALL")、“不会”("SHALL NOT")、“应该”("SHOULD")、“不该”("SHOULD NOT")、 “推荐”("RECOMMENDED")、“可以”("MAY")和”可选“("OPTIONAL")的详细描述可参见 \[RFC 2119\]\[[http://tools.ietf.org/html/rfc2119][http_tools.ietf.org_html_rfc2119]\] 。

## 1. 概述 ##

本 PSR 是关于由文件路径 [自动载入][Link 1] 对应类的相关规范， 本规范是可互操作的，可以作为任一自动载入规范的补充，其中包括[PSR-0][]，此外， 本 PSR 还包括自动载入的类对应的文件存放路径规范。

## 2. 详细说明 ##

1.  此处的“类”泛指所有的class类、接口、traits可复用代码块以及其它类似结构。
2.  一个完整的类名需具有以下结构:
    
        \<命名空间>(\<子命名空间>)*\<类名>
    
    1.  完整的类名必须要有一个顶级命名空间，被称为 "vendor namespace"；
    2.  完整的类名可以有一个或多个子命名空间；
    3.  完整的类名必须有一个最终的类名；
    4.  完整的类名中任意一部分中的下划线都是没有特殊含义的；
    5.  完整的类名可以由任意大小写字母组成；
    6.  所有类名都必须是大小写敏感的。
3.  当根据完整的类名载入相应的文件……
    
    1.  完整的类名中，去掉最前面的命名空间分隔符，前面连续的一个或多个命名空间和子命名空间，作为“命名空间前缀”，其必须与至少一个“文件基目录”相对应；
    2.  紧接命名空间前缀后的子命名空间必须与相应的”文件基目录“相匹配，其中的命名空间分隔符将作为目录分隔符。
    3.  末尾的类名必须与对应的以 `.php` 为后缀的文件同名。
    4.  自动加载器（autoloader）的实现一定不能抛出异常、一定不能触发任一级别的错误信息以及不应该有返回值。

## 3. 例子 ##

下表展示了符合规范完整类名、命名空间前缀和文件基目录所对应的文件路径。

<table style="box-sizing: border-box; border-spacing: 0px; border-collapse: collapse; margin-top: 0px; margin-bottom: 16px; display: block; width: 888px; overflow: auto; color: rgb(51, 51, 51); font-family: -apple-system, BlinkMacSystemFont, &quot;Segoe UI&quot;, Helvetica, Arial, sans-serif, &quot;Apple Color Emoji&quot;, &quot;Segoe UI Emoji&quot;, &quot;Segoe UI Symbol&quot;; font-size: 16px;"> 
 <thead style="box-sizing: border-box;"> 
  <tr style="box-sizing: border-box; border-top: 1px solid rgb(204, 204, 204);"> 
   <th style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">完整类名</th> 
   <th style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">命名空间前缀</th> 
   <th style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">文件基目录</th> 
   <th style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">文件路径</th> 
  </tr> 
 </thead> 
 <tbody style="box-sizing: border-box;"> 
  <tr style="box-sizing: border-box; border-top: 1px solid rgb(204, 204, 204);"> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">\Acme\Log\Writer\File_Writer</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">Acme\Log\Writer</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">./acme-log-writer/lib/</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">./acme-log-writer/lib/File_Writer.php</td> 
  </tr> 
  <tr style="box-sizing: border-box; background-color: rgb(248, 248, 248); border-top: 1px solid rgb(204, 204, 204);"> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">\Aura\Web\Response\Status</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">Aura\Web</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">/path/to/aura-web/src/</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">/path/to/aura-web/src/Response/Status.php</td> 
  </tr> 
  <tr style="box-sizing: border-box; border-top: 1px solid rgb(204, 204, 204);"> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">\Symfony\Core\Request</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">Symfony\Core</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">./vendor/Symfony/Core/</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">./vendor/Symfony/Core/Request.php</td> 
  </tr> 
  <tr style="box-sizing: border-box; background-color: rgb(248, 248, 248); border-top: 1px solid rgb(204, 204, 204);"> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">\Zend\Acl</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">Zend</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">/usr/includes/Zend/</td> 
   <td style="box-sizing: border-box; padding: 6px 13px; border: 1px solid rgb(221, 221, 221);">/usr/includes/Zend/Acl.php</td> 
  </tr> 
 </tbody> 
</table>

关于本规范的实现，可参阅 [相关实例][Link 2]

注意：实例并不属于规范的一部分，且随时会有所变动。

# PSR-4 相关示例 #

以下是 PSR-4 规范的相关示例代码：

## 闭包的实现示例 ##

<?php
    /**
     * 一个具体项目的实例
     * 
     * 当使用 SPL 注册此自动加载器后，执行以下语句将从 
     * /path/to/project/src/Baz/Qux.php 载入 \Foo\Bar\Baz\Qux 类：
     * 
     * new \Foo\Bar\Baz\Qux;
     * 
     * @param string $class 完整的类名
     * @return void
     */
    spl_autoload_register(function ($class) {
        
    
        // 具体项目命名空间前缀
        $prefix = 'Foo\\Bar\\';
    
        // 命名空间前缀的基目录
        $base_dir = __DIR__ . '/src/';
    
        // 判断类名是否具有本命名空间前缀
        $len = strlen($prefix);
        if (strncmp($prefix, $class, $len) !== 0) {
        
            // 不含本命名空间前缀，退出本自动载入器
            return;
        }
    
        // 截取相应类名
        $relative_class = substr($class, $len);
    
        // 将命名空间前缀替作为文件基目录，然后
        // 将类名中的命名空间分隔符替换成文件分隔符,
        // 最后添加 .php 后缀
        $file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
    
        // 如果以上文件存在，则将其载入
        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.
     * 
     * Given a foo-bar package of classes in the file system at the following
     * paths ...
     * 
     * /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:
     * 
     * <?php
     * // instantiate the loader
     * $loader = new \Example\Psr4AutoloaderClass;
     * 
     * // register the autoloader
     * $loader->register();
     * 
     * // register the base directories for the namespace prefix
     * $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:
     * 
     * <?php
     * new \Foo\Bar\Qux\Quux;
     * 
     * 以下代码将由 /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.
     *
     * @var array
     */
        protected $prefixes = array();
    
        /**
     * 在 SPL 自动加载器栈中注册加载器
     * 
     * @return void
     */
        public function register()
        {
        
            spl_autoload_register(array($this, 'loadClass'));
        }
    
        /**
     * 添加命名空间前缀与文件基目录对
     *
     * @param string $prefix 命名空间前缀
     * @param string $base_dir 命名空间中类文件的基目录
     * @param bool $prepend 为 True 时，将基目录插到最前，这将让其作为第一个被搜索到，否则插到将最后。
     * @return void
     */
        public function addNamespace($prefix, $base_dir, $prepend = false)
        {
        
            // 规范化命名空间前缀
            $prefix = trim($prefix, '\\') . '\\';
    
            // 规范化文件基目录
            $base_dir = rtrim($base_dir, '/') . DIRECTORY_SEPARATOR;
            $base_dir = rtrim($base_dir, DIRECTORY_SEPARATOR) . '/';
    
            // 初始化命名空间前缀数组
            if (isset($this->prefixes[$prefix]) === false) {
        
                $this->prefixes[$prefix] = array();
            }
    
            // 将命名空间前缀与文件基目录对插入保存数组
            if ($prepend) {
        
                array_unshift($this->prefixes[$prefix], $base_dir);
            } else {
        
                array_push($this->prefixes[$prefix], $base_dir);
            }
        }
    
        /**
     * 由类名载入相应类文件
     *
     * @param string $class 完整的类名
     * @return mixed 成功载入则返回载入的文件名，否则返回布尔 false
     */
        public function loadClass($class)
        {
        
            // 当前命名空间前缀
            $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()
                $prefix = rtrim($prefix, '\\');   
            }
    
            // 找不到相应文件
            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?
            if (isset($this->prefixes[$prefix]) === false) {
        
                return false;
            }
    
            // look through base directories for this namespace prefix
            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
                $file = $base_dir
                      . str_replace('\\', DIRECTORY_SEPARATOR, $relative_class)
                      . '.php';
                $file = $base_dir
                      . str_replace('\\', '/', $relative_class)
                      . '.php';
    
                // 当文件存在时，在入之
                if ($this->requireFile($file)) {
        
                    // 完成载入
                    return $file;
                }
            }
    
            // 找不到相应文件
            return false;
        }
    
        /**
     * 当文件存在，则从文件系统载入之
     * 
     * @param string $file 需要载入的文件
     * @return bool 当文件存在则为 True，否则为 false
     */
        protected function requireFile($file)
        {
        
            if (file_exists($file)) {
        
                require $file;
                return true;
            }
            return false;
        }
    }

### 单元测试 ###

以下是上面代码单元测试的一种实现：

<?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);
        }
    }

[http_tools.ietf.org_html_rfc2119]: http://tools.ietf.org/html/rfc2119
[Link 1]: http://php.net/autoload
[PSR-0]: https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-0-cn.md
[Link 2]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader-examples.md