PSR 规范 学习
PSR 是 PHP Standard Recommendations 的简写，是由PHPFIG组织制定的PHP规范,是PHP开发的实践标准
PSR -0已废弃 这里就不作学习了
PSR -1 基本代码规范
-
PHP代码必须以 <?php 或者<?开始
-
PHP 代码文件必须以不带BOM头的UTF-8编码格式 什么是BOM头?我遇到的情况就是多继承关系的类在父级多输出了空格(FTP等工具自动加上的) 然后子类 ajax请求时会带上空格 以至于输出不了 (当初大商创验证码这个问题 查问题查的脑壳疼)
-
PHP代码中应该只 定义 类 方法 ，常量等申明 或者 包含文件 修改配置文件等 二者只能选其一
-
类的命名规范必须符合 PSR -4的自动加载规范
-
类的命名必须遵守 大写开头的驼峰命名法 例如 AdminBase
-
类中常量命名必须大写 多个单词间 下划线连接 应该是所有常量都这么要求
-
类中方法必须遵守 小写字母开头加驼峰命名法命名规范 例如 getUserInfo
-
普通方法 已小写字母命名 多个单词下划线连接 例如 get_dir 这条是我自己加上的
PSR -2 编码风格规范
-
代码必须遵循 PSR -1 中的代码
-
代码缩进 使用四个空格符的缩进 而不是使用Tab键
-
每行的字符数应保持在80个之内，不可多余120 查询多字段的SQL语句怎么办？select *？
-
类和方法开始的大括号 必须写在函数申明之后另成一行，结束大括号也必须在函数体后自成一行 这一点 好像大多数人都没有遵守 自成一行有时候会感觉怪怪的，找不到方法开始的位置
-
每个namespace 和use 申明语句块后面 必须插入一个空白
-
类的属性和方法 必须添加访问修饰符(public protected private ),abstract 以及final 必须 申明在访问修饰符之前 ,而 static 必须申明在访问修饰符之后
-
控制结构的关键字后必须有一个空格符 ，二调用方法或函数时则一定不能有 什么是控制结构关键字 ？if else 等就是我们最常用的控制结构关键字
-
控制结构的开始大括号 必须写在声明的同一行 ，而结束大括号 必须在函数主体之后自成一行 这一点区别于类和方法的大括号
-
控制结构开始大括号和结束大括号之前 一定不能有空格符
-
PHP文件必须使用 Unix LF(linefeed) 作为行的结束符
-
PHP文件必须以一个空白行作为结束
-
纯PHP代码文件必须省略最后的?>结束标签
PSR -3日志接口规范
1. 规范说明
1.1 基本规范
-
LoggerInterface 接口对外定义了八个方法，分别用来记录 RFC 5424 中定义的八个等级的日志：debug、 info、 notice、 warning、 error、 critical、 alert 以及 emergency 。
-
第九个方法 —— log，其第一个参数为记录的等级。可使用一个预先定义的等级常量作为参数来调用此方法，必须 与直接调用以上八个方法具有相同的效果。如果传入的等级常量参数没有预先定义，则 必须 抛出 Psr\Log\InvalidArgumentException 类型的异常。在不确定的情况下，使用者 不该 使用未支持的等级常量来调用此方法。
1.2 记录信息
-
以上每个方法都接受一个字符串类型或者是有 __toString() 方法的对象作为记录信息参数，这样，实现者就能把它当成字符串来处理，否则实现者 必须 自己把它转换成字符串。
-
记录信息参数 可以 携带占位符，实现者 可以 根据上下文将其它替换成相应的值。其中占位符 必须 与上下文数组中的键名保持一致。占位符的名称 必须 由一个左花括号 { 以及一个右括号 } 包含。但花括号与名称之间 一定不可有空格符。占位符的名称 应该 只由 A-Z、a-z、0-9、下划线 _、以及英文的句号 . 组成，其它字符作为将来占位符规范的保留。实现者 可以 通过对占位符采用不同的转义和转换策略，来生成最终的日志。而使用者在不知道上下文的前提下，不该 提前转义占位符。
以下是一个占位符使用的例子：
/** * 用上下文信息替换记录信息中的占位符 */ function interpolate($message, array $context = array()) { // 构建一个花括号包含的键名的替换数组 $replace = array(); foreach ($context as $key => $val) { $replace['{' . $key . '}'] = $val; } // 替换记录信息中的占位符，最后返回修改后的记录信息。 return strtr($message, $replace); } // 含有带花括号占位符的记录信息。 $message = "User {username} created"; // 带有替换信息的上下文数组，键名为占位符名称，键值为替换值。 $context = array('username' => 'bolivar'); // 输出 "Username bolivar created" echo interpolate($message, $context);
1.3 上下文
-
每个记录函数都接受一个上下文数组参数，用来装载字符串类型无法表示的信息。它 可以 装载任何信息，所以实现者 必须 确保能正确处理其装载的信息，对于其装载的数据， 一定不可 抛出异常，或产生PHP出错、警告或提醒信息（error、warning、notice）。
-
如需通过上下文参数传入了一个 Exception 对象，必须 以 exception 作为键名。
记录异常信息是很普遍的，所以如果它能够在记录类库的底层实现，就能够让实现者从异常信息中抽丝剥茧。
当然，实现者在使用它时，必须 确保键名为 exception 的键值是否真的是一个 Exception，毕竟它 可以 装载任何信息。
1.4 助手类和接口
-
Psr\Log\AbstractLogger 类使得只需继承它和实现其中的 log 方法，就能够很轻易地实现 LoggerInterface 接口，而另外八个方法就能够把记录信息和上下文信息传给它。
-
同样地，使用 Psr\Log\LoggerTrait 也只需实现其中的 log 方法。不过，需要特别注意的是，在 traits 可复用代码块还不能实现接口前，还需要 implement LoggerInterface。
-
在没有可用的日志记录器时，Psr\Log\NullLogger 接口 可以 为使用者提供一个备用的日志「黑洞」。不过，当上下文的构建非常消耗资源时，带条件检查的日志记录或许是更好的办法。
-
Psr\Log\LoggerAwareInterface 接口仅包括一个
setLogger(LoggerInterface $logger) 方法，框架可以使用它实现自动连接任意的日志记录实例。
-
Psr\Log\LoggerAwareTrait trait可复用代码块可以在任何的类里面使用，只需通过它提供的 $this->logger，就可以轻松地实现等同的接口。
-
Psr\Log\LogLevel 类装载了八个记录等级常量。
2. 包
上述的接口、类和相关的异常类，以及一系列的实现检测文件，都包含在 psr/log 文件包中。
3. Psr\Log\LoggerInterface
<?php namespace Psr\Log; /** * 日志记录实例 * * 日志信息变量 —— message，**必须** 是一个字符串或是实现了 __toString() 方法的对象。 * * 日志信息变量中 **可以** 包含格式如 “{foo}” (代表 foo) 的占位符， * 它将会由上下文数组中键名为「foo」的键值替代。 * * 上下文数组可以携带任意的数据，唯一的限制是，当它携带的是一个 exception 对象时，它的键名 **必须** 是 "exception"。 * * 详情可参阅： https://github.com/PizzaLiu/PHP-FIG/blob/master/PSR-3-logger-interface-cn.md */ interface LoggerInterface { /** * 系统不可用 * * @param string $message * @param array $context * @return null */ public function emergency($message, array $context = array()); /** * **必须** 立刻采取行动 * * 例如：在整个网站都垮掉了、数据库不可用了或者其他的情况下， **应该** 发送一条警报短信把你叫醒。 * * @param string $message * @param array $context * @return null */ public function alert($message, array $context = array()); /** * 紧急情况 * * 例如：程序组件不可用或者出现非预期的异常。 * * @param string $message * @param array $context * @return null */ public function critical($message, array $context = array()); /** * 运行时出现的错误，不需要立刻采取行动，但必须记录下来以备检测。 * * @param string $message * @param array $context * @return null */ public function error($message, array $context = array()); /** * 出现非错误性的异常。 * * 例如：使用了被弃用的API、错误地使用了API或者非预想的不必要错误。 * * @param string $message * @param array $context * @return null */ public function warning($message, array $context = array()); /** * 一般性重要的事件。 * * @param string $message * @param array $context * @return null */ public function notice($message, array $context = array()); /** * 重要事件 * * 例如：用户登录和SQL记录。 * * @param string $message * @param array $context * @return null */ public function info($message, array $context = array()); /** * debug 详情 * * @param string $message * @param array $context * @return null */ public function debug($message, array $context = array()); /** * 任意等级的日志记录 * * @param mixed $level * @param string $message * @param array $context * @return null */ public function log($level, $message, array $context = array()); }
4. Psr\Log\LoggerAwareInterface
<?php namespace Psr\Log; /** * logger-aware 定义实例 */ interface LoggerAwareInterface { /** * 设置一个日志记录实例 * * @param LoggerInterface $logger * @return null */ public function setLogger(LoggerInterface $logger); }
5. Psr\Log\LogLevel
<?php namespace Psr\Log; /** * 日志等级常量定义 */ class LogLevel { const EMERGENCY = 'emergency'; const ALERT = 'alert'; const CRITICAL = 'critical'; const ERROR = 'error'; const WARNING = 'warning'; const NOTICE = 'notice'; const INFO = 'info'; const DEBUG = 'debug'; }
PSR -4 自动加载规范
一 结构
-
完整的类名必须要有一个 顶级命名空间 被称为 “vendor namespace ” 完整的类名示例 \命名空间\子命名空间\类名
-
完整的类名 可以有一个或多个命名空间
-
完整的类名 必须有一个最终的类名
-
完整的类名中任意一部分中的下划线都是没有特殊含义的
-
完整的类名 可以有任意大小写字母组成
-
所有类名必须是大小写敏感的
二 载入文件
-
完整的命名中，去掉最前面的命名空间分隔符 ，前面连续的一个或者多个子命名空间，最为命名空间前缀，其必须与至少一个文件及目录相对应 。
-
紧接命名空间前缀的子命名空间必须与相应的文件基目录相匹配，其中命名空间分隔符作为目录分隔符 也就是说例如 think\index\text\index 除了前面的think 至少有一个与文件目录 对应 一般来说 think后面 就是文件目录(个人见解)
-
末尾的类名 必须与相对应的以.php为后缀的文件同名
-
自动加载器(autoloader)的实现一定不可以抛出异常 ，一定不可以触发任意一级别的错误信息以及不应有返回值
PSR 规范暂时就这么多 其他的估计一时半会也用不上 ，所有 PSR 规范详见：https://psr.phphub.org/
浙公网安备 33010602011771号