PSR

时间 2019-11-12

标签 psr 繁體版

原文原文链接

PSR是PHP Standards Recommendation的简称，这个是php-fig组织制定的一套规范。php

PSR-1html

PHP标签：
PHP代码必须放在<?php ?>标签或<?= ?>标签中。git

编码：
PHP文件必须使用无BOM的UTF-8编码。github

反作用：
一个PHP文件能够定义符号（好比类、函数、常量等），或者执行只有惟一反作用的操做（好比输出结果、处理数据等），可是不能同时作这两件事，尽可能是一个PHP文件的功能单一。在操做的时候尽可能把变量、类、函数的声明分开，经过include或require文件的方式来使用。（一个PHP文件一个做用）web

类的名称：
每一个类都有本身的命名空间，且都在顶级命名空间下，类名必须使用驼峰式 CamelCase数组

常量：闭包

常量必须所有是用大写，而且使用下划线（_）分开

类的方法：
类的方法必须使用小写字母开头的驼峰式（camelCase）命名

PSR-2

PHP文件必须使用Unix风格的换行符（LF， linefeed），最后要有一个空行，每行代码不该该超过80个字符，每行末尾不能有空格，每行只能有一条语句，能够在适当的地方添加空行提升代码的阅读性

不加上 ?>关闭标签，能够避免意料以外的输出错误，若是加上关闭标签，且在关闭标签后有空行，那么空行会被当成输出，致使意想不到的错误。

缩进：
必须以4个空格为缩进，不能使用制表符（Tab键）缩进。

关键字：
PHP的关键字必须使用小写，并且 true, false, 和 null也必须小写

命名空间和 use声明：
如今， namespace声明以后必需要有一个空行，并且 use声明必须放在 namespace以后，必须分别使用 use引入命名空间，并且 use后要有空行

namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

// ... additional PHP code ...

类的继承和实现：
extends和implements关键字必须和类名在同一行，类、接口和Traits定义体的起始括号应该在类名以后新起一行，结束括号也必须新起一行，例如框架

namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
    // constants, properties, methods
}

若是implements后面后不少类致使一行很长，能够依次将须要的类另起新行并缩进4个空格函数

namespace Vendor\Package;

use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;

class ClassName extends ParentClass implements
    \ArrayAccess,
    \Countable,
    \Serializable
{
    // constants, properties, methods
}

可见性：
类中的每一个属性和方法都要声明可见性，有public、private和protected，不能使用var关键词来声明，老版本的PHP会在私有属性前加上_，一行只能声明一个属性ui

方法：
类中的全部方法也应该定义可见性，方法名后面不能有空格，方法体的括号位置和类定义体的括号位置同样，都要新起一行，结束括号也要新起一行。方法参数的起始圆括号以后没有空格，结束括号以前也没有空格，有多个参数是，每一个参数的逗号后面加一个空格，例如：

namespace Vendor\Package;

class ClassName
{
    public function fooBarBaz($arg1, &$arg2, $arg3 = [])
    {
        // method body
    }
}

若是参数比较多，须要换行时，能够以下

namespace Vendor\Package;

class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []
    ) {
        // method body
    }
}

abstract、final和static：
如今，abstract、final必须在可见性修饰符以前，static声明必须放在可见性修饰符以后，例如：

namespace Vendor\Package;

abstract class ClassName
{
    protected static $foo;

    abstract protected function zim();

    final public static function bar()
    {
        // method body
    }
}

方法和函数的调用：
在调用方法和函数时，圆括号必须跟在函数名以后，函数的参数之间有一个空格：

bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3);

若是参数比较多，一行放不下时，以下处理：

$foo->bar(
    $longArgument,
    $longerArgument,
    $muchLongerArgument
);

PHP的控制结构：
PHP的控制结构包括if、else、elseif、switch、case、while、do while、for、foreach、try和catch。若是这些关键词后面有一对原括号，开始括号前必须有一个空格，与方法和类的定义体不一样，控制结构关键词后面的起始括号应该和控制结构关键词写在同一行，例如

$gorilla = new \Animals\Gorilla;
$ibis = new \Animals\StrawNeckedIbis;

if ($gorilla->isWake() === true) {
    do {
        $gorilla->beatChest();
    } while ($ibis->isAsleep() === true);
    
    $ibis->flyAway();
}

