PSR-4 自动加载规范
PSR-4 描述了从文件路径中 自动加载 类的规范。 它拥有非常好的兼容性,并且可以在任何自动加载规范中使用,包括 PSR-0。 PSR-4 规范也描述了放置 autoload 文件(就是我们经常引入的 vendor/autoload.php
)的位置。
本文中的 必须
,不得
,需要
,应
,不应
,应该
,不应该
,推荐
,可以
和 可选
等能愿动词按照 RFC 2119 中的描述进行解释。
规范
术语class
指的是类(classes)、接口(interfaces)、特征(traits)和其他类似的结构。
全限定类名具有以下形式:
代码语言:javascript复制1<NamespaceName>(<SubNamespaceNames>)*<ClassName>
- 全限定类名必须拥有一个顶级命名空间名称,也称为供应商命名空间(vendor namespace)。
- 全限定类名可以有一个或者多个子命名空间名称。
- 全限定类名必须有一个最终的类名(我想意思应该是你不能这样
<NamespaceName>(<SubNamespaceNames>)*
来表示一个完整的类)。 - 下划线在全限定类名中没有任何特殊含义(在 PSR-0 中下划是有含义的)。
- 全限定类名可以是任意大小写字母的组合。
- 所有类名的引用必须区分大小写。
全限定类名的加载过程
- 在全限定的类名(一个
命名空间前缀
)中,一个或多个前导命名空间和子命名空间组成的连续命名空间,不包括前导命名空间的分隔符,至少对应一个根目录
。 命名空间前缀
后面的相邻子命名空间与根目录下的目录名称相对应(且必须区分大小写),其中命名空间的分隔符表示目录分隔符。- 最终的类名与以
.php
结尾的文件名保持一致,这个文件的名字必须和最终的类名相匹配(意思就是如果类名是FooController
,那么这个类所在的文件名必须是FooController.php
)。
自动加载文件禁止抛出异常,禁止出现任何级别的错误,也不建议有返回值。
范例
下表显示了与给定的全限定类名、命名空间前缀和根目录相对应的文件的路径。
完全限定的类名 | 命名空间前缀 | 基本目录 | 结果文件路径 |
---|---|---|---|
AcmeLogWriterFile_Writer | AcmeLogWriter | ./acme-log-writer/lib/ | ./acme-log-writer/lib/File_Writer.php |
AuraWebResponseStatus | AuraWeb | /path/to/aura-web/src/ | /path/to/aura-web/src/Response/Status.php |
SymfonyCoreRequest | SymfonyCore | ./vendor/Symfony/Core/ | ./vendor/Symfony/Core/Request.php |
ZendAcl | Zend | /usr/includes/Zend/ | /usr/includes/Zend/Acl.php |
想要了解一个符合规范的自动加载器的实现可以查看示例文件。示例中的自动加载器禁止被视为规范的一部分,它随时都可能发生改变。