PHP代码规范



一 编辑器设置

1．    使用Tab缩进，不要使用空格

鉴于很多编辑器在保存文件时会自动清除用于缩进的空格，所以我们一律使用Tab键进行缩进。

2．    UNIX文件格式

请将编辑器设置对所有程序使用UNIX格式保存，不要使用Win32或者Mac的格式。例如，EditPlus里面Document->File Format(CR/LF)->Unix 。

对于windows格式文件，以Ctrl + M结束（vim下为^M）,需要过滤掉：

$text = strtr($text, "\x0D", "");

二 命名约定

1．    通用约定

使用英文单词命名，命名必须具有描述性，但务求简练，对于单词较长的可使用缩写。

2．    常量名

全局常量，全部大写，且用'_'分隔每个单词。如：   define("TPLIB_TEST_HELLO", "Hello world!");

 

类常量，用'_'分隔每个单词，如：

class Package

{

   const EXAMPLE_CONST;

}

尽量使用类常量代替全局常量。

3．    变量名

局部变量的字母都使用小写，使用“_”作为每个词的分界。如：$php_var；

全局变量，字母都使用大写，使用“_”作为每个词的分界，公共库中无特殊需求不使用全局变量。

4．    循环索引变量

在循环结构中，仅允许使用一个字母长度的循环索引变量。通常我们使用 $i，如果存在嵌套循环，那么子循环的索引变量应该使用 $j，其下级循环的索引变量就是 $k, 以此类推。如果循环被原已存在一些有具体含义名称的变量索引，则不受此规定约束。

例如：

for ($i = 0;$i < $outer_size;$i++)

{

    for ($j = 0;$j < $inner_size;$j++)

    {

        foo($i,$j);

    }

}

5．    函数命名

字母都使用小写，使用“_”作为每个词的分界，例如：get_client_ip（）

6．    类命名

使用驼峰法命名，并首字母大写，例如：NoezUser，如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。

7．    类里方法命名

使用骆驼命名法命名，首字母小写或者使用下划线"_"，例如getCache()、echoName()、_getResource(),通常下划线开头的方法属于私有方法；名字采用“动词+宾语”的形式。例如 write（动词）Cache（宾语）。

8．    类里属性命名

类里属性的命名使用驼峰法，首字母小写或者使用下划线"_"，如$username,$_instance,通常下划线开头的属性属于私有属性;

9．    文件命名

包含文件应该以.inc.php方式命名，例如config.inc.php。单独类的文件使用类名作为文件名的方式方式命名。

三 代码层

1．   使用大括号

在语言结构（if，else，while，switch，for，foreach）中请在陈述与执行的代码分行，执行的代码放到大括号中，大括号不可省略。

例如：

if (condition)  do_stuff();要改为

if (condition){

       do_stuff ();

}

2．   数组格式

