PHP `PSR` 规范深度：实现与遵循最佳实践

各位码友，大家好！我是你们今天的主讲人，咱们今天唠唠PHP的“PSR”规范，以及如何把它玩转起来，让你的代码变得更加优雅，更容易维护，更重要的是，让你的同事（或者未来的自己）不会在背后骂你“这写的什么玩意儿！”。

开场白：PSR是什么？为什么要用它？

咱们先来聊聊什么是PSR。PSR，全称PHP Standards Recommendations，翻译过来就是PHP标准建议。它是由PHP Framework Interoperability Group (PHP-FIG) 这个组织搞出来的。这个组织聚集了一帮大佬，他们一起制定了一些规范，目的是为了让不同的PHP项目之间能够更好地协作和互操作。

你可以把PSR想象成一套“交通规则”。如果大家都遵守这些规则，那么不同的框架、库、组件之间就可以像不同型号的汽车一样，在同一条道路上行驶，互相之间不会发生冲突。如果没有这些规则，那就可能出现“各玩各的”，导致代码难以复用，维护成本飙升。

所以，使用PSR规范，好处多多：

• 提高代码的可读性： 统一的编码风格，让代码更容易理解。
• 提高代码的可维护性： 遵循规范的代码，更容易修改和扩展。
• 提高代码的互操作性： 不同的项目可以更容易地集成和协作。
• 减少学习成本： 当你熟悉了PSR规范，学习新的框架或库会更加容易。

PSR规范速览：核心成员

PSR规范有很多，但并不是每个都和你息息相关。咱们先来看几个最核心的：

PSR	名称	描述	重要程度
PSR-1	Basic Coding Standard	基础编码规范，定义了代码的基本结构、命名约定、文件组织等。	非常重要
PSR-2	Coding Style Guide	编码风格指南，进一步细化了PSR-1的规范，规定了代码的缩进、空格、换行等细节。	非常重要
PSR-4	Autoloading Standard	自动加载标准，定义了如何根据类名自动加载对应的文件。	非常重要
PSR-7	HTTP message interfaces	HTTP消息接口，定义了HTTP请求和响应的接口，方便处理HTTP请求。	重要
PSR-11	Container interface	容器接口，定义了依赖注入容器的接口，方便管理对象的依赖关系。	重要
PSR-12	Extended Coding Style Guide	扩展编码风格指南，是对PSR-2的补充，增加了一些新的规范，比如关于闭包、数组、控制结构等。	重要
PSR-14	Event Dispatcher	事件调度器，定义了事件调度器的接口，方便实现事件驱动的编程模式。	视情况而定
PSR-16	Common interfaces for caching libraries	缓存库的通用接口，定义了缓存库的接口，方便使用不同的缓存方案。	视情况而定

接下来，咱们就一个一个地深入了解这些核心成员，看看它们到底是怎么玩的。

PSR-1：基础编码规范

PSR-1是所有PSR规范的基础，它定义了一些最基本的规则，比如：

• PHP文件必须使用<?php或<?=标签。 这个不用多说，写PHP代码的基本功。
• PHP文件必须使用不带BOM的UTF-8编码。 BOM（Byte Order Mark）是一个用来标识文件编码的特殊字符，在UTF-8编码中通常不需要。
• 类名必须使用StudlyCaps（驼峰命名法）。 比如MyClassName，AnotherClass。
• 常量必须使用UPPER_CASE_WITH_UNDERSCORES（大写字母和下划线）。 比如MY_CONSTANT，ANOTHER_CONSTANT。
• 命名空间必须和目录结构匹配。 这个很重要，后面讲PSR-4的时候会详细说。

下面是一个简单的例子，展示了PSR-1的一些规范：

<?php

namespace MyProjectMyPackage;

use PsrLogLoggerInterface;

class MyClass
{
    const MY_CONSTANT = 'hello world';

    private $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function doSomething()
    {
        $this->logger->info('Doing something');
    }
}

PSR-2：编码风格指南

PSR-2在PSR-1的基础上，进一步细化了编码风格，让代码看起来更加一致。它规定了：

