PSR编码规范 https://kdocs.cn/l/s2Ln0b3Jp?f=111
编码规范
一. 基本约定
1、源文件
（1）、纯PHP代码源文件只使用 <?php 标签，省略关闭标签 ?> ；
（2）、源文件中PHP代码的编码格式必须是无BOM的UTF-8格式；
（3）、使用Unix LF（换行符）作为行结束符；
（4）、一个源文件只做一种类型的声明，即，这个文件专门用来声明Class, 那个文件专门用来设置配置信息，别混在一起写；(如class和interface不能混写在一个源文件中)
2、缩进
使用Tab键来缩进，每个Tab键长度设置为4个空格,并且不得使用制表符进行缩进；(PhpStorm快捷键Ctrl+Alt+L);
3、行
一行推荐的是最多写120个字符，多于这个字符就应该换行了，一般的编辑器是可以设置的；在非空白行的末尾不得有尾随空格；可以添加空行以提高可读性并指示相关的代码块；每行不得超过一个语句；
4、关键字 和 True/False/Null
PHP的关键字，必须小写，boolean值：true，false，null 也必须小写。
下面是PHP的“关键字”，必须小写：
'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach', 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private', 'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor'
5、命名
（1）、类名 使用大驼峰式（StudlyCaps）写法；
（2）、（类的）方法名 使用小驼峰（cameCase）写法；
（3）、函数名使用 小写字母 + 下划线 写法，如 function http_send_post()；
（4）、变量名 使用小驼峰写法，如 $userName；
6、代码注释标签
如 函数注释、变量注释等，常用标签有 @package、@var、@param、@return...必须遵守 phpDocument 标签规则，不要另外去创造新的标签，
7、业务模块
（1）、涉及到多个数据表 更新/添加 操作时，最外层要用事务，保证数据库操作的原子性；
（2）、Model层，只做简单的数据表的查询；
（3）、业务逻辑统一封装到 Logic(逻辑)层；
（4）、控制器只做URL路由，不要当作 业务方法 调用；
（5）、控制器层不能出现SQL操作语句，如 ThinkPHP框架的 where()、order() 等模型方法，
即，控制器中，不要出现类似这样的SQL语句：D('XXX')->where()->order()->limit()->find();
where()、order()、limit() 等SQL方法只能出现在 Model层、业务层！
二、代码样式风格
1、命名空间(Namespace) 和 导入(Use)声明
(1)命名空间(namespace)的声明后面必须有一行空行；
(2)所有的导入(use)声明必须放在命名空间(namespace)声明的下面；
(3)一句声明中，必须只有一个导入(use)关键字；
(4)在导入(use)声明代码块后面必须有一行空行；
2、类(class)，属性(property)和方法(method)
（1）、继承(extends) 和实现(implement) 必须和类名写在一行。
（2）、打开类的大括号必须在下一行，并且关闭括号必须
在主体之后的下一行;
（3）、打开方法的括号必须在下一行，并且关闭括号必须
在主体后面的下一行;
（4）、必须在所有属性和方法上声明可见性; abstract并且
final必须在能见度之前宣布; static必须在能见度后宣布;方法中如果有多个参数，第一个参数后紧接“,” ，再加一个空格(即在参数列表中，每个逗号前不得有空格，每个逗号后必须有一个空。),如果参数有默认值，“=”左右各有一个空格分开(具有默认值的方法参数必须位于参数
列表的末尾)。
(5)方法名称不得在方法名称后面用空格声明。在括弧必须继续自己的路线，和右括号必须继续下去了下一行后的身体。在左括号后面不能有空格，并且在右括号之前不能有空格。
(6)当用到抽象(abstract)和终结(final)来做类声明时，它们必须放在可见性声明 （public 还是protected还是private）的前面。而当用到静态(static)来做类声明时，则必须放在可见性声明的后面。
(7)在进行方法或函数调用时，方法或函数名称与左括号之间不能有空格，在左括号后面不能有空格，并且在右括号之前不能有空格。在参数列表中，每个逗号前不得有空格，每个逗号后必须有一个空格。
参考1：
|
1 2 3 4 5 6 7 8 |
<?php namespace Lib\Databaes;
class Mysql extends ParentClass implements \PDO, \DB { // 写一行 public getInfo($name, $age, $gender = 1) { // 参数之间有一个空格。默认参数的“=”左右各有一个空格，) 与 { 之间有一个空格
} } |
参考2:
|
1 2 3 4 5 6 7 8 9 10 11 |
<?php namespace Vendor\Package;
abstract class ClassName { protected static $foo; // static放后面 abstract protected function zim(); // abstract放前面
final public static function bar() { // final放前面，static放最后。 // 方法主体部分 } } |
参考3：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
<?php namespace library\Model;
use library\Helper\ImageHelper; use library\Logic\UserMainLogic;
/** * 用户表 数据模型 * * @package library\Model */ class UserMainModel extends BasicModel { /** * 获得用户统计信息 * * @param int $userId 用户ID * @return array */ public function getUserCard($userId) { $userId = intval($userId); return UserMainLogic::instance()->getUserCard($userId); }
/** * 根据Id 获取用户信息 * * @param int $userId 用户Id * @param string $field 显示字段 * @return array */ public function getByUserId($userId = 0, $field = '*') { if (empty($userId)) { return array(); }
$where = array('id' => $userId); $info = $this->field($field)->where($where)->find();
if (isset($info['image']) && isset($info['sex'])) { $info['image'] = ImageHelper::GetImageUrl($info['image'], $info['sex']); }
return $info; } } |
3、控制结构
控制接口，就是 if else while switch等。这一类的写法规范也是经常容易出现问题的，也要规范一下。
（1）、if，elseif，else写法，直接上规范代码吧：
|
1 2 3 4 5 6 7 8 |
<?php if ($expr1) { // if 与 ( 之间有一个空格，) 与 { 之间有一个空格
} elseif ($expr2) { // elesif 连着写，与 ( 之间有一个空格，) 与 { 之间有一个空格
} else { // else 左右各一个空格
} |
（2）、switch，case 注意空格和换行，还是直接上规范代码：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
<?php switch ($expr) { // switch 与 ( 之间有一个空格，) 与 { 之间有一个空格 case 0: echo 'First case, with a break'; // 对齐 break; // 换行写break，也对齐。 case 1: echo 'Second case, which falls through'; // no break case 2: case 3: case 4: echo 'Third case, return instead of break'; return; default: echo 'Default case'; break; } |
（3）、while，do while 的写法也是类似，上代码：
|
1 2 3 4 5 6 7 8 |
<?php while ($expr) { // while 与 ( 之间有一个空格， ) 与 { 之间有一个空格
}
do { // do 与 { 之间有一个空格
} while ($expr); // while 左右各有一个空格 |
（4）、for的写法
|
1 2 3 4 |
<?php for ($i = 0; $i < 10; $i++) { // for 与 ( 之间有一个空格，二元操作符 "="、"<" 左右各有一个空格，) 与 { 之间有一个空格
} |
（5）、foreach的写法
|
1 2 3 4 |
<?php foreach ($iterable as $key => $value) { // foreach 与 ( 之间有一个空格，"=>" 左右各有一个空格，) 与 { 之间有一个空格
} |
（6）、try catch的写法
|
1 2 3 4 5 6 7 8 |
<?php try { // try 右边有一个空格
} catch (FirstExceptionType $e) { // catch 与 ( 之间有一个空格，) 与 { 之间有一个空格
} catch (OtherExceptionType $e) { // catch 与 ( 之间有一个空格，) 与 { 之间有一个空格
} |
4、注释
（1）、行注释
单行注释应该和代码合在一起;// 后面需要加一个空格；
如果 // 前面有非空字符，则 // 前面需要加一个空格；
大块的注释和代码之间应该留一个空行。大的代码块之间也应该留空行，形成代码段落。
（2）、函数注释
参数名、属性名、标签的文本 上下要对齐；
在第一个标签前加一个空行；
5、空格
（1）、赋值操作符（=，+= 等）、逻辑操作符（&&，||）、等号操作符（==，!=）、关系运算符（<，>，<=，>=）、按位操作符（&，|，^）、连接符（.） 左右各有一个空格；
（2）、if，else，elseif，while，do，switch，for，foreach，try，catch，finally 等 与 紧挨的左括号“(”之间有一个空格；
（3）、函数、方法的各个参数之间，逗号（","）后面有一个空格；
6、数组 的书写格式
只有一个键值对时，就写成一行：
|
1 |
$where = array('id' => 789); |
有多个（二个或二个以上）键值对时，就换行：
|
1 2 3 4 |
$where = array( 'id' => 789, 'user_name' => '52php' ); |
所有左花括号 { 都不换行，并且 ｛ 紧挨着的下方，一定不是空行！
