「PSR 规范」PSR-4 自动加载规范

分享 Summer ⋅ 于 2年前 ⋅ 最后回复由 omigia 1个月前 ⋅ 24428 阅读

所有 PSR 规范请见:https://psr.phphub.org/

1. 概述

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

关于「能愿动词」的使用

为了避免歧义,文档大量使用了「能愿动词」,对应的解释如下:

  • 必须 (MUST):绝对,严格遵循,请照做,无条件遵守;
  • 一定不可 (MUST NOT):禁令,严令禁止;
  • 应该 (SHOULD) :强烈建议这样做,但是不强求;
  • 不该 (SHOULD NOT):强烈不建议这样做,但是不强求;
  • 可以 (MAY)可选 (OPTIONAL) :选择性高一点,在这个文档内,此词语使用较少;

参见:RFC 2119

2. 详细说明

  1. 此处的「类」泛指所有的「Class类」、「接口」、「traits 可复用代码块」以及其它类似结构。

  2. 一个完整的类名需具有以下结构:

    \<命名空间>(\<子命名空间>)*\<类名>
    1. 完整的类名 必须 要有一个顶级命名空间,被称为 "vendor namespace";

    2. 完整的类名 可以 有一个或多个子命名空间;

    3. 完整的类名 必须 有一个最终的类名;

    4. 完整的类名中任意一部分中的下滑线都是没有特殊含义的;

    5. 完整的类名 可以 由任意大小写字母组成;

    6. 所有类名都 必须 是大小写敏感的。
  3. 当根据完整的类名载入相应的文件

    1. 完整的类名中,去掉最前面的命名空间分隔符,前面连续的一个或多个命名空间和子命名空间,作为「命名空间前缀」,其必须与至少一个「文件基目录」相对应;

    2. 紧接命名空间前缀后的子命名空间 必须 与相应的「文件基目录」相匹配,其中的命名空间分隔符将作为目录分隔符。

    3. 末尾的类名 必须 与对应的以 .php 为后缀的文件同名。

    4. 自动加载器(autoloader)的实现 一定不可 抛出异常、一定不可 触发任一级别的错误信息以及 不应该 有返回值。

3. 例子

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

完整类名 命名空间前缀 文件基目录 文件路径
\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

关于本规范的实现,可参阅 相关实例

注意:实例并 属于规范的一部分,且随时 有所变动。

--

所有 PSR 规范请见:https://psr.phphub.org/

本文章首发在 Laravel China 社区

Practice makes perfect.

本帖已被设为精华帖!
本帖由系统于 6个月前 自动加精
回复数量: 4
  • 我有点不明白 什么叫做基目录。。

    1年前
  • MARK
    「PSR 规范」PSR-4 自动加载规范

    6个月前
  • 文件基目录 的理解:

    1. 代码中用到一个具体的类(\Acme\Log\Writer\File_Writer);
    2. 一般不是靠手动 require 或 include 引入相应文件,而是靠 自动加载器 (spl_autoload_register)引入;
    3. 自动加载器 收到需要加载的 完整类名 \Acme\Log\Writer\File_Writer;
    4. 完整类名 \Acme\Log\Writer\File_Writer 得到 命名空间前缀 Acme\Log\Writer;
    5. 命名空间前缀 Acme\Log\Writer 找到对应 文件基目录 ./acme-log-writer/lib/;
    6. 有了 文件基目录 ./acme-log-writer/lib/ 即可知待引入文件的 文件路径 ./acme-log-writer/lib/File_Writer.php

    文件基目录命名空间前缀 的映射关系需要在 自动加载器 (spl_autoload_register)中定义好。(composer干的就是这件事)

    文末给出的相关实例很清楚了

    2个月前
  • @adesight 应该是和基类相对应的一个东西吧

    1年前
您需要登陆以后才能留下评论!

Composer 中国全量镜像

Top 250 扩展包

Lumen 中文文档

Laravel 速查表

Laravel 中文文档

Laravel 项目开发规范

Laravel 开发环境部署

Composer 中文文档

Elasticsearch-PHP 中文文档

Lumen 中文文档

GraphQL PHP 中文文档

社区文档撰写指南

TDD 构建 Laravel 论坛笔记

PHP PSR 标准规范

PHP 设计模式全集

Dingo API 中文文档