• 缩进必须使用4个空格，不能使用Tab。 Tab党和空格党的战争终于结束了！
• 每行代码的长度不应超过120个字符，建议限制在80个字符以内。 太长的代码不利于阅读。
• 类、方法、控制结构的花括号必须另起一行。 这样看起来更清晰。
• 方法和函数的参数之间必须有一个空格，调用时也是。 比如myFunction($arg1, $arg2)。
• 控制结构（if、else、for、while等）的括号前后必须有一个空格。 比如if ($condition) { ... }。
• 类、方法、函数的可见性必须声明（public、protected、private）。 不要让别人猜你的意图。

下面是一个例子，展示了PSR-2的一些规范：

<?php

namespace MyProjectMyPackage;

use PsrLogLoggerInterface;

class MyClass
{
    const MY_CONSTANT = 'hello world';

    private $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function doSomething()
    {
        if ($this->isReady()) {
            $this->logger->info('Doing something');
        } else {
            $this->logger->warning('Not ready to do something');
        }
    }

    private function isReady()
    {
        return true;
    }
}

PSR-4：自动加载标准

PSR-4定义了如何根据类名自动加载对应的文件。这大大简化了代码的组织和加载过程。它的核心思想是：

• 命名空间必须和目录结构匹配。 比如，如果你的类名是MyProjectMyPackageMyClass，那么对应的文件路径应该是src/MyProject/MyPackage/MyClass.php。
• 必须有一个根命名空间。 根命名空间对应于项目中的一个目录。

要使用PSR-4，你需要：

1. 在composer.json文件中配置autoload。 告诉Composer你的根命名空间和对应的目录。
2. 使用Composer安装依赖。 Composer会自动生成一个vendor/autoload.php文件，你只需要在你的代码中引入这个文件，就可以使用自动加载了。

下面是一个composer.json的例子：

{
    "autoload": {
        "psr-4": {
            "MyProject\": "src/"
        }
    },
    "require": {
        "psr/log": "^1.0"
    }
}

在这个例子中，MyProject是根命名空间，它对应于src/目录。这意味着，如果你的类名是MyProjectMyPackageMyClass，那么对应的文件路径应该是src/MyProject/MyPackage/MyClass.php。

然后在你的PHP文件中，你需要引入vendor/autoload.php：

<?php

require_once __DIR__ . '/vendor/autoload.php';

use MyProjectMyPackageMyClass;
use PsrLogLoggerInterface;

$logger = new class implements LoggerInterface {
    public function emergency($message, array $context = array()) {}
    public function alert($message, array $context = array()) {}
    public function critical($message, array $context = array()) {}
    public function error($message, array $context = array()) {}
    public function warning($message, array $context = array()) {}
    public function notice($message, array $context = array()) {}
    public function info($message, array $context = array()) {}
    public function debug($message, array $context = array()) {}
    public function log($level, $message, array $context = array()) {}
};

$myClass = new MyClass($logger);
$myClass->doSomething();

PSR-7：HTTP消息接口

PSR-7定义了HTTP请求和响应的接口。它提供了一组标准的方法来处理HTTP消息，比如获取请求头、设置响应状态码、读取请求体等。

使用PSR-7的好处是，你可以轻松地在不同的框架和库之间交换HTTP消息，而不用担心兼容性问题。

PSR-7定义了以下几个核心接口：

• PsrHttpMessageRequestInterface: 表示HTTP请求。
• PsrHttpMessageResponseInterface: 表示HTTP响应。
• PsrHttpMessageStreamInterface: 表示HTTP消息体。
• PsrHttpMessageUriInterface: 表示URI。

下面是一个简单的例子，展示了如何使用PSR-7处理HTTP请求：

<?php

use PsrHttpMessageRequestInterface;
use PsrHttpMessageResponseInterface;
use PsrHttpMessageStreamInterface;
use ZendDiactorosResponseHtmlResponse;

function handleRequest(RequestInterface $request, ResponseInterface $response): ResponseInterface
{
    $uri = $request->getUri();
    $path = $uri->getPath();

    if ($path === '/') {
        $response = new HtmlResponse('<h1>Hello, World!</h1>');
    } else {
        $response = new HtmlResponse('<h1>Page Not Found</h1>', 404);
    }

    return $response;
}

// 假设你已经有了一个RequestInterface的实例 $request
// 假设你已经有了一个ResponseInterface的实例 $response

// $response = handleRequest($request, $response);

// echo $response->getBody();

