[LNMP]php编程建议规范

人都有自由的天性,所以规范是不受欢迎的,但当你被旧代码或别人的代码绕的云里雾里的时候,就会想要是有规范多好。所以规范最重要的作用是统一写作风格,提高可读性,当然这些规范不是某个人的规范,而是一些优秀的、已经达成共识的规则组成,例如大名鼎鼎的 Google Code Style,是google建议的编码规范。PHP标准组也有一系列的风格建议,其中关于代码风格的,即 PSR-0, PSR-1, PSR-2PSR-4

说明


基于php 5.3 版本编写

文件规范


  1. 文件编码必须使用utf-8编码;
  2. 文件后缀只使用 .php,不允许使用其他后缀;
  3. 文件或目录的命名和引用必须是大小写敏感,Gather.php 和 gather.php 是两个不同的文件;
  4. 每个php文件只允许声明或定义一个类,在类文件里面写其它代码是允许的,但不鼓励;
  5. 接口类和抽象类必须独立一个文件,接口类的命名以xxxxInterface.php,抽象类的命名以 xxxxAbstract.php;

编码风格


  1. 强制缩进:代码结构的层次通过缩进表达,1个缩进使用4个空格,如果使用Tab键进行缩进,先检查IDE的Tab设置是否为4个空格;
  2. 显式声明变量权限:每个类属性和方法 必须显式声明访问的权限:public / protected / private;
  3. 变量不允许转换类型:每个变量在定义的时候必须显式声明变量的类型,例如:$articleList = array(); ,并且在运行过程中,不允许对已声明的变量变更类型。
    <pre>
    //局部变量初始化
    $articles = array();
    ...
    ...
    $articles = 'article';//虽然php允许,但不建议这样用,可能增加未知风险
    ...
    ...
    </pre>
  4. 大括号的使用,允许两种方式,但在一个系统里,保持使用其中一种方式:
    <pre>
    方式一:
    if(...){
    //code
    }else{
    //code
    }
    方式二:
    if(...)
    {
    //code
    }
    else
    {
    //code
    }
    </pre>

命名规范


以下命名规范包含文件名/类名/接口名/变量名/函数名
  1. 命名区分大小写;
  2. 命名使用对应的英文进行拼写,不使用拼音拼写;
  3. 命名书写采用驼峰式写法(除常量外);
文件名、类名规范
  1. 文件名首字母大写,并且只允许字母、数字组成;
  2. 类名与类文件名保持一致;
  3. 文件名和类名在程序中保持唯一;例如:GatherHandle.php 文件里面,定义了一个 GatherHandle 的类
变量名规范
  1. 除常量外,其他变量首字母小写,变量名由字母、数字、下划线组成;
  2. 全局变量,以小写g开头,例如:$gUserConfig;
  3. 静态变量,以小写s开头,例如:$sNumCount;
  4. private 的类属性,以下划线开头,例如:$_currentStringEncoding;
  5. protected、public 类属性/局部变量,以小写字母开头,例如:$currentStringEncoding;
  6. 类中的常量 constant 和全局范围内常量define,使用全大写拼写,由大写字母、数字、下划线组成,例如:UTF8_ENCODING;
函数名
  1. 函数名/方法名由字母、数字、下划线组成;
  2. private 的类方法,以下划线开头,例如:function _getStringEncoding($string){ ... }
  3. protected、public 类方法/函数,以小写字母开头,例如:function getStringEncoding($string){ ... }

防御式编程


必须检测数据是否符合预期类型

<pre>
$articleList = '';
...
...
foreach($articleList as $article){
...
}
//对变量进行随意更改类型(虽然php允许)可能增加bug风险,良好习惯的重要性
</pre>

对外部数据注重合法性判断

用户输入数据,例如:GET/POST 进来的数据,$_GET['pageId']
函数参数传进来的数据,例如:function getStringEncoding($string){ ... }

  1. 首先确保数据的安全性(防止注入攻击):
    a. 如果对于确定类型的(非文本),可以使用强制类型转换,例如:$pageId = (isset($_GET['pageId']))?(int)$_GET['pageId']:1;
    b. 如果对于字符文本数据,则需要做xss过滤,建议使用:HTMLPurifier
  2. 其次判断数据上下边界有效性,例如:pageId 有效范围是 1~5,那如果用户输入是 6,如果不处理,后面的代码又依赖于这个数,可能导致不可预期的异常;
  3. 对于上传的文件,需判断格式、文件大小是否符合预定约束。
对过程数据注重数据边界判断

在遵循 “编码风格:变量不允许转换类型”这个原则下,是不会出现变量数据合法性问题,在过程数据中,注重的是数据的边界:
<pre>
$articleList = array(1,2,3,4);
...
...

$articleIndex = $articleList[4]; //超过数组边界,将报错
</pre>

建议性规范


  1. 命名时候不建议使用过度缩写,因为每个人理解差异,过度缩写会导致难以阅读;
  2. 当一个字符串是纯文本组成的时候(即不含变量),以单引号 '...' 作为定界符。例如:$stringEncoding = 'UTF-8';
  3. 勿滥用 @ 做错误处理,出现异常时候会导致程序难以调试;

工具推荐


sublime的phpcs,提示语法和自动纠正语法错误,可以节省格式化的编码时间。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 1、引言 数据库设计过程中表、字段等的命名规范也算是设计规范的一部分,不过设计规范更多的是为了确保数据库设计的合理...
    SnowflakeCloud阅读 40,642评论 0 48
  • 一、php可以做什么 php是一种可以在服务器端运行的编程语言,可以运行在Web服务器端。 php是一门后台编程语...
    空谷悠阅读 3,016评论 4 97
  • 文章来自https://github.com/Blankj/AndroidStandardDevelop#安卓开发...
    小庄bb阅读 702评论 0 1
  • Do not wait for the perfect moment,take the moment and ma...
    紫木苏阅读 172评论 0 2