我也学php:编码规范/翻译自PSR

PHP社区百花齐放,拥有大量的函数库、框架和组件。PHP开发者通常会在自己的项目中使用若干个外部库,因而PHP代码遵循或尽量接近同一个代码风格就非常重要,可以让开发者方便地把多个代码库集成在自己的项目中。

框架互操作组(即PHP标准组)发布了一系列代码风格推荐标准,即PSR-0,PSR-1,PSR-2和PSR-3。 不要让这些名称所混淆,这些推荐仅是一些被其它项目所遵循的规则,如Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Lithium等,你可以把这些规则用在自己的项目中,或者继续使用你自己的风格。

通常情况下,你的PHP代码应该遵循其中一项或多项标准,从而其他开发者可以方便地阅读和使用你的代码。这些标准都是在前一个标准 上附加新的规则,所以使用PSR-1就同时要求遵循PSR-0,但可以不遵循PSR-2。

可以使用PHP_CodeSniffer来检查代码是否符合这些标准,文本编辑器插件Sublime Text 2还能提供实时检查。如果不符合规范,可以使用Fabien Potencier提供的工具PHP Coding Standards Fixer自动修复,不用自己手工修复。

PSR完整地址为:https://github.com/php-fig/fig-standards

PSR-0:类命名与autoloader之间的规范

PSR-0主要是对namespace和class命名规范进行约束,这个规范主要作用是使得autoloader函数能够根据完整的类名从硬盘中自动加载指定的类文件,其中涉及到的“强制”要求有以下几点:

  1. 完整的namespace和class命名必须符合结构:\<Vendor Name>\(<Namespace>\)*<Class Name>.php
  2. Vendor Name(开发者信息)必须是最顶层的namespace,这样可以防止自己类库与其他开发者类库出现命名冲突
  3. (<Namespace>\)*后面带有一个正则表达式中的星号,代表Namespace可以有0个或者多个
  4. 每个Namespace之间的分隔符在autoloader函数中,将会被转化为目录分隔符DIRECTORY_SEPARATOR
  5. Class Name即类名称中允许出现_(下划线),但是在autoloader函数中,该下划线也会转化为DIRECTORY_SEPARATOR
  6. 在autoloader函数中通过namespace和class命名来加载类文件时,类文件的后缀名必须是.php
  7. 对其中的英文字母大小写没有特殊要求