在这个例子中，handleRequest函数接收一个RequestInterface和一个ResponseInterface作为参数，然后根据请求的URI返回一个ResponseInterface的实例。

PSR-11：容器接口

PSR-11定义了依赖注入容器的接口。依赖注入是一种设计模式，它可以帮助你更好地管理对象的依赖关系，使代码更加灵活和可测试。

依赖注入容器是一个对象，它可以负责创建和管理对象及其依赖项。你可以把依赖注入容器想象成一个“对象工厂”，它知道如何创建各种对象，并且知道这些对象需要哪些依赖项。

PSR-11定义了以下两个核心接口：

• PsrContainerContainerInterface: 定义了容器的基本操作，比如get()和has()。
• PsrContainerNotFoundExceptionInterface: 当容器找不到指定的对象时，抛出这个异常。

下面是一个简单的例子，展示了如何使用PSR-11实现依赖注入：

<?php

use PsrContainerContainerInterface;

class MyService
{
    private $logger;

    public function __construct(PsrLogLoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function doSomething()
    {
        $this->logger->info('Doing something');
    }
}

// 实现一个简单的容器
class MyContainer implements ContainerInterface
{
    private $services = [];

    public function get($id)
    {
        if (!$this->has($id)) {
            throw new Exception("Service not found: $id");
        }

        return $this->services[$id];
    }

    public function has($id)
    {
        return isset($this->services[$id]);
    }

    public function set($id, $service) {
        $this->services[$id] = $service;
    }
}

// 使用容器创建对象
$container = new MyContainer();

//注册Logger
$container->set('PsrLogLoggerInterface', new class implements PsrLogLoggerInterface {
    public function emergency($message, array $context = array()) {}
    public function alert($message, array $context = array()) {}
    public function critical($message, array $context = array()) {}
    public function error($message, array $context = array()) {}
    public function warning($message, array $context = array()) {}
    public function notice($message, array $context = array()) {}
    public function info($message, array $context = array()) {}
    public function debug($message, array $context = array()) {}
    public function log($level, $message, array $context = array()) {}
});

$container->set(MyService::class, new MyService($container->get('PsrLogLoggerInterface')));

$myService = $container->get(MyService::class);
$myService->doSomething();

在这个例子中，MyService依赖于LoggerInterface。我们使用一个容器来创建MyService的实例，并且将LoggerInterface的实例注入到MyService中。

PSR-12：扩展编码风格指南

PSR-12是对PSR-2的补充，它增加了一些新的规范，比如关于闭包、数组、控制结构等。PSR-12的目标是让代码风格更加一致，更加易于阅读。

PSR-12的一些新规范包括：

• 闭包必须使用function () use (...) { ... }格式。
• 数组的最后一个元素后面可以有一个逗号。 这样方便添加和删除元素。
• 控制结构（if、else、for、while等）的括号前后必须有一个空格。 这个在PSR-2中已经提到过，PSR-12再次强调。

如何实践PSR规范？

说了这么多，那么如何在实际项目中应用PSR规范呢？

1. 选择一个代码风格检查工具。 有很多工具可以帮助你检查代码是否符合PSR规范，比如PHP_CodeSniffer、PHPStan、Psalm等。
2. 配置你的IDE。 大多数IDE都支持PSR规范的代码格式化，你可以配置你的IDE自动格式化代码。
3. 在团队中推广PSR规范。 让所有团队成员都了解和遵守PSR规范，可以保证代码风格的一致性。
4. 使用Composer管理依赖。 Composer可以帮助你自动加载类，并且可以方便地安装和更新依赖包。

总结：PSR规范，让你的代码飞起来！

PSR规范是PHP开发中的一套最佳实践，它可以帮助你写出更加优雅、可维护、可互操作的代码。虽然学习和应用PSR规范需要一些时间和精力，但是它可以大大提高你的开发效率，并且可以让你避免很多不必要的麻烦。所以，不要犹豫，赶紧行动起来，让你的代码飞起来吧！

最后的最后，记住，规范是死的，人是活的。不要为了遵守规范而牺牲代码的可读性和可维护性。在实际项目中，你可以根据自己的需求进行适当的调整。但是，在大多数情况下，遵守PSR规范是一个明智的选择。

好了，今天的分享就到这里，希望对大家有所帮助！如果有什么问题，欢迎随时提问。 祝大家编码愉快！