对于数组的定义，可以使用分行表述每个"key => value,"，每行开头使用一个Tab进行缩进。右括号和该array(的起始行保持对齐。

例如：

$arr = array(

        'key1'   => 'value1',

        'index1' => 'value2',

);

 

3．   在运算符之间使用空格

在比较运算符（>、<、>=、<=、==、===、!=、<>、!==）、赋值运算符（=）、数学运算符（+、-、*、/、%）、位运算符（&、|、^、~、>>、<<）、逻辑运算符（!、&&、||）、冒号(:)、问号（?）、字符串连接运算符（.）、字符串连接赋值运算符(.=）前后，以及左括号（(）前（函数调用例外）、逗号（,）后请使用空格进行间隔。

例如:$i=0;要改为$i = 0;

$i = ($j < $size) ? 0 : 1;

4．   运算符优先级

对于容易引起迷惑的表达式中不同运算符的优先级，请使用括号来区分优先级。

例如：

$bool = ($i < 7 && $j > 8 || $k == 4);

 要改为

$bool = (($i < 7) && (($j < 8) || ($k == 4)))

5．   条件语句

请在条件陈述中使用&&和||，不要使用and和or。

例如：

if (($i < 7) and ($j > 8)) ...

要改为

if (($i < 7) && ($j > 8)) ...

多重if...elseif...else最好换用选择结构体(switch...case)。

6．   语法结构

在PHP中echo、exit(die)、return、continue、break、include、include_once、require、require_once等都属于语法结构，大部分语法结构都有两种形式：

echo 'This is a string';

echo('This is a string');

在PHP规定的允许使用的格式下，尽可能使用前一种语法结构的格式，而不要使用函数参数/表达式的形式，仅在参数包含表达式时才需要用括号将其括起来。当返回一个变量时通常不用括号，也建议不要用，这样既可以降低 PHP 的负担，又可以避免一些错误（见下）。

注意:  exit(die)只能使用括号结构

对于return(),当用引用返回值时永远不要使用括号，只能通过引用返回变量，而不是语句的结果。如果使用 return ($a); 时其实不是返回一个变量，而是表达式 ($a) 的值（当然，此时该值也正是 $a 的值）。

 

// won't work, evaluated as include(('vars.php') == 'OK'), i.e. include('')
if (include('vars.php') == 'OK')

{
    echo 'OK';
}

// works
if ((include 'vars.php') == 'OK')

{
    echo 'OK';
}

 

由于echo()是语法结构、没有返回值，所以速度比print()快。在输出多个字符串时，请使用echo的多参数方式（逗号,间隔），会比字符串连接方式 (点.间隔)有更好的性能。

7．   类

    必须使用PHP5的__construct()和__destruct()方式，禁止使用PHP4的用与类同名函数的方式构造。

    避免使用魔术方法__get, __set, __autoload 。

在类里面多加函数不会影响性能。

子类的方法比基类执行得更快。

执行一个拥有一个参数和空函数体的函数相当于7-8次局部变量自增操作$localvar++ ，一个相似的方法调用当然就相当于15次局部变量自增操作$localvar++。

    别在对象构造函数中做实际的工作，构造函数应该包含变量的初始化，但不会发生失败的操作。即构造不能返回错误。
    例如
    class Device
    {
       function __construct($param)

       {

           //这里的代码应该不发生失败

       }

       function open()

       {

           //这里的代码返回失败和成功

       }
    }

四 SQL 代码

1．SQL代码层

SQL关键词语大写（SELECT,INSERT,UPDATE,ALTER,DELETE,CREATE,TABLE,INDEX,COUNT,MAX,MIN，FROM,WHERE,AS,LEFT JOIN,RIGHT JOIN,ON,AND,ORDER BY,DESC,ASC,GROUP BY,LIMIT等等），按照逻辑分行，比如SELECT/INSERT/UPDATE/DELETE在一行，FROM在一行，LEFT JOIN …ON/RIGHT JOIN…ON在一行，WHERE在一行，ORDER BY在一行，GROUP BY在一行，LIMIT在一行。WHERE条件里面多个条件请使用括号来区分优先级。

数据表名称请使用名词单数形式，一律使用英文小写字母。如果需要对名称作描述/分类，请在名词前/后加描述/分类关键词语，使用下划线间隔。

例如:

SELECT field1 AS something, field2, field3

FROM table a, table b

WHERE (this=that) AND (this2=that2)

2．MySQL的查询性能优化原则

（1）请不要在SELECT中使用DISTINCT；

（2）尽可能不要SELECT *，而应该查询需要用到的指定几个字段；

（3）不要对两个大表进行联合，无论是内联或外联。对于需要对两个或多个表进行联合查询的情况，可以做两次或多次数据库查询；

（4）在WHERE条件中，尽可能对同类型的数据列进行比较；

（5）在WHERE条件中，尽量让有索引的数据列在比较表达始中单独出现；

（6）在WHERE条件中，根据数据列排除不合条件数据量由多到少的次序排列条件，在不能确定排除数据多少的前提下，一般来说表达式中使用=、!=、<>要优先于>、<、>=、<=，更优先于LIKE

（7）如果WHERE条件中的值是数字，那么不要使用单引号进行类型转换

（8）如果WHERE条件中使用LIKE模式匹配，不要在模式开头使用通配符%

（9）不要对WHERE条件中的非BINARY属性的CHAR/VARCHAR字段，进行大小写转换

（10）尽可能不要在SELECT中使用GROUP BY

（11）SQL中尽量使用短语法：INSERT INTO MYTABLE (FIELD1,FIELD2) VALUES (('x','y'),('p','q'));

3．SQL语句汇总

在编程中请将所有使用到的SQL语句列表归总，每个模块一个SQL记录表。每条语句进行EXPLAIN测试，并把10000次平均结果记录到SQL记录表中。

五 HTML代码

1．XHTML标准

（1）所有标签必须成对使用，input、img、br、hr等标签，可以使用 /> 的方式，例如：<br />，<input type="text" name="name" value="" />

（2）所有XHTML的标签、元素，必须使用英文小写字母（JavaScript和CSS例外）

（3）所有XHTML标签的所有元素的属性，都需要使用英文双引号（"），不允许使用单引号，更不允许不使用引号

（4）对于selected,checked，请使用selected="selected"，checked="checked"

（5）使用<strong>、<em>来代替<b>、<i>

（6）不允许XHTML标签的混合嵌套，例如：<b><i>abc</b></i>

（7）img标签必须指定alt元素的属性，即使是空值；a标签必须指定title元素的属性，即使是空值；

2．可视化元素分离

不允许在table、tr、td、th、div、span等标签中直接定义宽度、高度、边框、字体、字体大小、字体颜色、背景色、背景图等等可视化内容，一律使用CSS来定义

六 通用规

1．引号

所有字符串都使用单引号（'），除非包含需要转义的字符（比如\n之类）才允许使用双引号"。字符串中如果需要包含变量/数组/对象，请将字符串拆分，用点（.）连接变量/数组/对象。向函数传递字符串变量，不要加引号。对于在Here Doc里面使用的变量/数组/对象，请用大括号嵌套。

例如：

$str = "This is a $var string";要改为

$str = 'This is a ' . $var . 'string';

2．关联数组

    关联数组当中，请用单引号将key的字符串嵌套（例如：$row['id']比$row[id]快7倍），如果key是变量则不要使用引号嵌套：

/* wrong */

$foo = $assoc_array[blah];

$foo = $assoc_array["$var"];

/* right */

$foo = $assoc_array['blah'];

$foo = $assoc_array[$var];

3．注释

    以明确简洁的语句书写注释，注释格式使用PHPDocument格式(参见 http://www.phpdoc.org/)，即Zend Studio中自动提示的格式。

4．类型比较

对于提交/返回值，尽可能的使用===来检查类型是否匹配，这一点对于区分FALSE,NULL, '',0四种空值尤其有用（定义了的变量但未定义值，其值为NULL）。函数返回值请用TRUE和FALSE来代替1和0 。

对于比较字符串，必须使用strcmp()或者===，这样才进行类型检查。例如：var_dump('01' == 1)，返回结果为true，但是var_dump('01' === 1)的结果就是false了

对于in_array()函数，请加入第三个参数，设置为true，例如： in_array('01', array('1'))，将不判断类型，返回结果为true。但是如果使用in_array('01', array('1'), true)，将判断类型，返回结果为false。

我们有可能会把"==="写成"=",这样的bug我们很难调试图来。所以,把常量放在前面，编译器就能判断出来。

5．递增/递减运算符

不允许在表达式中使用递增运算符 (前加++$i，后加$i++)和递减运算符 (前减--$i，后减$i--)，这些运算符只能独自一行使用。

递增／递减运算符不影响布尔值。递减 NULL 值也没有效果，但是递增 NULL 的结果是 1 。字符串变量只能递增（使用PERL的方式而非C的方式），不能递减。

例如：

/* wrong */

$array[++$i] = $j;

$array[$i++] = $k;

 

/* right */

$i++;

$array[$i] = $j;

$array[$i] = $k;

$i++;

递增使用前加++$i比后加$i++快，递减使用前减--$i比后减$i--快，；

在方法里递增、递减局部变量是最快的，在函数里调用局部变量也是；

递增、递减一个全局变量比局部变量要慢两倍；

递增、递减一个对象的属性 (例如 $this->prop++) 比局部变量慢3倍；

递增、递减一个未定义的局部变量比一个预定义过的慢9-10倍；

6．三元条件运算符

三元条件运算符更适用于赋值，使得程序更为简洁。三元条件运算符不适合用作函数调用或者其它任何复杂的代码，这将会让代码变得晦涩难懂。

例如：

/* Bad place to use them */

(($i < $size) && ($j > $size)) ? do_stuff($foo) : do_stuff($bar);

/* OK place to use them */

$min = ($i < $j) ? $i : $j;

7．未初始化的变量

请不要使用未初始化的变量！对于用户在HTML中提交的输入值，需要使用isset()来检测是否已被初始化。

例如：

/* Error way */

if ($_POST['forum'])

{

    ...

}

/* Right way */

if (isset($_POST['forum']))

{

    ...

}

8．变量/数组是否为空的检测

判断变量和数组是否为空使用empty()，empty()会先检查是否已经初始化，因而无须同时使用isset()和empty()。不要使用count()来判断数组是否为空。

例如：

/* Error way */

if (isset($_POST['forum']) && !empty($_POST['forum']))

{

    ...

}

/* Right way */

if (!empty($_POST['forum']))

{

    ...

}

9．正则表达式

PHP支持两种风格的正则表达式：Perl-Compatible (preg) (http://www.php.net/manual/en/ref.pcre.php) 和 POSIX Extended (ereg) (http://www.php.net/manual/en/ref.regex.php)。preg风格相对于ereg风格来说更为安全，速度更快。因此，请不要使用ereg风格的正则表达式。

    在使用正则表达式的时候，首选的匹配词语定界符是斜线/，如果您的匹配词语中含有斜线，那么您可以使用#作为匹配词语定界符。

例如：

/* Error way */

if (ereg('something',$myvar))

{

    ...

}

/* Right way */

if (preg_match('/something/',$myvar))

{

    ...

}

/* Alternative */

if (preg_match('#/etc/php.ini#',$myvar))

{

    ...

}

正则表达式最好使用单引号, "\w"是无效转义，应该写成'\w'或 "\\w"。

尽可能使用strncasecmp()、strpbrk()、stripos() 等str系列字符串函数而不是正则表达式。另外同样是str系列函数，性能也有差异：str_replace()比preg_replace()快，但strtr()比str_replace()还要快4倍 。

如果只是需要做字符串的格式类型检查，可以直接使用ctype函数库，无需使用正则或者字符串匹配。

10．使用file_get_contents/file_put_contents

PHP4.3.0以上版本提供了file_get_contents()函数，用这个函数读取文件内容为一个字符串，其速度是使用fopen()/file()的三十倍。我们要求所有读取文件内容的程序，除非必须确保不允许被服务器cache，否则一律使用file_get_contents()函数。

通过fopen()打开、flock()锁定、fwrite()写入、fclose()关闭，这四个函数组合实现对文件的写操作，如果在Daemon/Server中的请不要使用这种方式，一旦文件被其它进程删除，则数据永远无法写入（因为每次写入前不检查文件是否存在）。PHP5.0以上版本提供了file_put_contents()函数，该函数支持FILE_APPEND和LOCK_EX等Flag，可以安全的写入文件。

11．Global/Request/Session/Server 变量

不要在函数内部中直接使用全局变量$GLOBALS['variable']，而应该先在函数开头先声明global $VAR，然后直接使用$VAR即可。只是定义一个全局变量但不使用它也会导致执行变慢，大概相当于自增一次局部变量，PHP可能做了一次全局变量是否存在的检查。

尽可能直接使用$_POST、$_GET、$_COOKIE，不要直接使用$_REQUEST，除非同时允许用户使用POST方式和GET方式提交数据。我们禁止了register_globals，所以请不要试图使用$variable_name方式获得用户提交的数据。

不要使用PHP的session功能，也不允许使用$_SESSION数组。

 

禁用$_SERVER['PHP_SELF']，这个值和用户输入URL相关，当请求路径为: /index.php/asdf/， $_SERVER['PHP_SELF']就变成/index.php/asdf/

12．输出header()

对于需要输出的header()，必须将每条header写一行，不要将多个header放在同一行内，出于安全因素考虑PHP早已不再支持这种组合header输出。

例如：

header('Cache-Control: no-cache, must-revalidate, max-age=0');

header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');

header('Pragma: no-cache');

 

注意：如果print/echo输出HTML会被Apache加上缓存头，如果不希望被缓存，则需要加上上面的输出无缓存头代码来避免。

13．上传文件类型

请不要使用PHP的$_FILES中的type来判定文件的类型，此类型由浏览器提供，容易被黑客伪造。请使用getimagesize()函数来进行判定：

$info = getimagesize($file);

$width = $info[0];

$height = $info[1];

$type = $info[2];

$imgstr = $info[3];

$mime = $info['mime'];

其中$type，1 = GIF，2 = JPG，3 = PNG，4 = SWF，5 = PSD，6 = BMP，7 = TIFF(intel byte order)，8 = TIFF(motorola byte order)，9 = JPC，10 = JP2，11 = JPX，12 = JB2，13 = SWC，14 = IFF，15 = WBMP，16 = XBM

14．字符串的大小写转换

请不要使用PHP的strtolower()函数来进行字符串的大小写转换，这在安装非中文系统的服务器下会导致将汉字转换为乱码。请使用strtr($string, 'ABCDEFGHIJKLMNOPQRSTUVWXYZ', 'abcdefghijklmnopqrstuvwxyz') 来进行大小写转换。

15．检查字符串长度

    在PHP底层zval结构体里保存了字符串长度，strlen()可以直接获取而无需计算，但仍旧有一次函数调用，速度上使用 isset() 语法结构会更快。

例如：

 if (strlen($foo) < 5) { echo 'Foo is too short'; }

vs.

if (!isset($foo{5})) { echo 'Foo is too short'; }

 

使用isset($foo{5})比strlen($foo)<5更快

16．PHP标签

请不要在程序里面嵌套任何PHP标签（以免多次调用PHP解析器），不允许使用<? echo($variable);?>这种形式进行内容输出。

17．程序文件末尾

如果PHP文件在文件末尾没有使用 ?> 将导致向浏览器发送空白，进而黑客可以使用脚本来试图设置cookie或者发送http头。为防止这种情况，我们要求在每个PHP文件的末尾，使用一行注释，然后接一个新行：

// end of script

18．magic_quotes_gpc

服务器php.ini必须关闭此项设置，同时需要在代码中加入：

set_magic_quotes_runtime(0);

if (get_magic_quotes_gpc())

{

   exit('Please set magic_quotes_gpc off');

}

19．包含文件

对于include()/requrie()所包含的文件请尽量使用绝对路径或者./开头的相对路径。

对于include_once()/require_once()所包含的文件必须使用绝对路径（每次调用都会打开目标文件，如果用绝对路径在PHP 5.2以上不存在这个问题）。

20．遍历数组

如果需要遍历数组，请使用foreach()循环，禁止使用for()或者while()。

尽量避免在循环内部修改数组key的值（会导致写时复制）

21．避免修改for循环内的条件值

避免重新计算for循环内的条件值（比如count()/strlen()/sizeof()等），因为PHP的解析器不能够删除循环不变量。请在循环前就设定循环的条件值，而不是在循环内。

/* Error way */

for ($i=0; $i < count($array); $i++)

{

    ...

}

/* Right way */

$total = count($array);

for ($i=0; $i < $total; $i++)

{

    ...

}

22．用常量代替函数

如果存在和函数等价的常量，则不要使用函数。

php_uname('s') == PHP_OS;

php_version() == PHP_VERSION;

php_sapi_name() == PHP_SAPI;

23．不信任intval()

所有通过表单提交的值，包括$_GET、$_POST、$_REQUEST，其中的数字都是字符串类型，需要使用函数来判断提交值是否合法并进行过滤，通常使用的是intval()函数。

函数intval()会对数字开头的字符串截取开头的数字，并且不区分16进制数字，因此无法通过intval($a)来判断$a一定是整数。

正确的判断方法：

if (isset($a) && $a == intval($a))

    {

       $a == intval($a);

    }

24．目录权限

创建、修改目录，需要设置正确的权限，必须先使用umask(0000)，然后再mkdir()或chmod()，例如：

if (!is_dir($dir))

{

   umask(0000);

   mkdir($dir, 0777);

}

if (!is_writeable($dir))

{

   umask(0000);

   chmod($dir, 0777);

}

25．临时文件

请使用tmpfile()、tempnam()来创建临时文件。

26. 静态方法和静态调用

    如果类的某个方法是静态的，那就用static显式定义成静态方法，这样可以快4倍。

如果类的成员并非静态static，则在类的外部静态调用类的成员不要使用静态方法，静态方法只能调用类的静态成员。

27．时间问题

    WEB服务器下运行的业务代码如果只是取当前时间，请不要使用time()，使用$_SERVER['REQUEST_TIME'] （PHP 5.1以上版本下），这里要注意非WEB服务器中是没有$_SERVER['REQUEST_TIME']变量的。

请在程序中指定时区 date_default_timezone_set('Asia/Shanghai')。

如果需要取微秒，请使用microtime(TRUE)，返回浮点数。

28、注释

单行注释用//

多行注释用，类说明、类方法说明使用多行

/**

*

*/