笔记大全

PHP API框架中PSR规范有哪些

更新时间：2023-09-16

在PHP中，编写API时遵循PSR规范可以提高代码的可读性和可维护性。目前，PSR规范已经发布了多个版本，涵盖了HTTP请求和响应、自动加载、编码风格等多个方面。下面是一些常用的PSR规范：

PSR-1编码规范

PSR-1规范定义了PHP代码的基本编码规范。其中包括了一些基本的规则：命名空间必须和文件路径一致，类名必须采用驼峰式命名等。下面是一个遵循PSR-1规范的示例代码：

namespace MyApp;

class MyClass
{
    public function myMethod()
    {
        // 方法体
    }
}

PSR-4自动加载规范

PSR-4规范定义了PHP类自动加载规范，将类名映射到对应的文件路径上。这样在引用类时，可以让PHP自动加载所需的文件，提高了开发效率。下面是一个遵循PSR-4规范的示例代码：

// 自动加载类
function autoload($className)
{
    $className = ltrim($className, '\\');
    $fileName  = '';
    $namespace = '';
    if ($lastNsPos = strrpos($className, '\\')) {
        $namespace = substr($className, 0, $lastNsPos);
        $className = substr($className, $lastNsPos + 1);
        $fileName  = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
    }
    $fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
    require $fileName;
}
spl_autoload_register('autoload');

PSR-7 HTTP消息接口

PSR-7规范定义了HTTP消息接口，包括请求和响应消息。遵循PSR-7规范可以提高程序的兼容性和可扩展性，可以用多个框架和库的组件来构建应用程序。下面是一个遵循PSR-7规范的HTTP请求示例代码：

use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;

function handleRequest(ServerRequestInterface $request, ResponseInterface $response)
{
    // 获取HTTP方法和URI
    $method = $request->getMethod();
    $uri    = $request->getUri();

    // 构建响应
    $response->getBody()->write('Hello, PSR-7!');
    return $response;
}

PSR-12编码风格

PSR-12规范定义了PHP代码的编码风格，包括注释、命名、缩进等。采用一致的编码风格可以提高代码的可读性和可维护性。下面是一个遵循PSR-12规范的代码示例：

namespace App\Products;

use App\OrderItem;

class Product
{
    private $name;
    private $price;

    public function __construct($name, $price)
    {
        $this->name  = $name;
        $this->price = $price;
    }

    public function getName()
    {
        return $this->name;
    }

    public function getPrice()
    {
        return $this->price;
    }

    /**
     * 获取订单项
     *
     * @param int $quantity 商品数量
     *
     * @return OrderItem 订单项
     */
    public function getOrderItem($quantity)
    {
        return new OrderItem($this, $quantity);
    }
}

综上所述，遵循PSR规范可以提高PHP代码的可读性和可维护性，从而提高开发效率。其中PSR-1、PSR-4、PSR-7和PSR-12是应用较为广泛的规范。建议在编写PHP程序时遵循PSR规范。

c语言编程笔录