如果符合了上述要求,那么autoload代码就如下:

  1. <?php
  2. function autoload($className)
  3. {
  4. $className = ltrim($className, ‘\\‘);
  5. $fileName  = ‘‘;
  6. $namespace = ‘‘;
  7. if ($lastNsPos = strrpos($className, ‘\\‘)) {
  8. $namespace = substr($className, 0, $lastNsPos);
  9. $className = substr($className, $lastNsPos + 1);
  10. $fileName  = str_replace(‘\\‘, DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
  11. }
  12. $fileName .= str_replace(‘_‘, DIRECTORY_SEPARATOR, $className) . ‘.php‘;
  13. require $fileName;
  14. }
  1. \Doctrine\Common\IsolatedClassLoader => /path/to/project/lib/vendor/Doctrine/Common/IsolatedClassLoader.php
  2. \Symfony\Core\Request => /path/to/project/lib/vendor/Symfony/Core/Request.php
  3. \Zend\Acl => /path/to/project/lib/vendor/Zend/Acl.php
  4. \Zend\Mail\Message => /path/to/project/lib/vendor/Zend/Mail/Message.php
  5. \namespace\package\Class_Name => /path/to/project/lib/vendor/namespace/package/Class/Name.php
  6. \namespace\package_name\Class_Name => /path/to/project/lib/vendor/namespace/package_name/Class/Name.php

PSR-1:简单编码规范

原文中的 "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" 等关键字含义请参与RFC 2119文档。并且本文中不会对这些关键字进行翻译。

  1. 代码文件中MUST使用<?php ?>和<?= ?>两个代码标签;文件编码MUST使用UTF-8必须不包含BOM。
  2. 单个代码文件SHOULD要么用于声明类,函数或者常量等符号,要么用于进行一些会产生副作用(Side effects)的计算操作,比如输出和改变全局的设置。SHOULD NOT(不建议)同时在一个单文件中完成这两项工作。
  3. 命名空间和类名称MUST符合PSR_0规范
  4. 类名称声明MUST符合StudlyCaps(大写骆驼拼写法)
  5. 类中常量MUST使用全部大写,并使用_(下划线)作为分割符
  6. 函数名称声明MUST符合camelCase(小写骆驼拼写法)

PSR-2:编码风格

针对PHP文件

  1. 所有的PHP文件MUST使用Unix的LF作为行结尾
  2. 所有的PHP文件MUST是以单一的空白行结尾
  3. 在纯PHP文件中MUST省略文件结尾的?>标记

针对文件行

  1. MUST NOT对每一行的长度进行硬限制(Hard Limit)
  2. 每一个行长度软限制(Soft Limit)MUST为120个字符。如果样式检查的软件发现文件不符合该软限制时MUST给予warn但是MUST NOT给予error
  3. 每一行SHOULD NOT 超过80个字符。如果实在是超过80个字符,SHOULD分割为多行
  4. 每一个非空白行后面MUST NOT有多余的尾随空格
  5. 空白行 may(可以)被添加来提高代码的可读性,以及用于分割不相关代码
  6. 每一行MUST NOT超过一条语句
  7. 在命名空间声明行后,MUST有一个空白行

文本缩进

  1. 代码MUST 使用4个空格来进行缩进,MUST NOT使用tabs

PHP关键字大小写

  1. PHP关键字包括true, false,null在内,MUST 使用小写

命名空间和Use声明

  1. 在命名空间声明行后,MUST有一个空白行
  2. Use语句MUST在命名空间声明行后面
  3. 每一行MUST只能有一个Use声明
  4. 所有的Use语句后面,必须有一个空白行
  1. <?php
  2. namespace Vendor\Package;
  3. use FooClass;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6. // ... additional PHP code ...

类声明:Extents和implements

  1. 类声明的{}大括号必须在两个独立行中
  2. 如果类声明中有extends和implements,那么它们MUST与类声明在同一行
  3. 如果同时有extends与implements,那么必须先写extends,再写implements
  4. 如果implements列表有多个,may把他们分割到多行中,每一行单独缩进。如果这样做,那么第一个implements就MUST在新行,并且每个implements单独占用一行。
  1. <?php
  2. namespace Vendor\Package;
  3. use FooClass;
  4. use BarClass as Bar;
  5. use OtherVendor\OtherPackage\BazClass;
  6. class ClassName extends ParentClass implements
  7. \ArrayAccess,
  8. \Countable,
  9. \Serializable
  10. {
  11. // constants, properties, methods
  12. }

类声明/函数声明:abstract,final,static

  1. 如果一个类或者函数在声明时,其中包含abstract,final,static三个关键字,那么与可见性关键字(public private protected)之间顺序为:abstarct 和final Must在可见性关键字之前;而static MUST在可见性关键字之后


类属性

  1. 每一个类属性MUST指定它们的可见性
  2. MUST NOT使用var关键字来声明一个类属性
  3. 每一条语句MUST声明单个属性
  4. SHOULD NOT使用_(下划线)作为属性名称的开头来表示属性为protected或private

方法声明与方法参数

  1. 每一个方法MUST显示指定它们的可见性
  2. SHOULD NOT使用_(下划线)作为方法名称的开头来表示方法为protected或private
  3. 方法名称后面MUST NOT带有空格。并且方法的大括号{}MUST分别在单独的行
  4. 方法的括号()内部的前后MUST NOT有空格,
  5. 方法的每一个参数后面MUST NOT 有空格,多个参数之间的逗号后面MUST 有空格。
  6. 含有默认值的参数MUST 放到参数类别后面
  7. 参数列表may被分割为多行,每行缩进一次;(括号紧跟在行数名后面,)在单独一行,并且与函数声明缩进对齐,后面紧跟一个空格和函数的大括号{。每一个参数MUST在单独行。
  1. <?php
  2. namespace Vendor\Package;
  3. class ClassName
  4. {
  5. public function foo($arg1, &$arg2, $arg3 = [])
  6. {
  7. // method body
  8. }
  9. public function aVeryLongMethodName(
  10. ClassTypeHint $arg1,
  11. &$arg2,
  12. array $arg3 = []
  13. ) {
  14. // method body
  15. }
  16. }

函数调用

  1. 在调用函数时,函数名称与(之间MUST NOT有空格,(和)与参数之间MUST NOT 有空格。
  2. 方法的每一个参数后面MUST NOT 有空格,多个参数之间的逗号后面MUST 有空格。
  3. 调用参数过长时,May把参数分为多行,每一行一个参数,并且拥有一个缩进。函数的(紧跟在函数名后,)最后一个参数后面的一行,并且不能有缩进。
  1. <?php
  2. bar();
  3. $foo->bar($arg1);
  4. Foo::bar($arg2, $arg3);
  5. $foo->bar(
  6. $longArgument,
  7. $longerArgument,
  8. $muchLongerArgument
  9. );

控制结构

PHP中包含if/else/elseif,switch/case,while/dowhile,for,foreach,try/catch六种控制结构,它们的编码规范有一部分共性:

  1. 控制关键字后面MUST有一个空格
  2. 控制结构开括号(后面MUST NOT有空格
  3. 控制结构闭括号)前面MUST NOT有空格
  4. 控制结构开括号(与大括号}之间MUST有一个空格
  5. 控制结构体MUST缩进一次
  6. 控制结构闭大括号}必须在控制结构体后单独的一行

它们之间除了上述共性以外,还有各自的规范。

控制结构:if/elseif/else

具体的if编码规范见下述实例

  1. <?php
  2. if ($expr1) {
  3. // if body
  4. } elseif ($expr2) {
  5. // elseif body
  6. } else {
  7. // else body;
  8. }

请注意上述的空格,括号开闭的位置。

控制结构:switch/case

具体的switch编码规范见下述实例,请注意它们的空格,括号开闭的位置。

  1. <?php
  2. switch ($expr) {
  3. case 0:
  4. echo ‘First case, with a break‘;
  5. break;
  6. case 1:
  7. echo ‘Second case, which falls through‘;
  8. // no break
  9. case 2:
  10. case 3:
  11. case 4:
  12. echo ‘Third case, return instead of break‘;
  13. return;
  14. default:
  15. echo ‘Default case‘;
  16. break;
  17. }
  1. 每一个case MUST相对于switch有一个缩进。
  2. 如果一个case没有break或者return之类中断语句,那么必须在它相应位置注视// no break

控制结构:while/dowhile

具体的while编码规范见下述实例,请注意它们的空格,括号开闭的位置。

  1. <?php
  2. while ($expr) {
  3. // structure body
  4. }
  5. do {
  6. // structure body;
  7. } while ($expr);

控制结构:for

具体的for编码规范见下述实例,请注意它们的空格,括号开闭的位置。

  1. <?php
  2. for ($i = 0; $i < 10; $i++) {
  3. // for body
  4. }

控制结构:foreach

具体的foreach编码规范见下述实例,请注意它们的空格,括号开闭的位置。

  1. foreach ($iterable as $key => $value) {
  2. // foreach body
  3. }

控制结构:try/catch

具体的try编码规范见下述实例,请注意它们的空格,括号开闭的位置。

  1. <?php
  2. try {
  3. // try body
  4. } catch (FirstExceptionType $e) {
  5. // catch body
  6. } catch (OtherExceptionType $e) {
  7. // catch body
  8. }

闭包

  1. function和use关键字与括号(之间MUST有一个空格
  2. 闭包的大开括号MUST与括号)在空一行,并且之间有一个空格
  3. 闭包的大闭括号MUST与闭包实体部分分割开,在单独一行;并且与闭包语句‘;’之间没有空格
  4. 闭包的function 和use的参数与括号()之间MUST NOT有空格,并且多个参数之间的‘,’前面没有空格,后面有一个空格
  5. 如果闭包的参数有默认值,那么它MUST放在参数列表的后面
  6. 闭包的参数列表可以分多行,具体的请参考实例
  1. <?php
  2. $closureWithArgs = function ($arg1, $arg2) {
  3. // body
  4. };
  5. $closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
  6. // body
  7. };
  8. $longArgs_noVars = function (
  9. $longArgument,
  10. $longerArgument,
  11. $muchLongerArgument
  12. ) {
  13. // body
  14. };
  15. $noArgs_longVars = function () use (
  16. $longVar1,
  17. $longerVar2,
  18. $muchLongerVar3
  19. ) {
  20. // body
  21. };
  22. $longArgs_longVars = function (
  23. $longArgument,
  24. $longerArgument,
  25. $muchLongerArgument
  26. ) use (
  27. $longVar1,
  28. $longerVar2,
  29. $muchLongerVar3
  30. ) {
  31. // body
  32. };
  33. $longArgs_shortVars = function (
  34. $longArgument,
  35. $longerArgument,
  36. $muchLongerArgument
  37. ) use ($var1) {
  38. // body
  39. };
  40. $shortArgs_longVars = function ($arg) use (
  41. $longVar1,
  42. $longerVar2,
  43. $muchLongerVar3
  44. ) {
  45. // body
  46. };

PSR-3:日志接口

PSR-3是关于系统日志的接口的开发规范,先不翻译,后面复习php日志处理再回来翻译

链接:https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md

时间: 2024-10-14 02:44:47

我也学php:编码规范/翻译自PSR的相关文章

PSR : php编码规范

诸王混战 关于开发标准这块,可以说一直都是风格迥异,各家都有各家的玩法,民间更是个人玩个人的.目前我们国内比较出名的几个框架(Yii,Laravel) 都已经支持Composer并且加入了PHP-FIG(php框架程序组). 其中Composer的自动加载就支持PHP-FIG指定的PSR-0 和 PSR-4 规范来实现自动加载机制,并且Composer推荐使用PSR-4 PHP-FIG 这是一个自愿非正式的机构,但是就目前对我们的影响来看,可能都已经默认为一个公信组织了,的的确确制定了不少非常好

《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:

<从零开始学Swift>学习笔记(Day 57)--Swift编码规范之注释规范:文件注释.文档注释.代码注释.使用地标注释 原创文章,欢迎转载.转载请注明:关东升的博客 前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 文件注释 文件注释就在每一个文件开头添加注释,文件注释通常包括如下信息:版权信息.文件名.所在模块.作者信息.历史版本信息.文件内容和作用等. 下面看一个文件注释的示例: /* Copyright (C) 201

【分享】[iOS翻译]Cocoa编码规范

http://www.cnblogs.com/yangfaxian/p/4673894.html 简介: 本文整理自Apple文档<Coding Guidelines for Cocoa>.这份文档原意是给Cocoa框架.插件及公共API开发者提供一些编码指导,实质上相当于Apple内部的编码规范.在多人协作时,一份统一的代码规范大大减少开发者之间的沟通成本,极力推荐. 目录: 一.代码命名基础 二.方法 三.函数 四.Property及其他 五.缩写 一.代码命名基础 1.通用原则 1.1 

html编码规范

不久前接到老大下达的任务,要拟定一份公司前端编码规范的草稿,参考了各大公司的编码规范,结合现在公司的特点,整理出以下编码规范: html规范 1 文件相关 (1) 文件名以英文为主,可以使用下划线(如active.html),压缩包以项目名+日期的形式. (2) 统一使用utf-8编码. (3) css.js发布到线上都需要压缩. (4) 在追求高度优化的站点,需要对图片也进行无损压缩. 2 代码风格 2.1 命名 (1) 元素 id 必须保证页面唯一.(解释:同一个页面中,不同的元素包含相同的

【转】Airbnb React编码规范

Airbnb的编码规范是在业界非常流行的一套规范,而且它一直都在进化,推出最新技术的规范 原文:https://zhuanlan.zhihu.com/p/20616464 用更合理的方式书写React和JSX 基本规则 每个文件只包含一个React组件: 但是无状态, 或者 Pure 组件 允许一个文件包含多个组件.eslint: react/no-multi-comp. 始终使用 JSX 语法; 不要使用 React.createElement方法,除非初始化 app 的文件不是 JSX 格式

Bootstrap编码规范

黄金定律 永远遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的.如果你发现本规范中有任何错误,敬请指正.通过 open an issue on GitHub为本规范添加或贡献内容. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. HTML 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单引号. 不要在自闭合(self-clo

iOS:Cocoa编码规范 -[译]Coding Guidelines for Cocoa

--原文地址:https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/FrameworkImpl.html Cocoa编码规范 --前言 用公共API开发一个Cocoa框架,插件,或其他可执行目标,里面的命名编写和规范不同于一般应用程序的开发.因为你开发出来东西是给开发者用的看的,并且他们不熟悉你的编程接口.这个时候API的命名约定就派上用场了,因为它使你的写

[转载]Objective-C开发编码规范:4大方面解决开发中的规范性问题

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编

HTML/CSS/JS编码规范

最近整理了一份HTML/CSS/JS编码规范,供大家参考.目录:一.HTML编码规范二.CSS编码规范三.JS编码规范 一.HTML编码规范 1. img标签要写alt属性 根据W3C标准,img标签要写alt属性,如果没有就写一个空的.但是一般要写一个有内容的,根据图片想要表达的意思,因为alt是在图片无法加载时显示的文字.如下不太好的写法: <img src="company-logo.svg" alt="ABC Company Logo"> 更好的