[LNMP]php编程建议规范

栏目: PHP · 发布时间: 6年前

内容简介:[LNMP]php编程建议规范

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

  • 常用函数包括:isset、empty、is_array、is_int、is_string…更多参考Variable handling

  • 或使用filter_input、filter_var系列函数进行处理

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

用户输入数据,例如: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,提示语法和自动纠正语法错误,可以节省格式化的编码时间。


以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

用户故事与敏捷方法

用户故事与敏捷方法

Mike Cohn / 石永超、张博超 / 清华大学出版社 / 2010-4 / 39.00元

《用户故事与敏捷方法》详细介绍了用户故事与敏捷开发方法的结合,诠释了用户故事的重要价值,用户故事的实践过程,良好用户故事编写准则,如何搜集和整理用户故事,如何排列用户故事的优先级,进而澄清真正适合用户需求的、有价值的功能需求。 《用户故事与敏捷方法》对于软件开发人员、测试人员、需求分析师和管理者,具有实际的指导意义和重要的参考价值。一起来看看 《用户故事与敏捷方法》 这本书的介绍吧!

RGB转16进制工具
RGB转16进制工具

RGB HEX 互转工具

XML 在线格式化
XML 在线格式化

在线 XML 格式化压缩工具

Markdown 在线编辑器
Markdown 在线编辑器

Markdown 在线编辑器