PHP闭包函数：
闭包函数在声明时，function关键词后必须有一个空格，同时use关键词先后也必须有一个空格。起始大括号不须要另起新行，详细的以下代码：

$closureWithArgs = function ($arg1, $arg2) {
    // body
};

$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
    // body
};

PSR-3规定了一套通用的日志记录器接口

为了符合PSR-3规范，框架必须实现该规范中的接口，这样能够更多的兼容第三方应用。PSR-3规范中包含了9个方法，每一个方法都对应了RFC 5424协议的一个日志级别，并且都接受两个参数$message和$context

<?php

namespace Psr\Log;

/**
 * Describes a logger instance
 *
 * The message MUST be a string or object implementing __toString().
 *
 * The message MAY contain placeholders in the form: {foo} where foo
 * will be replaced by the context data in key "foo".
 *
 * The context array can contain arbitrary data, the only assumption that
 * can be made by implementors is that if an Exception instance is given
 * to produce a stack trace, it MUST be in a key named "exception".
 *
 * See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
 * for the full interface specification.
 */
interface LoggerInterface
{
    /**
     * System is unusable.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function emergency($message, array $context = array());

    /**
     * Action must be taken immediately.
     *
     * Example: Entire website down, database unavailable, etc. This should
     * trigger the SMS alerts and wake you up.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function alert($message, array $context = array());

    /**
     * Critical conditions.
     *
     * Example: Application component unavailable, unexpected exception.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function critical($message, array $context = array());

    /**
     * Runtime errors that do not require immediate action but should typically
     * be logged and monitored.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function error($message, array $context = array());

    /**
     * Exceptional occurrences that are not errors.
     *
     * Example: Use of deprecated APIs, poor use of an API, undesirable things
     * that are not necessarily wrong.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function warning($message, array $context = array());

    /**
     * Normal but significant events.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function notice($message, array $context = array());

    /**
     * Interesting events.
     *
     * Example: User logs in, SQL logs.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function info($message, array $context = array());

    /**
     * Detailed debug information.
     *
     * @param string $message
     * @param array $context
     * @return void
     */
    public function debug($message, array $context = array());

    /**
     * Logs with an arbitrary level.
     *
     * @param mixed $level
     * @param string $message
     * @param array $context
     * @return void
     */
    public function log($level, $message, array $context = array());
}

关于message参数：

$message必须是一个字符串或者是含有__toString()方法的对象，$message应该包含占位符，例如{placeholder_name}，占位符由{、占位符名称和}组成，不能包含空格，占位符名称能够由A-Z, a-z, 0-9, _组成，第三方实现能够用$context参数来替换占位符，占位符名称必须和$context数组的key对应。以下例子是使用$context中的值替换$message中的占位符：

/**
 * Interpolates context values into the message placeholders.
 */
function interpolate($message, array $context = array())
{
    // build a replacement array with braces around the context keys
    $replace = array();
    foreach ($context as $key => $val) {
        // check that the value can be casted to string
        if (!is_array($val) && (!is_object($val) || method_exists($val, '__toString'))) {
            $replace['{' . $key . '}'] = $val;
        }
    }

    // interpolate replacement values into the message and return
    return strtr($message, $replace);
}

// a message with brace-delimited placeholder names
$message = "User {username} created";

// a context array of placeholder names => replacement values
$context = array('username' => 'Bolivar');

// echoes "User Bolivar created"
echo interpolate($message, $context);

关于context参数：

$context是一个数组参数，用于构造复杂的日志消息，$context中的值不能跑出任何PHP异常或错误。若是$context中包含Exception对象，则该对象的key必须为exception。

PSR-4
PSR-4规范描述了一个标准的自动加载器策略，指在运行时按需查找PHP类、接口或 Traits。支持PSR-4自动加载器标准的PHP组建和框架，使用同一个自动加载器就能找到相关代码，而后将其载入PHP解释器。有了这个功能，就能够把现代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;
    }
});

先记着，后续再理解！

原文地址：https://www.jianshu.com/p/b33155c15343

1. PHP推荐标准编码规范(PSR-1,PSR-2,PSR-3,PSR-4,PSR-12)
2. PSR
3. PSR-0与PSR-4区别
4. PSR-4
5. psr-0 和 psr-4的区别
6. php-psr-chinese psr规范总结
7. PSR规范
8. PHP中PSR
9. psr的规范
10. 2021MM PSR解读
更多相关文章...
• Composer 安装与使用